blob: 568dab6839311b351451b58a15f0c5924172fa00 [file] [log] [blame]
Bram Moolenaar446cb832008-06-24 21:56:24 +00001*options.txt* For Vim version 7.2a. Last change: 2008 Jun 24
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
1283 for has a relative path (not starting with "/", "./" or "../").
1284 The 'cdpath' option's value has the same form and semantics as
1285 |'path'|. Also see |file-searching|.
1286 The default value is taken from $CDPATH, with a "," prepended to look
1287 in the current directory first.
1288 If the default value taken from $CDPATH is not what you want, include
1289 a modified version of the following command in your vimrc file to
1290 override it: >
1291 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1292< This option cannot be set from a |modeline| or in the |sandbox|, for
1293 security reasons.
1294 (parts of 'cdpath' can be passed to the shell to expand file names).
1295
1296 *'cedit'*
1297'cedit' string (Vi default: "", Vim default: CTRL-F)
1298 global
1299 {not in Vi}
1300 {not available when compiled without the |+vertsplit|
1301 feature}
1302 The key used in Command-line Mode to open the command-line window.
1303 The default is CTRL-F when 'compatible' is off.
1304 Only non-printable keys are allowed.
1305 The key can be specified as a single character, but it is difficult to
1306 type. The preferred way is to use the <> notation. Examples: >
1307 :set cedit=<C-Y>
1308 :set cedit=<Esc>
1309< |Nvi| also has this option, but it only uses the first character.
1310 See |cmdwin|.
1311
1312 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1313'charconvert' 'ccv' string (default "")
1314 global
1315 {only available when compiled with the |+multi_byte|
1316 feature and the |+eval| feature}
1317 {not in Vi}
1318 An expression that is used for character encoding conversion. It is
1319 evaluated when a file that is to be read or has been written has a
1320 different encoding from what is desired.
1321 'charconvert' is not used when the internal iconv() function is
1322 supported and is able to do the conversion. Using iconv() is
1323 preferred, because it is much faster.
1324 'charconvert' is not used when reading stdin |--|, because there is no
1325 file to convert from. You will have to save the text in a file first.
1326 The expression must return zero or an empty string for success,
1327 non-zero for failure.
1328 The possible encoding names encountered are in 'encoding'.
1329 Additionally, names given in 'fileencodings' and 'fileencoding' are
1330 used.
1331 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1332 is done internally by Vim, 'charconvert' is not used for this.
1333 'charconvert' is also used to convert the viminfo file, if the 'c'
1334 flag is present in 'viminfo'. Also used for Unicode conversion.
1335 Example: >
1336 set charconvert=CharConvert()
1337 fun CharConvert()
1338 system("recode "
1339 \ . v:charconvert_from . ".." . v:charconvert_to
1340 \ . " <" . v:fname_in . " >" v:fname_out)
1341 return v:shell_error
1342 endfun
1343< The related Vim variables are:
1344 v:charconvert_from name of the current encoding
1345 v:charconvert_to name of the desired encoding
1346 v:fname_in name of the input file
1347 v:fname_out name of the output file
1348 Note that v:fname_in and v:fname_out will never be the same.
1349 Note that v:charconvert_from and v:charconvert_to may be different
1350 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1351 Encryption is not done by Vim when using 'charconvert'. If you want
1352 to encrypt the file after conversion, 'charconvert' should take care
1353 of this.
1354 This option cannot be set from a |modeline| or in the |sandbox|, for
1355 security reasons.
1356
1357 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1358'cindent' 'cin' boolean (default off)
1359 local to buffer
1360 {not in Vi}
1361 {not available when compiled without the |+cindent|
1362 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001363 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 that trigger reindenting in insert mode and 'cinoptions' to set your
1365 preferred indent style.
1366 If 'indentexpr' is not empty, it overrules 'cindent'.
1367 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1368 the "=" operator indents using this algorithm rather than calling an
1369 external program.
1370 See |C-indenting|.
1371 When you don't like the way 'cindent' works, try the 'smartindent'
1372 option or 'indentexpr'.
1373 This option is not used when 'paste' is set.
1374 NOTE: This option is reset when 'compatible' is set.
1375
1376 *'cinkeys'* *'cink'*
1377'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1378 local to buffer
1379 {not in Vi}
1380 {not available when compiled without the |+cindent|
1381 feature}
1382 A list of keys that, when typed in Insert mode, cause reindenting of
1383 the current line. Only used if 'cindent' is on and 'indentexpr' is
1384 empty.
1385 For the format of this option see |cinkeys-format|.
1386 See |C-indenting|.
1387
1388 *'cinoptions'* *'cino'*
1389'cinoptions' 'cino' string (default "")
1390 local to buffer
1391 {not in Vi}
1392 {not available when compiled without the |+cindent|
1393 feature}
1394 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1395 program. See |cinoptions-values| for the values of this option, and
1396 |C-indenting| for info on C indenting in general.
1397
1398
1399 *'cinwords'* *'cinw'*
1400'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1401 local to buffer
1402 {not in Vi}
1403 {not available when compiled without both the
1404 |+cindent| and the |+smartindent| features}
1405 These keywords start an extra indent in the next line when
1406 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1407 an appropriate place (inside {}).
1408 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1409 matter, include the keyword both the uppercase and lowercase:
1410 "if,If,IF".
1411
1412 *'clipboard'* *'cb'*
1413'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1414 for X-windows, "" otherwise)
1415 global
1416 {not in Vi}
1417 {only in GUI versions or when the |+xterm_clipboard|
1418 feature is included}
1419 This option is a list of comma separated names.
1420 These names are recognized:
1421
1422 unnamed When included, Vim will use the clipboard register '*'
1423 for all yank, delete, change and put operations which
1424 would normally go to the unnamed register. When a
1425 register is explicitly specified, it will always be
1426 used regardless of whether "unnamed" is in 'clipboard'
1427 or not. The clipboard register can always be
1428 explicitly accessed using the "* notation. Also see
1429 |gui-clipboard|.
1430
1431 autoselect Works like the 'a' flag in 'guioptions': If present,
1432 then whenever Visual mode is started, or the Visual
1433 area extended, Vim tries to become the owner of the
1434 windowing system's global selection or put the
1435 selected text on the clipboard used by the selection
1436 register "*. See |guioptions_a| and |quotestar| for
1437 details. When the GUI is active, the 'a' flag in
1438 'guioptions' is used, when the GUI is not active, this
1439 "autoselect" flag is used.
1440 Also applies to the modeless selection.
1441
1442 autoselectml Like "autoselect", but for the modeless selection
1443 only. Compare to the 'A' flag in 'guioptions'.
1444
1445 exclude:{pattern}
1446 Defines a pattern that is matched against the name of
1447 the terminal 'term'. If there is a match, no
1448 connection will be made to the X server. This is
1449 useful in this situation:
1450 - Running Vim in a console.
1451 - $DISPLAY is set to start applications on another
1452 display.
1453 - You do not want to connect to the X server in the
1454 console, but do want this in a terminal emulator.
1455 To never connect to the X server use: >
1456 exclude:.*
1457< This has the same effect as using the |-X| argument.
1458 Note that when there is no connection to the X server
1459 the window title won't be restored and the clipboard
1460 cannot be accessed.
1461 The value of 'magic' is ignored, {pattern} is
1462 interpreted as if 'magic' was on.
1463 The rest of the option value will be used for
1464 {pattern}, this must be the last entry.
1465
1466 *'cmdheight'* *'ch'*
1467'cmdheight' 'ch' number (default 1)
1468 global
1469 {not in Vi}
1470 Number of screen lines to use for the command-line. Helps avoiding
1471 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001472 The value of this option is stored with the tab page, so that each tab
1473 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 *'cmdwinheight'* *'cwh'*
1476'cmdwinheight' 'cwh' number (default 7)
1477 global
1478 {not in Vi}
1479 {not available when compiled without the |+vertsplit|
1480 feature}
1481 Number of screen lines to use for the command-line window. |cmdwin|
1482
1483 *'columns'* *'co'* *E594*
1484'columns' 'co' number (default 80 or terminal width)
1485 global
1486 {not in Vi}
1487 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001488 initialization and does not have to be set by hand. Also see
1489 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490 When Vim is running in the GUI or in a resizable window, setting this
1491 option will cause the window size to be changed. When you only want
1492 to use the size for the GUI, put the command in your |gvimrc| file.
1493 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001494 number of columns of the display, the display may be messed up. For
1495 the GUI it is always possible and Vim limits the number of columns to
1496 what fits on the screen. You can use this command to get the widest
1497 window possible: >
1498 :set columns=9999
1499< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001500
1501 *'comments'* *'com'* *E524* *E525*
1502'comments' 'com' string (default
1503 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1504 local to buffer
1505 {not in Vi}
1506 {not available when compiled without the |+comments|
1507 feature}
1508 A comma separated list of strings that can start a comment line. See
1509 |format-comments|. See |option-backslash| about using backslashes to
1510 insert a space.
1511
1512 *'commentstring'* *'cms'* *E537*
1513'commentstring' 'cms' string (default "/*%s*/")
1514 local to buffer
1515 {not in Vi}
1516 {not available when compiled without the |+folding|
1517 feature}
1518 A template for a comment. The "%s" in the value is replaced with the
1519 comment text. Currently only used to add markers for folding, see
1520 |fold-marker|.
1521
1522 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001523'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1524 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 global
1526 {not in Vi}
1527 This option has the effect of making Vim either more Vi-compatible, or
1528 make Vim behave in a more useful way.
1529 This is a special kind of option, because when it's set or reset,
1530 other options are also changed as a side effect. CAREFUL: Setting or
1531 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001532 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 set this option in your vimrc file, you should probably put it at the
1534 very start.
1535 By default this option is on and the Vi defaults are used for the
1536 options. This default was chosen for those people who want to use Vim
1537 just like Vi, and don't even (want to) know about the 'compatible'
1538 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001539 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001540 this option is switched off, and all options that have not been
1541 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001542 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001543 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001544 happen for the system-wide vimrc or gvimrc file, nor for a file given
1545 with the |-u| argument). Also see |compatible-default| and
1546 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001547 You can also set this option with the "-C" argument, and reset it with
1548 "-N". See |-C| and |-N|.
1549 Switching this option off makes the Vim defaults be used for options
1550 that have a different Vi and Vim default value. See the options
1551 marked with a '+' below. Other options are not modified.
1552 At the moment this option is set, several other options will be set
1553 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001554 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 editing.
1556 See also 'cpoptions'.
1557
1558 option + set value effect ~
1559
1560 'allowrevins' off no CTRL-_ command
1561 'backupcopy' Unix: "yes" backup file is a copy
1562 others: "auto" copy or rename backup file
1563 'backspace' "" normal backspace
1564 'backup' off no backup file
1565 'cindent' off no C code indentation
1566 'cedit' + "" no key to open the |cmdwin|
1567 'cpoptions' + (all flags) Vi-compatible flags
1568 'cscopetag' off don't use cscope for ":tag"
1569 'cscopetagorder' 0 see |cscopetagorder|
1570 'cscopeverbose' off see |cscopeverbose|
1571 'digraph' off no digraphs
1572 'esckeys' + off no <Esc>-keys in Insert mode
1573 'expandtab' off tabs not expanded to spaces
1574 'fileformats' + "" no automatic file format detection,
1575 "dos,unix" except for DOS, Windows and OS/2
1576 'formatoptions' + "vt" Vi compatible formatting
1577 'gdefault' off no default 'g' flag for ":s"
1578 'history' + 0 no commandline history
1579 'hkmap' off no Hebrew keyboard mapping
1580 'hkmapp' off no phonetic Hebrew keyboard mapping
1581 'hlsearch' off no highlighting of search matches
1582 'incsearch' off no incremental searching
1583 'indentexpr' "" no indenting by expression
1584 'insertmode' off do not start in Insert mode
1585 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1586 characters and '_'
1587 'joinspaces' on insert 2 spaces after period
1588 'modeline' + off no modelines
1589 'more' + off no pauses in listings
1590 'revins' off no reverse insert
1591 'ruler' off no ruler
1592 'scrolljump' 1 no jump scroll
1593 'scrolloff' 0 no scroll offset
1594 'shiftround' off indent not rounded to shiftwidth
1595 'shortmess' + "" no shortening of messages
1596 'showcmd' + off command characters not shown
1597 'showmode' + off current mode not shown
1598 'smartcase' off no automatic ignore case switch
1599 'smartindent' off no smart indentation
1600 'smarttab' off no smart tab size
1601 'softtabstop' 0 tabs are always 'tabstop' positions
1602 'startofline' on goto startofline with some commands
1603 'tagrelative' + off tag file names are not relative
1604 'textauto' + off no automatic textmode detection
1605 'textwidth' 0 no automatic line wrap
1606 'tildeop' off tilde is not an operator
1607 'ttimeout' off no terminal timeout
1608 'whichwrap' + "" left-right movements don't wrap
1609 'wildchar' + CTRL-E only when the current value is <Tab>
1610 use CTRL-E for cmdline completion
1611 'writebackup' on or off depends on +writebackup feature
1612
1613 *'complete'* *'cpt'* *E535*
1614'complete' 'cpt' string (default: ".,w,b,u,t,i")
1615 local to buffer
1616 {not in Vi}
1617 This option specifies how keyword completion |ins-completion| works
1618 when CTRL-P or CTRL-N are used. It is also used for whole-line
1619 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1620 and the places to scan. It is a comma separated list of flags:
1621 . scan the current buffer ('wrapscan' is ignored)
1622 w scan buffers from other windows
1623 b scan other loaded buffers that are in the buffer list
1624 u scan the unloaded buffers that are in the buffer list
1625 U scan the buffers that are not in the buffer list
1626 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001627 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001628 k{dict} scan the file {dict}. Several "k" flags can be given,
1629 patterns are valid too. For example: >
1630 :set cpt=k/usr/dict/*,k~/spanish
1631< s scan the files given with the 'thesaurus' option
1632 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1633 are valid too.
1634 i scan current and included files
1635 d scan current and included files for defined name or macro
1636 |i_CTRL-X_CTRL-D|
1637 ] tag completion
1638 t same as "]"
1639
1640 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1641 not executed, this may lead to unexpected completions from some files
1642 (gzipped files for example). Unloaded buffers are not scanned for
1643 whole-line completion.
1644
1645 The default is ".,w,b,u,t,i", which means to scan:
1646 1. the current buffer
1647 2. buffers in other windows
1648 3. other loaded buffers
1649 4. unloaded buffers
1650 5. tags
1651 6. included files
1652
1653 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001654 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1655 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001657 *'completefunc'* *'cfu'*
1658'completefunc' 'cfu' string (default: empty)
1659 local to buffer
1660 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001661 {not available when compiled without the +eval
1662 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001663 This option specifies a function to be used for Insert mode completion
1664 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001665 See |complete-functions| for an explanation of how the function is
1666 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001667
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001668
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001669 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001670'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001671 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001672 {not available when compiled without the
1673 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001674 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001675 A comma separated list of options for Insert mode completion
1676 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001677
1678 menu Use a popup menu to show the possible completions. The
1679 menu is only shown when there is more than one match and
1680 sufficient colors are available. |ins-completion-menu|
1681
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001682 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001683 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001684 match, e.g., what file it comes from.
1685
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001686 longest Only insert the longest common text of the matches. If
1687 the menu is displayed you can use CTRL-L to add more
1688 characters. Whether case is ignored depends on the kind
1689 of completion. For buffer text the 'ignorecase' option is
1690 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001691
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001692 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001693 completion in the preview window. Only works in
1694 combination with "menu" or "menuone".
1695
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001696
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1698'confirm' 'cf' boolean (default off)
1699 global
1700 {not in Vi}
1701 When 'confirm' is on, certain operations that would normally
1702 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1703 instead raise a |dialog| asking if you wish to save the current
1704 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1705 If 'confirm' is off you can still activate confirmation for one
1706 command only (this is most useful in mappings) with the |:confirm|
1707 command.
1708 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1709
1710 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1711'conskey' 'consk' boolean (default off)
1712 global
1713 {not in Vi} {only for MS-DOS}
1714 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001715 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 three methods of console input are available:
1717 'conskey' 'bioskey' action ~
1718 on on or off direct console input
1719 off on BIOS
1720 off off STDIN
1721
1722 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1723'copyindent' 'ci' boolean (default off)
1724 local to buffer
1725 {not in Vi}
1726 Copy the structure of the existing lines indent when autoindenting a
1727 new line. Normally the new indent is reconstructed by a series of
1728 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1729 in which case only spaces are used). Enabling this option makes the
1730 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001731 existing line. 'expandtab' has no effect on these characters, a Tab
1732 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001733 line, the remaining space is filled in the normal manner.
1734 NOTE: 'copyindent' is reset when 'compatible' is set.
1735 Also see 'preserveindent'.
1736
1737 *'cpoptions'* *'cpo'*
1738'cpoptions' 'cpo' string (Vim default: "aABceFs",
1739 Vi default: all flags)
1740 global
1741 {not in Vi}
1742 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001743 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 not being vi-compatible is mostly or sometimes preferred.
1745 'cpoptions' stands for "compatible-options".
1746 Commas can be added for readability.
1747 To avoid problems with flags that are added in the future, use the
1748 "+=" and "-=" feature of ":set" |add-option-flags|.
1749 NOTE: This option is set to the Vi default value when 'compatible' is
1750 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001751 NOTE: This option is set to the POSIX default value at startup when
1752 the Vi default value would be used and the $VIM_POSIX environment
1753 variable exists |posix|. This means tries to behave like the POSIX
1754 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755
1756 contains behavior ~
1757 *cpo-a*
1758 a When included, a ":read" command with a file name
1759 argument will set the alternate file name for the
1760 current window.
1761 *cpo-A*
1762 A When included, a ":write" command with a file name
1763 argument will set the alternate file name for the
1764 current window.
1765 *cpo-b*
1766 b "\|" in a ":map" command is recognized as the end of
1767 the map command. The '\' is included in the mapping,
1768 the text after the '|' is interpreted as the next
1769 command. Use a CTRL-V instead of a backslash to
1770 include the '|' in the mapping. Applies to all
1771 mapping, abbreviation, menu and autocmd commands.
1772 See also |map_bar|.
1773 *cpo-B*
1774 B A backslash has no special meaning in mappings,
1775 abbreviations and the "to" part of the menu commands.
1776 Remove this flag to be able to use a backslash like a
1777 CTRL-V. For example, the command ":map X \<Esc>"
1778 results in X being mapped to:
1779 'B' included: "\^[" (^[ is a real <Esc>)
1780 'B' excluded: "<Esc>" (5 characters)
1781 ('<' excluded in both cases)
1782 *cpo-c*
1783 c Searching continues at the end of any match at the
1784 cursor position, but not further than the start of the
1785 next line. When not present searching continues
1786 one character from the cursor position. With 'c'
1787 "abababababab" only gets three matches when repeating
1788 "/abab", without 'c' there are five matches.
1789 *cpo-C*
1790 C Do not concatenate sourced lines that start with a
1791 backslash. See |line-continuation|.
1792 *cpo-d*
1793 d Using "./" in the 'tags' option doesn't mean to use
1794 the tags file relative to the current file, but the
1795 tags file in the current directory.
1796 *cpo-D*
1797 D Can't use CTRL-K to enter a digraph after Normal mode
1798 commands with a character argument, like |r|, |f| and
1799 |t|.
1800 *cpo-e*
1801 e When executing a register with ":@r", always add a
1802 <CR> to the last line, also when the register is not
1803 linewise. If this flag is not present, the register
1804 is not linewise and the last line does not end in a
1805 <CR>, then the last line is put on the command-line
1806 and can be edited before hitting <CR>.
1807 *cpo-E*
1808 E It is an error when using "y", "d", "c", "g~", "gu" or
1809 "gU" on an Empty region. The operators only work when
1810 at least one character is to be operate on. Example:
1811 This makes "y0" fail in the first column.
1812 *cpo-f*
1813 f When included, a ":read" command with a file name
1814 argument will set the file name for the current buffer,
1815 if the current buffer doesn't have a file name yet.
1816 *cpo-F*
1817 F When included, a ":write" command with a file name
1818 argument will set the file name for the current
1819 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001820 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 *cpo-g*
1822 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001823 *cpo-H*
1824 H When using "I" on a line with only blanks, insert
1825 before the last blank. Without this flag insert after
1826 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 *cpo-i*
1828 i When included, interrupting the reading of a file will
1829 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001830 *cpo-I*
1831 I When moving the cursor up or down just after inserting
1832 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001833 *cpo-j*
1834 j When joining lines, only add two spaces after a '.',
1835 not after '!' or '?'. Also see 'joinspaces'.
1836 *cpo-J*
1837 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001838 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839 white space.
1840 *cpo-k*
1841 k Disable the recognition of raw key codes in
1842 mappings, abbreviations, and the "to" part of menu
1843 commands. For example, if <Key> sends ^[OA (where ^[
1844 is <Esc>), the command ":map X ^[OA" results in X
1845 being mapped to:
1846 'k' included: "^[OA" (3 characters)
1847 'k' excluded: "<Key>" (one key code)
1848 Also see the '<' flag below.
1849 *cpo-K*
1850 K Don't wait for a key code to complete when it is
1851 halfway a mapping. This breaks mapping <F1><F1> when
1852 only part of the second <F1> has been read. It
1853 enables cancelling the mapping by typing <F1><Esc>.
1854 *cpo-l*
1855 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001856 literally, only "\]", "\^", "\-" and "\\" are special.
1857 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001858 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1859 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001860 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001861 *cpo-L*
1862 L When the 'list' option is set, 'wrapmargin',
1863 'textwidth', 'softtabstop' and Virtual Replace mode
1864 (see |gR|) count a <Tab> as two characters, instead of
1865 the normal behavior of a <Tab>.
1866 *cpo-m*
1867 m When included, a showmatch will always wait half a
1868 second. When not included, a showmatch will wait half
1869 a second or until a character is typed. |'showmatch'|
1870 *cpo-M*
1871 M When excluded, "%" matching will take backslashes into
1872 account. Thus in "( \( )" and "\( ( \)" the outer
1873 parenthesis match. When included "%" ignores
1874 backslashes, which is Vi compatible.
1875 *cpo-n*
1876 n When included, the column used for 'number' will also
1877 be used for text of wrapped lines.
1878 *cpo-o*
1879 o Line offset to search command is not remembered for
1880 next search.
1881 *cpo-O*
1882 O Don't complain if a file is being overwritten, even
1883 when it didn't exist when editing it. This is a
1884 protection against a file unexpectedly created by
1885 someone else. Vi didn't complain about this.
1886 *cpo-p*
1887 p Vi compatible Lisp indenting. When not present, a
1888 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001889 *cpo-P*
1890 P When included, a ":write" command that appends to a
1891 file will set the file name for the current buffer, if
1892 the current buffer doesn't have a file name yet and
1893 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001894 *cpo-q*
1895 q When joining multiple lines leave the cursor at the
1896 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001897 *cpo-r*
1898 r Redo ("." command) uses "/" to repeat a search
1899 command, instead of the actually used search string.
1900 *cpo-R*
1901 R Remove marks from filtered lines. Without this flag
1902 marks are kept like |:keepmarks| was used.
1903 *cpo-s*
1904 s Set buffer options when entering the buffer for the
1905 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001906 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001907 set when the buffer is created.
1908 *cpo-S*
1909 S Set buffer options always when entering a buffer
1910 (except 'readonly', 'fileformat', 'filetype' and
1911 'syntax'). This is the (most) Vi compatible setting.
1912 The options are set to the values in the current
1913 buffer. When you change an option and go to another
1914 buffer, the value is copied. Effectively makes the
1915 buffer options global to all buffers.
1916
1917 's' 'S' copy buffer options
1918 no no when buffer created
1919 yes no when buffer first entered (default)
1920 X yes each time when buffer entered (vi comp.)
1921 *cpo-t*
1922 t Search pattern for the tag command is remembered for
1923 "n" command. Otherwise Vim only puts the pattern in
1924 the history for search pattern, but doesn't change the
1925 last used search pattern.
1926 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001927 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001928 *cpo-v*
1929 v Backspaced characters remain visible on the screen in
1930 Insert mode. Without this flag the characters are
1931 erased from the screen right away. With this flag the
1932 screen newly typed text overwrites backspaced
1933 characters.
1934 *cpo-w*
1935 w When using "cw" on a blank character, only change one
1936 character and not all blanks until the start of the
1937 next word.
1938 *cpo-W*
1939 W Don't overwrite a readonly file. When omitted, ":w!"
1940 overwrites a readonly file, if possible.
1941 *cpo-x*
1942 x <Esc> on the command-line executes the command-line.
1943 The default in Vim is to abandon the command-line,
1944 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001945 *cpo-X*
1946 X When using a count with "R" the replaced text is
1947 deleted only once. Also when repeating "R" with "."
1948 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001949 *cpo-y*
1950 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001951 *cpo-Z*
1952 Z When using "w!" while the 'readonly' option is set,
1953 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001954 *cpo-!*
1955 ! When redoing a filter command, use the last used
1956 external command, whatever it was. Otherwise the last
1957 used -filter- command is used.
1958 *cpo-$*
1959 $ When making a change to one line, don't redisplay the
1960 line, but put a '$' at the end of the changed text.
1961 The changed text will be overwritten when you type the
1962 new text. The line is redisplayed if you type any
1963 command that moves the cursor from the insertion
1964 point.
1965 *cpo-%*
1966 % Vi-compatible matching is done for the "%" command.
1967 Does not recognize "#if", "#endif", etc.
1968 Does not recognize "/*" and "*/".
1969 Parens inside single and double quotes are also
1970 counted, causing a string that contains a paren to
1971 disturb the matching. For example, in a line like
1972 "if (strcmp("foo(", s))" the first paren does not
1973 match the last one. When this flag is not included,
1974 parens inside single and double quotes are treated
1975 specially. When matching a paren outside of quotes,
1976 everything inside quotes is ignored. When matching a
1977 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001978 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001979 This flag is also used for other features, such as
1980 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001981 *cpo--*
1982 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001983 it would go above the first line or below the last
1984 line. Without it the cursor moves to the first or
1985 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001986 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001987 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001988 *cpo-+*
1989 + When included, a ":write file" command will reset the
1990 'modified' flag of the buffer, even though the buffer
1991 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001992 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 * Use ":*" in the same way as ":@". When not included,
1994 ":*" is an alias for ":'<,'>", select the Visual area.
1995 *cpo-<*
1996 < Disable the recognition of special key codes in |<>|
1997 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001998 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 ":map X <Tab>" results in X being mapped to:
2000 '<' included: "<Tab>" (5 characters)
2001 '<' excluded: "^I" (^I is a real <Tab>)
2002 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002003 *cpo->*
2004 > When appending to a register, put a line break before
2005 the appended text.
2006
2007 POSIX flags. These are not included in the Vi default value, except
2008 when $VIM_POSIX was set on startup. |posix|
2009
2010 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002011 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002012 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002013 *cpo-&*
2014 & When ":preserve" was used keep the swap file when
2015 exiting normally while this buffer is still loaded.
2016 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002017 *cpo-\*
2018 \ Backslash in a [] range in a search pattern is taken
2019 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002020 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2021 '\' excluded: "/[ \-]" finds <Space> and '-'
2022 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002023 *cpo-/*
2024 / When "%" is used as the replacement string in a |:s|
2025 command, use the previous replacement string. |:s%|
2026 *cpo-{*
2027 { The |{| and |}| commands also stop at a "{" character
2028 at the start of a line.
2029 *cpo-.*
2030 . The ":chdir" and ":cd" commands fail if the current
2031 buffer is modified, unless ! is used. Vim doesn't
2032 need this, since it remembers the full path of an
2033 opened file.
2034 *cpo-bar*
2035 | The value of the $LINES and $COLUMNS environment
2036 variables overrule the terminal size values obtained
2037 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002038
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039
2040 *'cscopepathcomp'* *'cspc'*
2041'cscopepathcomp' 'cspc' number (default 0)
2042 global
2043 {not available when compiled without the |+cscope|
2044 feature}
2045 {not in Vi}
2046 Determines how many components of the path to show in a list of tags.
2047 See |cscopepathcomp|.
2048
2049 *'cscopeprg'* *'csprg'*
2050'cscopeprg' 'csprg' string (default "cscope")
2051 global
2052 {not available when compiled without the |+cscope|
2053 feature}
2054 {not in Vi}
2055 Specifies the command to execute cscope. See |cscopeprg|.
2056 This option cannot be set from a |modeline| or in the |sandbox|, for
2057 security reasons.
2058
2059 *'cscopequickfix'* *'csqf'*
2060'cscopequickfix' 'csqf' string (default "")
2061 global
2062 {not available when compiled without the |+cscope|
2063 or |+quickfix| features}
2064 {not in Vi}
2065 Specifies whether to use quickfix window to show cscope results.
2066 See |cscopequickfix|.
2067
2068 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2069'cscopetag' 'cst' boolean (default off)
2070 global
2071 {not available when compiled without the |+cscope|
2072 feature}
2073 {not in Vi}
2074 Use cscope for tag commands. See |cscope-options|.
2075 NOTE: This option is reset when 'compatible' is set.
2076
2077 *'cscopetagorder'* *'csto'*
2078'cscopetagorder' 'csto' number (default 0)
2079 global
2080 {not available when compiled without the |+cscope|
2081 feature}
2082 {not in Vi}
2083 Determines the order in which ":cstag" performs a search. See
2084 |cscopetagorder|.
2085 NOTE: This option is set to 0 when 'compatible' is set.
2086
2087 *'cscopeverbose'* *'csverb'*
2088 *'nocscopeverbose'* *'nocsverb'*
2089'cscopeverbose' 'csverb' boolean (default off)
2090 global
2091 {not available when compiled without the |+cscope|
2092 feature}
2093 {not in Vi}
2094 Give messages when adding a cscope database. See |cscopeverbose|.
2095 NOTE: This option is reset when 'compatible' is set.
2096
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002097
2098 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2099'cursorcolumn' 'cuc' boolean (default off)
2100 local to window
2101 {not in Vi}
2102 {not available when compiled without the |+syntax|
2103 feature}
2104 Highlight the screen column of the cursor with CursorColumn
2105 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2106 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002107 If you only want the highlighting in the current window you can use
2108 these autocommands: >
2109 au WinLeave * set nocursorline nocursorcolumn
2110 au WinEnter * set cursorline cursorcolumn
2111<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002112
2113 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2114'cursorline' 'cul' boolean (default off)
2115 local to window
2116 {not in Vi}
2117 {not available when compiled without the |+syntax|
2118 feature}
2119 Highlight the screen line of the cursor with CursorLine
2120 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2121 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002122 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002123 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002124
2125
Bram Moolenaar071d4272004-06-13 20:20:40 +00002126 *'debug'*
2127'debug' string (default "")
2128 global
2129 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002130 These values can be used:
2131 msg Error messages that would otherwise be omitted will be given
2132 anyway.
2133 throw Error messages that would otherwise be omitted will be given
2134 anyway and also throw an exception and set |v:errmsg|.
2135 beep A message will be given when otherwise only a beep would be
2136 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002137 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002138 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2139 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140
2141 *'define'* *'def'*
2142'define' 'def' string (default "^\s*#\s*define")
2143 global or local to buffer |global-local|
2144 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002145 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002146 pattern, just like for the "/" command. This option is used for the
2147 commands like "[i" and "[d" |include-search|. The 'isident' option is
2148 used to recognize the defined name after the match:
2149 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2150 See |option-backslash| about inserting backslashes to include a space
2151 or backslash.
2152 The default value is for C programs. For C++ this value would be
2153 useful, to include const type declarations: >
2154 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2155< When using the ":set" command, you need to double the backslashes!
2156
2157 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2158'delcombine' 'deco' boolean (default off)
2159 global
2160 {not in Vi}
2161 {only available when compiled with the |+multi_byte|
2162 feature}
2163 If editing Unicode and this option is set, backspace and Normal mode
2164 "x" delete each combining character on its own. When it is off (the
2165 default) the character along with its combining characters are
2166 deleted.
2167 Note: When 'delcombine' is set "xx" may work different from "2x"!
2168
2169 This is useful for Arabic, Hebrew and many other languages where one
2170 may have combining characters overtop of base characters, and want
2171 to remove only the combining ones.
2172
2173 *'dictionary'* *'dict'*
2174'dictionary' 'dict' string (default "")
2175 global or local to buffer |global-local|
2176 {not in Vi}
2177 List of file names, separated by commas, that are used to lookup words
2178 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2179 contain a list of words. This can be one word per line, or several
2180 words per line, separated by non-keyword characters (white space is
2181 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002182 When this option is empty, or an entry "spell" is present, spell
2183 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002184 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002185 after a comma are ignored, otherwise spaces are included in the file
2186 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002187 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 Where to find a list of words?
2189 - On FreeBSD, there is the file "/usr/share/dict/words".
2190 - In the Simtel archive, look in the "msdos/linguist" directory.
2191 - In "miscfiles" of the GNU collection.
2192 The use of |:set+=| and |:set-=| is preferred when adding or removing
2193 directories from the list. This avoids problems when a future version
2194 uses another default.
2195 Backticks cannot be used in this option for security reasons.
2196
2197 *'diff'* *'nodiff'*
2198'diff' boolean (default off)
2199 local to window
2200 {not in Vi}
2201 {not available when compiled without the |+diff|
2202 feature}
2203 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002204 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002205
2206 *'dex'* *'diffexpr'*
2207'diffexpr' 'dex' string (default "")
2208 global
2209 {not in Vi}
2210 {not available when compiled without the |+diff|
2211 feature}
2212 Expression which is evaluated to obtain an ed-style diff file from two
2213 versions of a file. See |diff-diffexpr|.
2214 This option cannot be set from a |modeline| or in the |sandbox|, for
2215 security reasons.
2216
2217 *'dip'* *'diffopt'*
2218'diffopt' 'dip' string (default "filler")
2219 global
2220 {not in Vi}
2221 {not available when compiled without the |+diff|
2222 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002223 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002224 All are optional. Items must be separated by a comma.
2225
2226 filler Show filler lines, to keep the text
2227 synchronized with a window that has inserted
2228 lines at the same position. Mostly useful
2229 when windows are side-by-side and 'scrollbind'
2230 is set.
2231
2232 context:{n} Use a context of {n} lines between a change
2233 and a fold that contains unchanged lines.
2234 When omitted a context of six lines is used.
2235 See |fold-diff|.
2236
2237 icase Ignore changes in case of text. "a" and "A"
2238 are considered the same. Adds the "-i" flag
2239 to the "diff" command if 'diffexpr' is empty.
2240
2241 iwhite Ignore changes in amount of white space. Adds
2242 the "-b" flag to the "diff" command if
2243 'diffexpr' is empty. Check the documentation
2244 of the "diff" command for what this does
2245 exactly. It should ignore adding trailing
2246 white space, but not leading white space.
2247
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002248 horizontal Start diff mode with horizontal splits (unless
2249 explicitly specified otherwise).
2250
2251 vertical Start diff mode with vertical splits (unless
2252 explicitly specified otherwise).
2253
2254 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2255 starting diff mode. Without this 2 is used.
2256
Bram Moolenaar071d4272004-06-13 20:20:40 +00002257 Examples: >
2258
2259 :set diffopt=filler,context:4
2260 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002261 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002262<
2263 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2264'digraph' 'dg' boolean (default off)
2265 global
2266 {not in Vi}
2267 {not available when compiled without the |+digraphs|
2268 feature}
2269 Enable the entering of digraphs in Insert mode with {char1} <BS>
2270 {char2}. See |digraphs|.
2271 NOTE: This option is reset when 'compatible' is set.
2272
2273 *'directory'* *'dir'*
2274'directory' 'dir' string (default for Amiga: ".,t:",
2275 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2276 for Unix: ".,~/tmp,/var/tmp,/tmp")
2277 global
2278 List of directory names for the swap file, separated with commas.
2279 - The swap file will be created in the first directory where this is
2280 possible.
2281 - Empty means that no swap file will be used (recovery is
2282 impossible!).
2283 - A directory "." means to put the swap file in the same directory as
2284 the edited file. On Unix, a dot is prepended to the file name, so
2285 it doesn't show in a directory listing. On MS-Windows the "hidden"
2286 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002287 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002288 put the swap file relative to where the edited file is. The leading
2289 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002290 - For Unix and Win32, if a directory ends in two path separators "//"
2291 or "\\", the swap file name will be built from the complete path to
2292 the file with all path separators substituted to percent '%' signs.
2293 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002294 - Spaces after the comma are ignored, other spaces are considered part
2295 of the directory name. To have a space at the start of a directory
2296 name, precede it with a backslash.
2297 - To include a comma in a directory name precede it with a backslash.
2298 - A directory name may end in an ':' or '/'.
2299 - Environment variables are expanded |:set_env|.
2300 - Careful with '\' characters, type one before a space, type two to
2301 get one in the option (see |option-backslash|), for example: >
2302 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2303< - For backwards compatibility with Vim version 3.0 a '>' at the start
2304 of the option is removed.
2305 Using "." first in the list is recommended. This means that editing
2306 the same file twice will result in a warning. Using "/tmp" on Unix is
2307 discouraged: When the system crashes you lose the swap file.
2308 "/var/tmp" is often not cleared when rebooting, thus is a better
2309 choice than "/tmp". But it can contain a lot of files, your swap
2310 files get lost in the crowd. That is why a "tmp" directory in your
2311 home directory is tried first.
2312 The use of |:set+=| and |:set-=| is preferred when adding or removing
2313 directories from the list. This avoids problems when a future version
2314 uses another default.
2315 This option cannot be set from a |modeline| or in the |sandbox|, for
2316 security reasons.
2317 {Vi: directory to put temp file in, defaults to "/tmp"}
2318
2319 *'display'* *'dy'*
2320'display' 'dy' string (default "")
2321 global
2322 {not in Vi}
2323 Change the way text is displayed. This is comma separated list of
2324 flags:
2325 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002326 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 last line that doesn't fit is replaced with "@" lines.
2328 uhex Show unprintable characters hexadecimal as <xx>
2329 instead of using ^C and ~C.
2330
2331 *'eadirection'* *'ead'*
2332'eadirection' 'ead' string (default "both")
2333 global
2334 {not in Vi}
2335 {not available when compiled without the +vertsplit
2336 feature}
2337 Tells when the 'equalalways' option applies:
2338 ver vertically, width of windows is not affected
2339 hor horizontally, height of windows is not affected
2340 both width and height of windows is affected
2341
2342 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2343'edcompatible' 'ed' boolean (default off)
2344 global
2345 Makes the 'g' and 'c' flags of the ":substitute" command to be
2346 toggled each time the flag is given. See |complex-change|. See
2347 also 'gdefault' option.
2348 Switching this option on is discouraged!
2349
2350 *'encoding'* *'enc'* *E543*
2351'encoding' 'enc' string (default: "latin1" or value from $LANG)
2352 global
2353 {only available when compiled with the |+multi_byte|
2354 feature}
2355 {not in Vi}
2356 Sets the character encoding used inside Vim. It applies to text in
2357 the buffers, registers, Strings in expressions, text stored in the
2358 viminfo file, etc. It sets the kind of characters which Vim can work
2359 with. See |encoding-names| for the possible values.
2360
2361 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002362 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002364 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002365
2366 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2367 "utf-8". Although care has been taken to allow different values of
2368 'encoding', "utf-8" is the natural choice for the environment and
2369 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002370 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 versions, and to avoid changing the encoding of newly created files
2372 without your knowledge (in case 'fileencodings' is empty).
2373
2374 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002375 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 iconv() or as specified with 'charconvert'.
2377
2378 Normally 'encoding' will be equal to your current locale. This will
2379 be the default if Vim recognizes your environment settings. If
2380 'encoding' is not set to the current locale, 'termencoding' must be
2381 set to convert typed and displayed text. See |encoding-table|.
2382
2383 When you set this option, it fires the |EncodingChanged| autocommand
2384 event so that you can set up fonts if necessary.
2385
2386 When the option is set, the value is converted to lowercase. Thus
2387 you can set it with uppercase values too. Underscores are translated
2388 to '-' signs.
2389 When the encoding is recognized, it is changed to the standard name.
2390 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2391 "iso-8859-2" and "utf8" becomes "utf-8".
2392
2393 Note: "latin1" is also used when the encoding could not be detected.
2394 This only works when editing files in the same encoding! When the
2395 actual character set is not latin1, make sure 'fileencoding' and
2396 'fileencodings' are empty. When conversion is needed, switch to using
2397 utf-8.
2398
2399 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2400 You don't notice this while editing, but it does matter for the
2401 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2402 setting 'encoding' to one of these values instead of utf-8 only has
2403 effect for encoding used for files when 'fileencoding' is empty.
2404
Bram Moolenaar661b1822005-07-28 22:36:45 +00002405 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2406 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407
2408 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2409'endofline' 'eol' boolean (default on)
2410 local to buffer
2411 {not in Vi}
2412 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002413 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 option is automatically set when starting to edit a new file, unless
2415 the file does not have an <EOL> for the last line in the file, in
2416 which case it is reset. Normally you don't have to set or reset this
2417 option. When 'binary' is off the value is not used when writing the
2418 file. When 'binary' is on it is used to remember the presence of a
2419 <EOL> for the last line in the file, so that when you write the file
2420 the situation from the original file can be kept. But you can change
2421 it if you want to.
2422
2423 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2424'equalalways' 'ea' boolean (default on)
2425 global
2426 {not in Vi}
2427 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002428 splitting or closing a window. This also happens the moment the
2429 option is switched on. When off, splitting a window will reduce the
2430 size of the current window and leave the other windows the same. When
2431 closing a window the extra lines are given to the window next to it
2432 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002433 When mixing vertically and horizontally split windows, a minimal size
2434 is computed and some windows may be larger if there is room. The
2435 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002436 Changing the height and width of a window can be avoided by setting
2437 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438
2439 *'equalprg'* *'ep'*
2440'equalprg' 'ep' string (default "")
2441 global or local to buffer |global-local|
2442 {not in Vi}
2443 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002444 the internal formatting functions are used; either 'lisp', 'cindent'
2445 or 'indentexpr'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002446 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002447 about including spaces and backslashes.
2448 This option cannot be set from a |modeline| or in the |sandbox|, for
2449 security reasons.
2450
2451 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2452'errorbells' 'eb' boolean (default off)
2453 global
2454 Ring the bell (beep or screen flash) for error messages. This only
2455 makes a difference for error messages, the bell will be used always
2456 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 screen flash or do nothing.
2459
2460 *'errorfile'* *'ef'*
2461'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2462 others: "errors.err")
2463 global
2464 {not in Vi}
2465 {not available when compiled without the |+quickfix|
2466 feature}
2467 Name of the errorfile for the QuickFix mode (see |:cf|).
2468 When the "-q" command-line argument is used, 'errorfile' is set to the
2469 following argument. See |-q|.
2470 NOT used for the ":make" command. See 'makeef' for that.
2471 Environment variables are expanded |:set_env|.
2472 See |option-backslash| about including spaces and backslashes.
2473 This option cannot be set from a |modeline| or in the |sandbox|, for
2474 security reasons.
2475
2476 *'errorformat'* *'efm'*
2477'errorformat' 'efm' string (default is very long)
2478 global or local to buffer |global-local|
2479 {not in Vi}
2480 {not available when compiled without the |+quickfix|
2481 feature}
2482 Scanf-like description of the format for the lines in the error file
2483 (see |errorformat|).
2484
2485 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2486'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2487 global
2488 {not in Vi}
2489 Function keys that start with an <Esc> are recognized in Insert
2490 mode. When this option is off, the cursor and function keys cannot be
2491 used in Insert mode if they start with an <Esc>. The advantage of
2492 this is that the single <Esc> is recognized immediately, instead of
2493 after one second. Instead of resetting this option, you might want to
2494 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2495 when 'esckeys' is off, you can still map anything, but the cursor keys
2496 won't work by default.
2497 NOTE: This option is set to the Vi default value when 'compatible' is
2498 set and to the Vim default value when 'compatible' is reset.
2499
2500 *'eventignore'* *'ei'*
2501'eventignore' 'ei' string (default "")
2502 global
2503 {not in Vi}
2504 {not available when compiled without the |+autocmd|
2505 feature}
2506 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002507 When set to "all" or when "all" is one of the items, all autocommand
2508 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002509 Otherwise this is a comma separated list of event names. Example: >
2510 :set ei=WinEnter,WinLeave
2511<
2512 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2513'expandtab' 'et' boolean (default off)
2514 local to buffer
2515 {not in Vi}
2516 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002517 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002518 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2519 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2520 NOTE: This option is reset when 'compatible' is set.
2521
2522 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2523'exrc' 'ex' boolean (default off)
2524 global
2525 {not in Vi}
2526 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2527 directory. If you switch this option on you should also consider
2528 setting the 'secure' option (see |initialization|). Using a local
2529 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2530 also see |.vimrc| and |gui-init|.
2531 This option cannot be set from a |modeline| or in the |sandbox|, for
2532 security reasons.
2533
2534 *'fileencoding'* *'fenc'* *E213*
2535'fileencoding' 'fenc' string (default: "")
2536 local to buffer
2537 {only available when compiled with the |+multi_byte|
2538 feature}
2539 {not in Vi}
2540 Sets the character encoding for the file of this buffer.
2541 When 'fileencoding' is different from 'encoding', conversion will be
2542 done when reading and writing the file.
2543 When 'fileencoding' is empty, the same value as 'encoding' will be
2544 used (no conversion when reading or writing a file).
2545 WARNING: Conversion can cause loss of information! When
2546 'encoding' is "utf-8" conversion is most likely done in a way
2547 that the reverse conversion results in the same text. When
2548 'encoding' is not "utf-8" some characters may be lost!
2549 See 'encoding' for the possible values. Additionally, values may be
2550 specified that can be handled by the converter, see
2551 |mbyte-conversion|.
2552 When reading a file 'fileencoding' will be set from 'fileencodings'.
2553 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002554 'fileencoding', use the |++enc| argument. One exception: when
2555 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002556 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002557 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2558 When the option is set, the value is converted to lowercase. Thus
2559 you can set it with uppercase values too. '_' characters are
2560 replaced with '-'. If a name is recognized from the list for
2561 'encoding', it is replaced by the standard name. For example
2562 "ISO8859-2" becomes "iso-8859-2".
2563 When this option is set, after starting to edit a file, the 'modified'
2564 option is set, because the file would be different when written.
2565 If you do this in a modeline, you might want to set 'nomodified' to
2566 avoid this.
2567 This option can not be changed when 'modifiable' is off.
2568
2569 *'fe'*
2570 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002571 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 old short name was 'fe', which is no longer used.
2573
2574 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002575'fileencodings' 'fencs' string (default: "ucs-bom",
2576 "ucs-bom,utf-8,default,latin1" when
2577 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 global
2579 {only available when compiled with the |+multi_byte|
2580 feature}
2581 {not in Vi}
2582 This is a list of character encodings considered when starting to edit
2583 an existing file. When a file is read, Vim tries to use the first
2584 mentioned character encoding. If an error is detected, the next one
2585 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002586 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 an empty string, which means the value of 'encoding' is used.
2588 WARNING: Conversion can cause loss of information! When
2589 'encoding' is "utf-8" (or one of the other Unicode variants)
2590 conversion is most likely done in a way that the reverse
2591 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002592 "utf-8" some non-ASCII characters may be lost! You can use
2593 the |++bad| argument to specify what is done with characters
2594 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 For an empty file or a file with only ASCII characters most encodings
2596 will work and the first entry of 'fileencodings' will be used (except
2597 "ucs-bom", which requires the BOM to be present). If you prefer
2598 another encoding use an BufReadPost autocommand event to test if your
2599 preferred encoding is to be used. Example: >
2600 au BufReadPost * if search('\S', 'w') == 0 |
2601 \ set fenc=iso-2022-jp | endif
2602< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2603 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002604 When the |++enc| argument is used then the value of 'fileencodings' is
2605 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002606 Note that 'fileencodings' is not used for a new file, the global value
2607 of 'fileencoding' is used instead. You can set it with: >
2608 :setglobal fenc=iso-8859-2
2609< This means that a non-existing file may get a different encoding than
2610 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 The special value "ucs-bom" can be used to check for a Unicode BOM
2612 (Byte Order Mark) at the start of the file. It must not be preceded
2613 by "utf-8" or another Unicode encoding for this to work properly.
2614 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2615 because Vim cannot detect an error, thus the encoding is always
2616 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002617 The special value "default" can be used for the encoding from the
2618 environment. This is the default value for 'encoding'. It is useful
2619 when 'encoding' is set to "utf-8" and your environment uses a
2620 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002621 When 'encoding' is "utf-8" and a file contains an illegal byte
2622 sequence it won't be recognized as UTF-8. You can use the |8g8|
2623 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 WRONG VALUES: WHAT'S WRONG:
2625 latin1,utf-8 "latin1" will always be used
2626 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2627 file
2628 cp1250,latin1 "cp1250" will always be used
2629 If 'fileencodings' is empty, 'fileencoding' is not modified.
2630 See 'fileencoding' for the possible values.
2631 Setting this option does not have an effect until the next time a file
2632 is read.
2633
2634 *'fileformat'* *'ff'*
2635'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2636 Unix default: "unix",
2637 Macintosh default: "mac")
2638 local to buffer
2639 {not in Vi}
2640 This gives the <EOL> of the current buffer, which is used for
2641 reading/writing the buffer from/to a file:
2642 dos <CR> <NL>
2643 unix <NL>
2644 mac <CR>
2645 When "dos" is used, CTRL-Z at the end of a file is ignored.
2646 See |file-formats| and |file-read|.
2647 For the character encoding of the file see 'fileencoding'.
2648 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2649 works like it was set to "unix'.
2650 This option is set automatically when starting to edit a file and
2651 'fileformats' is not empty and 'binary' is off.
2652 When this option is set, after starting to edit a file, the 'modified'
2653 option is set, because the file would be different when written.
2654 This option can not be changed when 'modifiable' is off.
2655 For backwards compatibility: When this option is set to "dos",
2656 'textmode' is set, otherwise 'textmode' is reset.
2657
2658 *'fileformats'* *'ffs'*
2659'fileformats' 'ffs' string (default:
2660 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2661 Vim Unix: "unix,dos",
2662 Vim Mac: "mac,unix,dos",
2663 Vi Cygwin: "unix,dos",
2664 Vi others: "")
2665 global
2666 {not in Vi}
2667 This gives the end-of-line (<EOL>) formats that will be tried when
2668 starting to edit a new buffer and when reading a file into an existing
2669 buffer:
2670 - When empty, the format defined with 'fileformat' will be used
2671 always. It is not set automatically.
2672 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002673 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002674 'fileformats' name will be used when a file is read into an existing
2675 buffer, no matter what 'fileformat' for that buffer is set to.
2676 - When more than one name is present, separated by commas, automatic
2677 <EOL> detection will be done when reading a file. When starting to
2678 edit a file, a check is done for the <EOL>:
2679 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2680 'fileformat' is set to "dos".
2681 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002682 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002683 preceding <CR>, "unix" is preferred over "dos".
2684 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2685 This means that "mac" is only chosen when "unix" is not present,
2686 or when no <NL> is found in the file, and when "dos" is not
2687 present, or no <CR><NL> is present in the file.
2688 Also if "unix" was first chosen, but the first <CR> is before
2689 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2690 the file, then 'fileformat' is set to "mac".
2691 4. If 'fileformat' is still not set, the first name from
2692 'fileformats' is used.
2693 When reading a file into an existing buffer, the same is done, but
2694 this happens like 'fileformat' has been set appropriately for that
2695 file only, the option is not changed.
2696 When 'binary' is set, the value of 'fileformats' is not used.
2697
2698 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2699 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2700 done:
2701 - When 'fileformats' is empty, there is no automatic detection. Dos
2702 format will be used.
2703 - When 'fileformats' is set to one or more names, automatic detection
2704 is done. This is based on the first <NL> in the file: If there is a
2705 <CR> in front of it, Dos format is used, otherwise Unix format is
2706 used.
2707 Also see |file-formats|.
2708 For backwards compatibility: When this option is set to an empty
2709 string or one format (no comma is included), 'textauto' is reset,
2710 otherwise 'textauto' is set.
2711 NOTE: This option is set to the Vi default value when 'compatible' is
2712 set and to the Vim default value when 'compatible' is reset.
2713
2714 *'filetype'* *'ft'*
2715'filetype' 'ft' string (default: "")
2716 local to buffer
2717 {not in Vi}
2718 {not available when compiled without the |+autocmd|
2719 feature}
2720 When this option is set, the FileType autocommand event is triggered.
2721 All autocommands that match with the value of this option will be
2722 executed. Thus the value of 'filetype' is used in place of the file
2723 name.
2724 Otherwise this option does not always reflect the current file type.
2725 This option is normally set when the file type is detected. To enable
2726 this use the ":filetype on" command. |:filetype|
2727 Setting this option to a different value is most useful in a modeline,
2728 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002729 Example, for in an IDL file:
2730 /* vim: set filetype=idl : */ ~
2731 |FileType| |filetypes|
2732 When a dot appears in the value then this separates two filetype
2733 names. Example:
2734 /* vim: set filetype=c.doxygen : */ ~
2735 This will use the "c" filetype first, then the "doxygen" filetype.
2736 This works both for filetype plugins and for syntax files. More than
2737 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738 Do not confuse this option with 'osfiletype', which is for the file
2739 type that is actually stored with the file.
2740 This option is not copied to another buffer, independent of the 's' or
2741 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002742 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743
2744 *'fillchars'* *'fcs'*
2745'fillchars' 'fcs' string (default "vert:|,fold:-")
2746 global
2747 {not in Vi}
2748 {not available when compiled without the |+windows|
2749 and |+folding| features}
2750 Characters to fill the statuslines and vertical separators.
2751 It is a comma separated list of items:
2752
2753 item default Used for ~
2754 stl:c ' ' or '^' statusline of the current window
2755 stlnc:c ' ' or '-' statusline of the non-current windows
2756 vert:c '|' vertical separators |:vsplit|
2757 fold:c '-' filling 'foldtext'
2758 diff:c '-' deleted lines of the 'diff' option
2759
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002760 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 "stlnc" the space will be used when there is highlighting, '^' or '-'
2762 otherwise.
2763
2764 Example: >
2765 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2766< This is similar to the default, except that these characters will also
2767 be used when there is highlighting.
2768
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002769 for "stl" and "stlnc" only single-byte values are supported.
2770
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 The highlighting used for these items:
2772 item highlight group ~
2773 stl:c StatusLine |hl-StatusLine|
2774 stlnc:c StatusLineNC |hl-StatusLineNC|
2775 vert:c VertSplit |hl-VertSplit|
2776 fold:c Folded |hl-Folded|
2777 diff:c DiffDelete |hl-DiffDelete|
2778
2779 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2780'fkmap' 'fk' boolean (default off) *E198*
2781 global
2782 {not in Vi}
2783 {only available when compiled with the |+rightleft|
2784 feature}
2785 When on, the keyboard is mapped for the Farsi character set.
2786 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002787 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788
2789 *'foldclose'* *'fcl'*
2790'foldclose' 'fcl' string (default "")
2791 global
2792 {not in Vi}
2793 {not available when compiled without the |+folding|
2794 feature}
2795 When set to "all", a fold is closed when the cursor isn't in it and
2796 its level is higher than 'foldlevel'. Useful if you want folds to
2797 automatically close when moving out of them.
2798
2799 *'foldcolumn'* *'fdc'*
2800'foldcolumn' 'fdc' number (default 0)
2801 local to window
2802 {not in Vi}
2803 {not available when compiled without the |+folding|
2804 feature}
2805 When non-zero, a column with the specified width is shown at the side
2806 of the window which indicates open and closed folds. The maximum
2807 value is 12.
2808 See |folding|.
2809
2810 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2811'foldenable' 'fen' boolean (default on)
2812 local to window
2813 {not in Vi}
2814 {not available when compiled without the |+folding|
2815 feature}
2816 When off, all folds are open. This option can be used to quickly
2817 switch between showing all text unfolded and viewing the text with
2818 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002819 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820 'foldenable' is off.
2821 This option is set by commands that create a new fold or close a fold.
2822 See |folding|.
2823
2824 *'foldexpr'* *'fde'*
2825'foldexpr' 'fde' string (default: "0")
2826 local to window
2827 {not in Vi}
2828 {not available when compiled without the |+folding|
2829 or |+eval| feature}
2830 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002831 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002832
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002833 The expression may be evaluated in the |sandbox|, see
2834 |sandbox-option|.
2835
2836 It is not allowed to change text or jump to another window while
2837 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838
2839 *'foldignore'* *'fdi'*
2840'foldignore' 'fdi' string (default: "#")
2841 local to window
2842 {not in Vi}
2843 {not available when compiled without the |+folding|
2844 feature}
2845 Used only when 'foldmethod' is "indent". Lines starting with
2846 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 The default "#" works well for C programs. See |fold-indent|.
2849
2850 *'foldlevel'* *'fdl'*
2851'foldlevel' 'fdl' number (default: 0)
2852 local to window
2853 {not in Vi}
2854 {not available when compiled without the |+folding|
2855 feature}
2856 Sets the fold level: Folds with a higher level will be closed.
2857 Setting this option to zero will close all folds. Higher numbers will
2858 close fewer folds.
2859 This option is set by commands like |zm|, |zM| and |zR|.
2860 See |fold-foldlevel|.
2861
2862 *'foldlevelstart'* *'fdls'*
2863'foldlevelstart' 'fdls' number (default: -1)
2864 global
2865 {not in Vi}
2866 {not available when compiled without the |+folding|
2867 feature}
2868 Sets 'foldlevel' when starting to edit another buffer in a window.
2869 Useful to always start editing with all folds closed (value zero),
2870 some folds closed (one) or no folds closed (99).
2871 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002872 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 ignores this option and closes all folds.
2874 It is also done before BufReadPre autocommands, to allow an autocmd to
2875 overrule the 'foldlevel' value for specific files.
2876 When the value is negative, it is not used.
2877
2878 *'foldmarker'* *'fmr'* *E536*
2879'foldmarker' 'fmr' string (default: "{{{,}}}")
2880 local to window
2881 {not in Vi}
2882 {not available when compiled without the |+folding|
2883 feature}
2884 The start and end marker used when 'foldmethod' is "marker". There
2885 must be one comma, which separates the start and end marker. The
2886 marker is a literal string (a regular expression would be too slow).
2887 See |fold-marker|.
2888
2889 *'foldmethod'* *'fdm'*
2890'foldmethod' 'fdm' string (default: "manual")
2891 local to window
2892 {not in Vi}
2893 {not available when compiled without the |+folding|
2894 feature}
2895 The kind of folding used for the current window. Possible values:
2896 |fold-manual| manual Folds are created manually.
2897 |fold-indent| indent Lines with equal indent form a fold.
2898 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2899 |fold-marker| marker Markers are used to specify folds.
2900 |fold-syntax| syntax Syntax highlighting items specify folds.
2901 |fold-diff| diff Fold text that is not changed.
2902
2903 *'foldminlines'* *'fml'*
2904'foldminlines' 'fml' number (default: 1)
2905 local to window
2906 {not in Vi}
2907 {not available when compiled without the |+folding|
2908 feature}
2909 Sets the minimum number of screen lines for a fold to be displayed
2910 closed. Also for manually closed folds.
2911 Note that this only has an effect of what is displayed. After using
2912 "zc" to close a fold, which is displayed open because it's smaller
2913 than 'foldminlines', a following "zc" may close a containing fold.
2914
2915 *'foldnestmax'* *'fdn'*
2916'foldnestmax' 'fdn' number (default: 20)
2917 local to window
2918 {not in Vi}
2919 {not available when compiled without the |+folding|
2920 feature}
2921 Sets the maximum nesting of folds for the "indent" and "syntax"
2922 methods. This avoids that too many folds will be created. Using more
2923 than 20 doesn't work, because the internal limit is 20.
2924
2925 *'foldopen'* *'fdo'*
2926'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2927 search,tag,undo")
2928 global
2929 {not in Vi}
2930 {not available when compiled without the |+folding|
2931 feature}
2932 Specifies for which type of commands folds will be opened, if the
2933 command moves the cursor into a closed fold. It is a comma separated
2934 list of items.
2935 item commands ~
2936 all any
2937 block "(", "{", "[[", "[{", etc.
2938 hor horizontal movements: "l", "w", "fx", etc.
2939 insert any command in Insert mode
2940 jump far jumps: "G", "gg", etc.
2941 mark jumping to a mark: "'m", CTRL-O, etc.
2942 percent "%"
2943 quickfix ":cn", ":crew", ":make", etc.
2944 search search for a pattern: "/", "n", "*", "gd", etc.
2945 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002946 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 tag jumping to a tag: ":ta", CTRL-T, etc.
2948 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002949 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 the |zv| command to the mapping to get the same effect.
2951 When a movement command is used for an operator (e.g., "dl" or "y%")
2952 this option is not used. This means the operator will include the
2953 whole closed fold.
2954 Note that vertical movements are not here, because it would make it
2955 very difficult to move onto a closed fold.
2956 In insert mode the folds containing the cursor will always be open
2957 when text is inserted.
2958 To close folds you can re-apply 'foldlevel' with the |zx| command or
2959 set the 'foldclose' option to "all".
2960
2961 *'foldtext'* *'fdt'*
2962'foldtext' 'fdt' string (default: "foldtext()")
2963 local to window
2964 {not in Vi}
2965 {not available when compiled without the |+folding|
2966 feature}
2967 An expression which is used to specify the text displayed for a closed
2968 fold. See |fold-foldtext|.
2969
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002970 The expression may be evaluated in the |sandbox|, see
2971 |sandbox-option|.
2972
2973 It is not allowed to change text or jump to another window while
2974 evaluating 'foldtext' |textlock|.
2975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 *'formatoptions'* *'fo'*
2977'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2978 local to buffer
2979 {not in Vi}
2980 This is a sequence of letters which describes how automatic
2981 formatting is to be done. See |fo-table|. When the 'paste' option is
2982 on, no formatting is done (like 'formatoptions' is empty). Commas can
2983 be inserted for readability.
2984 To avoid problems with flags that are added in the future, use the
2985 "+=" and "-=" feature of ":set" |add-option-flags|.
2986 NOTE: This option is set to the Vi default value when 'compatible' is
2987 set and to the Vim default value when 'compatible' is reset.
2988
Bram Moolenaar86b68352004-12-27 21:59:20 +00002989 *'formatlistpat'* *'flp'*
2990'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2991 local to buffer
2992 {not in Vi}
2993 A pattern that is used to recognize a list header. This is used for
2994 the "n" flag in 'formatoptions'.
2995 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002996 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002997 while still checking more characters. There must be a character
2998 following the pattern, when it matches the whole line it is handled
2999 like there is no match.
3000 The default recognizes a number, followed by an optional punctuation
3001 character and white space.
3002
Bram Moolenaar071d4272004-06-13 20:20:40 +00003003 *'formatprg'* *'fp'*
3004'formatprg' 'fp' string (default "")
3005 global
3006 {not in Vi}
3007 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003008 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003010 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003011 If the 'formatexpr' option is not empty it will be used instead.
3012 Otherwise, if 'formatprg' option is an empty string, the internal
3013 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003014 Environment variables are expanded |:set_env|. See |option-backslash|
3015 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003016 The expression may be evaluated in the |sandbox|, see
3017 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003019 *'formatexpr'* *'fex'*
3020'formatexpr' 'fex' string (default "")
3021 local to buffer
3022 {not in Vi}
3023 {not available when compiled without the |+eval|
3024 feature}
3025 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003026 operator. When this option is empty 'formatprg' is used.
3027
3028 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003029 The |v:count| variable holds the number of lines to be formatted.
3030 The |v:char| variable holds the character that is going to be
3031 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003032
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003033 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003034 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003035< This will invoke the mylang#Format() function in the
3036 autoload/mylang.vim file in 'runtimepath'. |autoload|
3037
3038 The expression is also evaluated when 'textwidth' is set and adding
3039 text beyond that limit. This happens under the same conditions as
3040 when internal formatting is used. Make sure the cursor is kept in the
3041 same spot relative to the text then! The |mode()| function will
3042 return "i" or "R" in this situation. When the function returns
3043 non-zero Vim will fall back to using the internal format mechanism.
3044
3045 The expression may be evaluated in the |sandbox|, see
3046 |sandbox-option|.
3047
3048 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003049'fsync' 'fs' boolean (default on)
3050 global
3051 {not in Vi}
3052 When on, the library function fsync() will be called after writing a
3053 file. This will flush a file to disk, ensuring that it is safely
3054 written even on filesystems which do metadata-only journaling. This
3055 will force the harddrive to spin up on Linux systems running in laptop
3056 mode, so it may be undesirable in some situations. Be warned that
3057 turning this off increases the chances of data loss after a crash. On
3058 systems without an fsync() implementation, this variable is always
3059 off.
3060 Also see 'swapsync' for controlling fsync() on swap files.
3061
Bram Moolenaar071d4272004-06-13 20:20:40 +00003062 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3063'gdefault' 'gd' boolean (default off)
3064 global
3065 {not in Vi}
3066 When on, the ":substitute" flag 'g' is default on. This means that
3067 all matches in a line are substituted instead of one. When a 'g' flag
3068 is given to a ":substitute" command, this will toggle the substitution
3069 of all or one match. See |complex-change|.
3070
3071 command 'gdefault' on 'gdefault' off ~
3072 :s/// subst. all subst. one
3073 :s///g subst. one subst. all
3074 :s///gg subst. all subst. one
3075
3076 NOTE: This option is reset when 'compatible' is set.
3077
3078 *'grepformat'* *'gfm'*
3079'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3080 global
3081 {not in Vi}
3082 Format to recognize for the ":grep" command output.
3083 This is a scanf-like string that uses the same format as the
3084 'errorformat' option: see |errorformat|.
3085
3086 *'grepprg'* *'gp'*
3087'grepprg' 'gp' string (default "grep -n ",
3088 Unix: "grep -n $* /dev/null",
3089 Win32: "findstr /n" or "grep -n",
3090 VMS: "SEARCH/NUMBERS ")
3091 global or local to buffer |global-local|
3092 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003093 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 and '#' characters, which are expanded like when used in a command-
3095 line. The placeholder "$*" is allowed to specify where the arguments
3096 will be included. Environment variables are expanded |:set_env|. See
3097 |option-backslash| about including spaces and backslashes.
3098 When your "grep" accepts the "-H" argument, use this to make ":grep"
3099 also work well with a single file: >
3100 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003101< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003102 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3103 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003104 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003105 apply equally to 'grepprg'.
3106 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3107 otherwise it's "grep -n".
3108 This option cannot be set from a |modeline| or in the |sandbox|, for
3109 security reasons.
3110
3111 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3112'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3113 ve:ver35-Cursor,
3114 o:hor50-Cursor,
3115 i-ci:ver25-Cursor/lCursor,
3116 r-cr:hor20-Cursor/lCursor,
3117 sm:block-Cursor
3118 -blinkwait175-blinkoff150-blinkon175",
3119 for MS-DOS and Win32 console:
3120 "n-v-c:block,o:hor50,i-ci:hor15,
3121 r-cr:hor30,sm:block")
3122 global
3123 {not in Vi}
3124 {only available when compiled with GUI enabled, and
3125 for MS-DOS and Win32 console}
3126 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003127 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003128 the height of the cursor can be changed. This can be done by
3129 specifying a block cursor, or a percentage for a vertical or
3130 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003131 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003132
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003133 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 mode-list and an argument-list:
3135 mode-list:argument-list,mode-list:argument-list,..
3136 The mode-list is a dash separated list of these modes:
3137 n Normal mode
3138 v Visual mode
3139 ve Visual mode with 'selection' "exclusive" (same as 'v',
3140 if not specified)
3141 o Operator-pending mode
3142 i Insert mode
3143 r Replace mode
3144 c Command-line Normal (append) mode
3145 ci Command-line Insert mode
3146 cr Command-line Replace mode
3147 sm showmatch in Insert mode
3148 a all modes
3149 The argument-list is a dash separated list of these arguments:
3150 hor{N} horizontal bar, {N} percent of the character height
3151 ver{N} vertical bar, {N} percent of the character width
3152 block block cursor, fills the whole character
3153 [only one of the above three should be present]
3154 blinkwait{N} *cursor-blinking*
3155 blinkon{N}
3156 blinkoff{N}
3157 blink times for cursor: blinkwait is the delay before
3158 the cursor starts blinking, blinkon is the time that
3159 the cursor is shown and blinkoff is the time that the
3160 cursor is not shown. The times are in msec. When one
3161 of the numbers is zero, there is no blinking. The
3162 default is: "blinkwait700-blinkon400-blinkoff250".
3163 These numbers are used for a missing entry. This
3164 means that blinking is enabled by default. To switch
3165 blinking off you can use "blinkon0". The cursor only
3166 blinks when Vim is waiting for input, not while
3167 executing a command.
3168 To make the cursor blink in an xterm, see
3169 |xterm-blink|.
3170 {group-name}
3171 a highlight group name, that sets the color and font
3172 for the cursor
3173 {group-name}/{group-name}
3174 Two highlight group names, the first is used when
3175 no language mappings are used, the other when they
3176 are. |language-mapping|
3177
3178 Examples of parts:
3179 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3180 block cursor with colors from the "nCursor"
3181 highlight group
3182 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3183 In Insert and Command-line Insert mode, use a
3184 30% vertical bar cursor with colors from the
3185 "iCursor" highlight group. Blink a bit
3186 faster.
3187
3188 The 'a' mode is different. It will set the given argument-list for
3189 all modes. It does not reset anything to defaults. This can be used
3190 to do a common setting for all modes. For example, to switch off
3191 blinking: "a:blinkon0"
3192
3193 Examples of cursor highlighting: >
3194 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3195 :highlight Cursor gui=NONE guifg=bg guibg=fg
3196<
3197 *'guifont'* *'gfn'*
3198 *E235* *E596* *E610* *E611*
3199'guifont' 'gfn' string (default "")
3200 global
3201 {not in Vi}
3202 {only available when compiled with GUI enabled}
3203 This is a list of fonts which will be used for the GUI version of Vim.
3204 In its simplest form the value is just one font name. When
3205 the font cannot be found you will get an error message. To try other
3206 font names a list can be specified, font names separated with commas.
3207 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003208
Bram Moolenaar05159a02005-02-26 23:04:13 +00003209 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3210 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003211
Bram Moolenaar071d4272004-06-13 20:20:40 +00003212 Spaces after a comma are ignored. To include a comma in a font name
3213 precede it with a backslash. Setting an option requires an extra
3214 backslash before a space and a backslash. See also
3215 |option-backslash|. For example: >
3216 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003217< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003219
3220 If none of the fonts can be loaded, Vim will keep the current setting.
3221 If an empty font list is given, Vim will try using other resource
3222 settings (for X, it will use the Vim.font resource), and finally it
3223 will try some builtin default which should always be there ("7x13" in
3224 the case of X). The font names given should be "normal" fonts. Vim
3225 will try to find the related bold and italic fonts.
3226
Bram Moolenaar05159a02005-02-26 23:04:13 +00003227 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003228 :set guifont=*
3229< will bring up a font requester, where you can pick the font you want.
3230
3231 The font name depends on the GUI used. See |setting-guifont| for a
3232 way to set 'guifont' for various systems.
3233
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234 For the GTK+ 2 GUI the font name looks like this: >
3235 :set guifont=Andale\ Mono\ 11
3236< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003237
3238 For Mac OSX you can use something like this: >
3239 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003240< Also see 'macatsui', it can help fix display problems.
3241 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003242 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003243 width). An exception is GTK 2: all fonts are accepted, but
3244 mono-spaced fonts look best.
3245
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 To preview a font on X11, you might be able to use the "xfontsel"
3247 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003248
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 For the Win32 GUI *E244* *E245*
3250 - takes these options in the font name:
3251 hXX - height is XX (points, can be floating-point)
3252 wXX - width is XX (points, can be floating-point)
3253 b - bold
3254 i - italic
3255 u - underline
3256 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003257 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3259 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3260 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003261 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262
3263 Use a ':' to separate the options.
3264 - A '_' can be used in the place of a space, so you don't need to use
3265 backslashes to escape the spaces.
3266 - Examples: >
3267 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3268 :set guifont=Andale_Mono:h7.5:w4.5
3269< See also |font-sizes|.
3270
3271 *'guifontset'* *'gfs'*
3272 *E250* *E252* *E234* *E597* *E598*
3273'guifontset' 'gfs' string (default "")
3274 global
3275 {not in Vi}
3276 {only available when compiled with GUI enabled and
3277 with the |+xfontset| feature}
3278 {not available in the GTK+ 2 GUI}
3279 When not empty, specifies two (or more) fonts to be used. The first
3280 one for normal English, the second one for your special language. See
3281 |xfontset|.
3282 Setting this option also means that all font names will be handled as
3283 a fontset name. Also the ones used for the "font" argument of the
3284 |:highlight| command.
3285 The fonts must match with the current locale. If fonts for the
3286 character sets that the current locale uses are not included, setting
3287 'guifontset' will fail.
3288 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3289 the comma-separated names are alternative names, one of which will be
3290 used. In 'guifontset' the whole string is one fontset name,
3291 including the commas. It is not possible to specify alternative
3292 fontset names.
3293 This example works on many X11 systems: >
3294 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3295<
3296 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3297'guifontwide' 'gfw' string (default "")
3298 global
3299 {not in Vi}
3300 {only available when compiled with GUI enabled}
3301 When not empty, specifies a comma-separated list of fonts to be used
3302 for double-width characters. The first font that can be loaded is
3303 used.
3304 Note: The size of these fonts must be exactly twice as wide as the one
3305 specified with 'guifont' and the same height.
3306
3307 All GUI versions but GTK+ 2:
3308
3309 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3310 'guifontset' is empty or invalid.
3311 When 'guifont' is set and a valid font is found in it and
3312 'guifontwide' is empty Vim will attempt to find a matching
3313 double-width font and set 'guifontwide' to it.
3314
3315 GTK+ 2 GUI only: *guifontwide_gtk2*
3316
3317 If set and valid, 'guifontwide' is always used for double width
3318 characters, even if 'encoding' is not set to "utf-8".
3319 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003320 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003321 font for characters not available in 'guifont'. Thus you do not need
3322 to set 'guifontwide' at all unless you want to override the choice
3323 made by Pango/Xft.
3324
3325 *'guiheadroom'* *'ghr'*
3326'guiheadroom' 'ghr' number (default 50)
3327 global
3328 {not in Vi} {only for GTK and X11 GUI}
3329 The number of pixels subtracted from the screen height when fitting
3330 the GUI window on the screen. Set this before the GUI is started,
3331 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003332 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 lines will be left for window decorations and other items on the
3334 screen. Set it to a negative value to allow windows taller than the
3335 screen.
3336
3337 *'guioptions'* *'go'*
3338'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003339 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003340 global
3341 {not in Vi}
3342 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003343 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 sequence of letters which describes what components and options of the
3345 GUI should be used.
3346 To avoid problems with flags that are added in the future, use the
3347 "+=" and "-=" feature of ":set" |add-option-flags|.
3348
3349 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003350 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003351 'a' Autoselect: If present, then whenever VISUAL mode is started,
3352 or the Visual area extended, Vim tries to become the owner of
3353 the windowing system's global selection. This means that the
3354 Visually highlighted text is available for pasting into other
3355 applications as well as into Vim itself. When the Visual mode
3356 ends, possibly due to an operation on the text, or when an
3357 application wants to paste the selection, the highlighted text
3358 is automatically yanked into the "* selection register.
3359 Thus the selection is still available for pasting into other
3360 applications after the VISUAL mode has ended.
3361 If not present, then Vim won't become the owner of the
3362 windowing system's global selection unless explicitly told to
3363 by a yank or delete operation for the "* register.
3364 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003365 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 applies to the modeless selection.
3368
3369 'guioptions' autoselect Visual autoselect modeless ~
3370 "" - -
3371 "a" yes yes
3372 "A" - yes
3373 "aA" yes yes
3374
Bram Moolenaar02467872007-05-06 13:22:01 +00003375 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 'c' Use console dialogs instead of popup dialogs for simple
3377 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003378 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003379 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003380 'guitablabel' can be used to change the text in the labels.
3381 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003382 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003383 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003384 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003385 'f' Foreground: Don't use fork() to detach the GUI from the shell
3386 where it was started. Use this for programs that wait for the
3387 editor to finish (e.g., an e-mail program). Alternatively you
3388 can use "gvim -f" or ":gui -f" to start the GUI in the
3389 foreground. |gui-fork|
3390 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003391 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003392 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003393 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3394 corner of the window. It's black&white on non-GTK, because of
3395 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003396 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003398 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003399 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003401 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 file is sourced the system menu has already been loaded; the
3403 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003404 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003405 'g' Grey menu items: Make menu items that are not active grey. If
3406 'g' is not included inactive menu items are not shown at all.
3407 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003408 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 't' Include tearoff menu items. Currently only works for Win32,
3410 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003411 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003412 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003413 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003414 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003416 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 'R' Right-hand scrollbar is present when there is a vertically
3418 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003419 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003421 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 'L' Left-hand scrollbar is present when there is a vertically
3423 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003424 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003425 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3426 the longest visible line, or on the cursor line if the 'h'
3427 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003428 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 'h' Limit horizontal scrollbar size to the length of the cursor
3430 line. Reduces computations. |gui-horiz-scroll|
3431
3432 And yes, you may even have scrollbars on the left AND the right if
3433 you really want to :-). See |gui-scrollbars| for more information.
3434
Bram Moolenaar02467872007-05-06 13:22:01 +00003435 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003436 'v' Use a vertical button layout for dialogs. When not included,
3437 a horizontal layout is preferred, but when it doesn't fit a
3438 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003439 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003440 'p' Use Pointer callbacks for X11 GUI. This is required for some
3441 window managers. If the cursor is not blinking or hollow at
3442 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003443 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003444 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003445 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003446 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003447
Bram Moolenaar02467872007-05-06 13:22:01 +00003448
Bram Moolenaar071d4272004-06-13 20:20:40 +00003449 *'guipty'* *'noguipty'*
3450'guipty' boolean (default on)
3451 global
3452 {not in Vi}
3453 {only available when compiled with GUI enabled}
3454 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3455 I/O to/from shell commands. See |gui-pty|.
3456
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003457 *'guitablabel'* *'gtl'*
3458'guitablabel' 'gtl' string (default empty)
3459 global
3460 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003461 {only available when compiled with GUI enabled and
3462 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003463 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003464 pages line. When empty and when the result is empty Vim will use a
3465 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003466
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003467 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003468 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003469
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003470 Only used when the GUI tab pages line is displayed. 'e' must be
3471 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3472 used.
3473
Bram Moolenaar57657d82006-04-21 22:12:41 +00003474 *'guitabtooltip'* *'gtt'*
3475'guitabtooltip' 'gtt' string (default empty)
3476 global
3477 {not in Vi}
3478 {only available when compiled with GUI enabled and
3479 with the +windows feature}
3480 When nonempty describes the text to use in a tooltip for the GUI tab
3481 pages line. When empty Vim will use a default tooltip.
3482 This option is otherwise just like 'guitablabel' above.
3483
Bram Moolenaar57657d82006-04-21 22:12:41 +00003484
Bram Moolenaar071d4272004-06-13 20:20:40 +00003485 *'helpfile'* *'hf'*
3486'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3487 (others) "$VIMRUNTIME/doc/help.txt")
3488 global
3489 {not in Vi}
3490 Name of the main help file. All distributed help files should be
3491 placed together in one directory. Additionally, all "doc" directories
3492 in 'runtimepath' will be used.
3493 Environment variables are expanded |:set_env|. For example:
3494 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003495 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003496 spaces and backslashes.
3497 This option cannot be set from a |modeline| or in the |sandbox|, for
3498 security reasons.
3499
3500 *'helpheight'* *'hh'*
3501'helpheight' 'hh' number (default 20)
3502 global
3503 {not in Vi}
3504 {not available when compiled without the +windows
3505 feature}
3506 Minimal initial height of the help window when it is opened with the
3507 ":help" command. The initial height of the help window is half of the
3508 current window, or (when the 'ea' option is on) the same as other
3509 windows. When the height is less than 'helpheight', the height is
3510 set to 'helpheight'. Set to zero to disable.
3511
3512 *'helplang'* *'hlg'*
3513'helplang' 'hlg' string (default: messages language or empty)
3514 global
3515 {only available when compiled with the |+multi_lang|
3516 feature}
3517 {not in Vi}
3518 Comma separated list of languages. Vim will use the first language
3519 for which the desired help can be found. The English help will always
3520 be used as a last resort. You can add "en" to prefer English over
3521 another language, but that will only find tags that exist in that
3522 language and not in the English help.
3523 Example: >
3524 :set helplang=de,it
3525< This will first search German, then Italian and finally English help
3526 files.
3527 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3528 try to find the tag in the current language before using this option.
3529 See |help-translated|.
3530
3531 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3532'hidden' 'hid' boolean (default off)
3533 global
3534 {not in Vi}
3535 When off a buffer is unloaded when it is |abandon|ed. When on a
3536 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3537 displayed in another window, it does not become hidden, of course.
3538 The commands that move through the buffer list sometimes make a buffer
3539 hidden although the 'hidden' option is off: When the buffer is
3540 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003541 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003542 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 This option is set for one command with ":hide {command}" |:hide|.
3544 WARNING: It's easy to forget that you have changes in hidden buffers.
3545 Think twice when using ":q!" or ":qa!".
3546
3547 *'highlight'* *'hl'*
3548'highlight' 'hl' string (default (as a single string):
3549 "8:SpecialKey,@:NonText,d:Directory,
3550 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3551 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003552 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3554 f:Folded,F:FoldColumn,A:DiffAdd,
3555 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003556 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003557 R:SpellRare,L:SpellLocal,
3558 +:Pmenu,=:PmenuSel,
3559 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 global
3561 {not in Vi}
3562 This option can be used to set highlighting mode for various
3563 occasions. It is a comma separated list of character pairs. The
3564 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003565 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3567 |hl-NonText| @ '~' and '@' at the end of the window and
3568 characters from 'showbreak'
3569 |hl-Directory| d directories in CTRL-D listing and other special
3570 things in listings
3571 |hl-ErrorMsg| e error messages
3572 h (obsolete, ignored)
3573 |hl-IncSearch| i 'incsearch' highlighting
3574 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3575 |hl-MoreMsg| m |more-prompt|
3576 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3577 |hl-LineNr| n line number for ":number" and ":#" commands
3578 |hl-Question| r |hit-enter| prompt and yes/no questions
3579 |hl-StatusLine| s status line of current window |status-line|
3580 |hl-StatusLineNC| S status lines of not-current windows
3581 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3582 |hl-VertSplit| c column used to separate vertically split windows
3583 |hl-Visual| v Visual mode
3584 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3585 Selection" Only X11 Gui's |gui-x11| and
3586 |xterm-clipboard|.
3587 |hl-WarningMsg| w warning messages
3588 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3589 |hl-Folded| f line used for closed folds
3590 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003591 |hl-DiffAdd| A added line in diff mode
3592 |hl-DiffChange| C changed line in diff mode
3593 |hl-DiffDelete| D deleted line in diff mode
3594 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003596 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003597 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003598 |hl-SpellRare| R rare word |spell|
3599 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003600 |hl-Pmenu| + popup menu normal line
3601 |hl-PmenuSel| = popup menu normal line
3602 |hl-PmenuSbar| x popup menu scrollbar
3603 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604
3605 The display modes are:
3606 r reverse (termcap entry "mr" and "me")
3607 i italic (termcap entry "ZH" and "ZR")
3608 b bold (termcap entry "md" and "me")
3609 s standout (termcap entry "so" and "se")
3610 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003611 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003612 n no highlighting
3613 - no highlighting
3614 : use a highlight group
3615 The default is used for occasions that are not included.
3616 If you want to change what the display modes do, see |dos-colors|
3617 for an example.
3618 When using the ':' display mode, this must be followed by the name of
3619 a highlight group. A highlight group can be used to define any type
3620 of highlighting, including using color. See |:highlight| on how to
3621 define one. The default uses a different group for each occasion.
3622 See |highlight-default| for the default highlight groups.
3623
3624 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3625'hlsearch' 'hls' boolean (default off)
3626 global
3627 {not in Vi}
3628 {not available when compiled without the
3629 |+extra_search| feature}
3630 When there is a previous search pattern, highlight all its matches.
3631 The type of highlighting used can be set with the 'l' occasion in the
3632 'highlight' option. This uses the "Search" highlight group by
3633 default. Note that only the matching text is highlighted, any offsets
3634 are not applied.
3635 See also: 'incsearch' and |:match|.
3636 When you get bored looking at the highlighted matches, you can turn it
3637 off with |:nohlsearch|. As soon as you use a search command, the
3638 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003639 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640 When the search pattern can match an end-of-line, Vim will try to
3641 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003642 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003643 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003644 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003645 NOTE: This option is reset when 'compatible' is set.
3646
3647 *'history'* *'hi'*
3648'history' 'hi' number (Vim default: 20, Vi default: 0)
3649 global
3650 {not in Vi}
3651 A history of ":" commands, and a history of previous search patterns
3652 are remembered. This option decides how many entries may be stored in
3653 each of these histories (see |cmdline-editing|).
3654 NOTE: This option is set to the Vi default value when 'compatible' is
3655 set and to the Vim default value when 'compatible' is reset.
3656
3657 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3658'hkmap' 'hk' boolean (default off)
3659 global
3660 {not in Vi}
3661 {only available when compiled with the |+rightleft|
3662 feature}
3663 When on, the keyboard is mapped for the Hebrew character set.
3664 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3665 toggle this option. See |rileft.txt|.
3666 NOTE: This option is reset when 'compatible' is set.
3667
3668 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3669'hkmapp' 'hkp' boolean (default off)
3670 global
3671 {not in Vi}
3672 {only available when compiled with the |+rightleft|
3673 feature}
3674 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3675 This is useful if you have a non-Hebrew keyboard.
3676 See |rileft.txt|.
3677 NOTE: This option is reset when 'compatible' is set.
3678
3679 *'icon'* *'noicon'*
3680'icon' boolean (default off, on when title can be restored)
3681 global
3682 {not in Vi}
3683 {not available when compiled without the |+title|
3684 feature}
3685 When on, the icon text of the window will be set to the value of
3686 'iconstring' (if it is not empty), or to the name of the file
3687 currently being edited. Only the last part of the name is used.
3688 Overridden by the 'iconstring' option.
3689 Only works if the terminal supports setting window icons (currently
3690 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3691 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3692 builtin termcap).
3693 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003694 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 X11.
3696
3697 *'iconstring'*
3698'iconstring' string (default "")
3699 global
3700 {not in Vi}
3701 {not available when compiled without the |+title|
3702 feature}
3703 When this option is not empty, it will be used for the icon text of
3704 the window. This happens only when the 'icon' option is on.
3705 Only works if the terminal supports setting window icon text
3706 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3707 Does not work for MS Windows.
3708 When Vim was compiled with HAVE_X11 defined, the original icon will be
3709 restored if possible |X11|.
3710 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003711 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 'titlestring' for example settings.
3713 {not available when compiled without the |+statusline| feature}
3714
3715 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3716'ignorecase' 'ic' boolean (default off)
3717 global
3718 Ignore case in search patterns. Also used when searching in the tags
3719 file.
3720 Also see 'smartcase'.
3721 Can be overruled by using "\c" or "\C" in the pattern, see
3722 |/ignorecase|.
3723
3724 *'imactivatekey'* *'imak'*
3725'imactivatekey' 'imak' string (default "")
3726 global
3727 {not in Vi}
3728 {only available when compiled with |+xim| and
3729 |+GUI_GTK|}
3730 Specifies the key that your Input Method in X-Windows uses for
3731 activation. When this is specified correctly, vim can fully control
3732 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3733 You can't use this option to change the activation key, the option
3734 tells Vim what the key is.
3735 Format:
3736 [MODIFIER_FLAG-]KEY_STRING
3737
3738 These characters can be used for MODIFIER_FLAG (case is ignored):
3739 S Shift key
3740 L Lock key
3741 C Control key
3742 1 Mod1 key
3743 2 Mod2 key
3744 3 Mod3 key
3745 4 Mod4 key
3746 5 Mod5 key
3747 Combinations are allowed, for example "S-C-space" or "SC-space" are
3748 both shift+ctrl+space.
3749 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3750
3751 Example: >
3752 :set imactivatekey=S-space
3753< "S-space" means shift+space. This is the activation key for kinput2 +
3754 canna (Japanese), and ami (Korean).
3755
3756 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3757'imcmdline' 'imc' boolean (default off)
3758 global
3759 {not in Vi}
3760 {only available when compiled with the |+xim|
3761 |+multi_byte_ime| or |global-ime| feature}
3762 When set the Input Method is always on when starting to edit a command
3763 line, unless entering a search pattern (see 'imsearch' for that).
3764 Setting this option is useful when your input method allows entering
3765 English characters directly, e.g., when it's used to type accented
3766 characters with dead keys.
3767
3768 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3769'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3770 global
3771 {not in Vi}
3772 {only available when compiled with the |+xim|
3773 |+multi_byte_ime| or |global-ime| feature}
3774 When set the Input Method is never used. This is useful to disable
3775 the IM when it doesn't work properly.
3776 Currently this option is on by default for SGI/IRIX machines. This
3777 may change in later releases.
3778
3779 *'iminsert'* *'imi'*
3780'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3781 local to buffer
3782 {not in Vi}
3783 Specifies whether :lmap or an Input Method (IM) is to be used in
3784 Insert mode. Valid values:
3785 0 :lmap is off and IM is off
3786 1 :lmap is ON and IM is off
3787 2 :lmap is off and IM is ON
3788 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3789 or |global-ime|.
3790 To always reset the option to zero when leaving Insert mode with <Esc>
3791 this can be used: >
3792 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3793< This makes :lmap and IM turn off automatically when leaving Insert
3794 mode.
3795 Note that this option changes when using CTRL-^ in Insert mode
3796 |i_CTRL-^|.
3797 The value is set to 1 when setting 'keymap' to a valid keymap name.
3798 It is also used for the argument of commands like "r" and "f".
3799 The value 0 may not work correctly with Athena and Motif with some XIM
3800 methods. Use 'imdisable' to disable XIM then.
3801
3802 *'imsearch'* *'ims'*
3803'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3804 local to buffer
3805 {not in Vi}
3806 Specifies whether :lmap or an Input Method (IM) is to be used when
3807 entering a search pattern. Valid values:
3808 -1 the value of 'iminsert' is used, makes it look like
3809 'iminsert' is also used when typing a search pattern
3810 0 :lmap is off and IM is off
3811 1 :lmap is ON and IM is off
3812 2 :lmap is off and IM is ON
3813 Note that this option changes when using CTRL-^ in Command-line mode
3814 |c_CTRL-^|.
3815 The value is set to 1 when it is not -1 and setting the 'keymap'
3816 option to a valid keymap name.
3817 The value 0 may not work correctly with Athena and Motif with some XIM
3818 methods. Use 'imdisable' to disable XIM then.
3819
3820 *'include'* *'inc'*
3821'include' 'inc' string (default "^\s*#\s*include")
3822 global or local to buffer |global-local|
3823 {not in Vi}
3824 {not available when compiled without the
3825 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003826 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 pattern, just like for the "/" command (See |pattern|). The default
3828 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003829 "]I", "[d", etc.
3830 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003831 comes after the matched pattern. But if "\zs" appears in the pattern
3832 then the text matched from "\zs" to the end, or until "\ze" if it
3833 appears, is used as the file name. Use this to include characters
3834 that are not in 'isfname', such as a space. You can then use
3835 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003836 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003837
3838 *'includeexpr'* *'inex'*
3839'includeexpr' 'inex' string (default "")
3840 local to buffer
3841 {not in Vi}
3842 {not available when compiled without the
3843 |+find_in_path| or |+eval| feature}
3844 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003845 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003846 :set includeexpr=substitute(v:fname,'\\.','/','g')
3847< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003848
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003850 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003851 Also used for |<cfile>|.
3852
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003853 The expression may be evaluated in the |sandbox|, see
3854 |sandbox-option|.
3855
3856 It is not allowed to change text or jump to another window while
3857 evaluating 'includeexpr' |textlock|.
3858
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3860'incsearch' 'is' boolean (default off)
3861 global
3862 {not in Vi}
3863 {not available when compiled without the
3864 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003865 While typing a search command, show where the pattern, as it was typed
3866 so far, matches. The matched string is highlighted. If the pattern
3867 is invalid or not found, nothing is shown. The screen will be updated
3868 often, this is only useful on fast terminals.
3869 Note that the match will be shown, but the cursor will return to its
3870 original position when no match is found and when pressing <Esc>. You
3871 still need to finish the search command with <Enter> to move the
3872 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003873 When compiled with the |+reltime| feature Vim only searches for about
3874 half a second. With a complicated pattern and/or a lot of text the
3875 match may not be found. This is to avoid that Vim hangs while you
3876 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003877 The highlighting can be set with the 'i' flag in 'highlight'.
3878 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003879 CTRL-L can be used to add one character from after the current match
3880 to the command line.
3881 CTRL-R CTRL-W can be used to add the word at the end of the current
3882 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003883 NOTE: This option is reset when 'compatible' is set.
3884
3885 *'indentexpr'* *'inde'*
3886'indentexpr' 'inde' string (default "")
3887 local to buffer
3888 {not in Vi}
3889 {not available when compiled without the |+cindent|
3890 or |+eval| features}
3891 Expression which is evaluated to obtain the proper indent for a line.
3892 It is used when a new line is created, for the |=| operator and
3893 in Insert mode as specified with the 'indentkeys' option.
3894 When this option is not empty, it overrules the 'cindent' and
3895 'smartindent' indenting.
3896 When 'paste' is set this option is not used for indenting.
3897 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003898 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 when the expression is evaluated (but it may be moved around).
3900 The expression must return the number of spaces worth of indent. It
3901 can return "-1" to keep the current indent (this means 'autoindent' is
3902 used for the indent).
3903 Functions useful for computing the indent are |indent()|, |cindent()|
3904 and |lispindent()|.
3905 The evaluation of the expression must not have side effects! It must
3906 not change the text, jump to another window, etc. Afterwards the
3907 cursor position is always restored, thus the cursor may be moved.
3908 Normally this option would be set to call a function: >
3909 :set indentexpr=GetMyIndent()
3910< Error messages will be suppressed, unless the 'debug' option contains
3911 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003912 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 NOTE: This option is made empty when 'compatible' is set.
3914
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003915 The expression may be evaluated in the |sandbox|, see
3916 |sandbox-option|.
3917
3918 It is not allowed to change text or jump to another window while
3919 evaluating 'indentexpr' |textlock|.
3920
3921
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 *'indentkeys'* *'indk'*
3923'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3924 local to buffer
3925 {not in Vi}
3926 {not available when compiled without the |+cindent|
3927 feature}
3928 A list of keys that, when typed in Insert mode, cause reindenting of
3929 the current line. Only happens if 'indentexpr' isn't empty.
3930 The format is identical to 'cinkeys', see |indentkeys-format|.
3931 See |C-indenting| and |indent-expression|.
3932
3933 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3934'infercase' 'inf' boolean (default off)
3935 local to buffer
3936 {not in Vi}
3937 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003938 'ignorecase' is also on, the case of the match is adjusted depending
3939 on the typed text. If the typed text contains a lowercase letter
3940 where the match has an upper case letter, the completed part is made
3941 lowercase. If the typed text has no lowercase letters and the match
3942 has a lowercase letter where the typed text has an uppercase letter,
3943 and there is a letter before it, the completed part is made uppercase.
3944 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945
3946 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3947'insertmode' 'im' boolean (default off)
3948 global
3949 {not in Vi}
3950 Makes Vim work in a way that Insert mode is the default mode. Useful
3951 if you want to use Vim as a modeless editor. Used for |evim|.
3952 These Insert mode commands will be useful:
3953 - Use the cursor keys to move around.
3954 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3955 this is a mapping, it is executed as if 'insertmode' was off.
3956 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003958 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3959 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960
3961 These items change when 'insertmode' is set:
3962 - when starting to edit of a file, Vim goes to Insert mode.
3963 - <Esc> in Insert mode is a no-op and beeps.
3964 - <Esc> in Normal mode makes Vim go to Insert mode.
3965 - CTRL-L in Insert mode is a command, it is not inserted.
3966 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3967 However, when <Esc> is used inside a mapping, it behaves like
3968 'insertmode' was not set. This was done to be able to use the same
3969 mappings with 'insertmode' set or not set.
3970 When executing commands with |:normal| 'insertmode' is not used.
3971
3972 NOTE: This option is reset when 'compatible' is set.
3973
3974 *'isfname'* *'isf'*
3975'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3976 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3977 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3978 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3979 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3980 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3981 global
3982 {not in Vi}
3983 The characters specified by this option are included in file names and
3984 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003985 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003986 Multi-byte characters 256 and above are always included, only the
3987 characters up to 255 are specified with this option.
3988 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003989 Think twice before adding white space to this option. Although a
3990 space may appear inside a file name, the effect will be that Vim
3991 doesn't know where a file name starts or ends when doing completion.
3992 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993
3994 Note that on systems using a backslash as path separator, Vim tries to
3995 do its best to make it work as you would expect. That is a bit
3996 tricky, since Vi originally used the backslash to escape special
3997 characters. Vim will not remove a backslash in front of a normal file
3998 name character on these systems, but it will on Unix and alikes. The
3999 '&' and '^' are not included by default, because these are special for
4000 cmd.exe.
4001
4002 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004003 Each part can be a single character number or a range. A range is two
4004 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004005 decimal number between 0 and 255 or the ASCII character itself (does
4006 not work for digits). Example:
4007 "_,-,128-140,#-43" (include '_' and '-' and the range
4008 128 to 140 and '#' to 43)
4009 If a part starts with '^', the following character number or range
4010 will be excluded from the option. The option is interpreted from left
4011 to right. Put the excluded character after the range where it is
4012 included. To include '^' itself use it as the last character of the
4013 option or the end of a range. Example:
4014 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4015 If the character is '@', all characters where isalpha() returns TRUE
4016 are included. Normally these are the characters a to z and A to Z,
4017 plus accented characters. To include '@' itself use "@-@". Examples:
4018 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004019 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 "a-z,A-Z,@-@" All letters plus the '@' character.
4021 A comma can be included by using it where a character number is
4022 expected. Example:
4023 "48-57,,,_" Digits, comma and underscore.
4024 A comma can be excluded by prepending a '^'. Example:
4025 " -~,^,,9" All characters from space to '~', excluding
4026 comma, plus <Tab>.
4027 See |option-backslash| about including spaces and backslashes.
4028
4029 *'isident'* *'isi'*
4030'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4031 "@,48-57,_,128-167,224-235"
4032 otherwise: "@,48-57,_,192-255")
4033 global
4034 {not in Vi}
4035 The characters given by this option are included in identifiers.
4036 Identifiers are used in recognizing environment variables and after a
4037 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004038 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004039 option.
4040 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004041 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004042 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4043
4044 *'iskeyword'* *'isk'*
4045'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4046 "@,48-57,_,128-167,224-235"
4047 otherwise: "@,48-57,_,192-255"
4048 Vi default: "@,48-57,_")
4049 local to buffer
4050 {not in Vi}
4051 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004052 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004053 'isfname' for a description of the format of this option. For C
4054 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4055 For a help file it is set to all non-blank printable characters except
4056 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4057 command).
4058 When the 'lisp' option is on the '-' character is always included.
4059 NOTE: This option is set to the Vi default value when 'compatible' is
4060 set and to the Vim default value when 'compatible' is reset.
4061
4062 *'isprint'* *'isp'*
4063'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4064 "@,~-255"; otherwise: "@,161-255")
4065 global
4066 {not in Vi}
4067 The characters given by this option are displayed directly on the
4068 screen. It is also used for "\p" in a |pattern|. The characters from
4069 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4070 even when they are not included in 'isprint' or excluded. See
4071 'isfname' for a description of the format of this option.
4072
4073 Non-printable characters are displayed with two characters:
4074 0 - 31 "^@" - "^_"
4075 32 - 126 always single characters
4076 127 "^?"
4077 128 - 159 "~@" - "~_"
4078 160 - 254 "| " - "|~"
4079 255 "~?"
4080 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4081 displayed as <xx>, with the hexadecimal value of the byte.
4082 When 'display' contains "uhex" all unprintable characters are
4083 displayed as <xx>.
4084 The NonText highlighting will be used for unprintable characters.
4085 |hl-NonText|
4086
4087 Multi-byte characters 256 and above are always included, only the
4088 characters up to 255 are specified with this option. When a character
4089 is printable but it is not available in the current font, a
4090 replacement character will be shown.
4091 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4092 There is no option to specify these characters.
4093
4094 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4095'joinspaces' 'js' boolean (default on)
4096 global
4097 {not in Vi}
4098 Insert two spaces after a '.', '?' and '!' with a join command.
4099 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4100 Otherwise only one space is inserted.
4101 NOTE: This option is set when 'compatible' is set.
4102
4103 *'key'*
4104'key' string (default "")
4105 local to buffer
4106 {not in Vi}
4107 The key that is used for encrypting and decrypting the current buffer.
4108 See |encryption|.
4109 Careful: Do not set the key value by hand, someone might see the typed
4110 key. Use the |:X| command. But you can make 'key' empty: >
4111 :set key=
4112< It is not possible to get the value of this option with ":set key" or
4113 "echo &key". This is to avoid showing it to someone who shouldn't
4114 know. It also means you cannot see it yourself once you have set it,
4115 be careful not to make a typing error!
4116
4117 *'keymap'* *'kmp'* *E544*
4118'keymap' 'kmp' string (default "")
4119 local to buffer
4120 {not in Vi}
4121 {only available when compiled with the |+keymap|
4122 feature}
4123 Name of a keyboard mapping. See |mbyte-keymap|.
4124 Setting this option to a valid keymap name has the side effect of
4125 setting 'iminsert' to one, so that the keymap becomes effective.
4126 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004127 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128
4129 *'keymodel'* *'km'*
4130'keymodel' 'km' string (default "")
4131 global
4132 {not in Vi}
4133 List of comma separated words, which enable special things that keys
4134 can do. These values can be used:
4135 startsel Using a shifted special key starts selection (either
4136 Select mode or Visual mode, depending on "key" being
4137 present in 'selectmode').
4138 stopsel Using a not-shifted special key stops selection.
4139 Special keys in this context are the cursor keys, <End>, <Home>,
4140 <PageUp> and <PageDown>.
4141 The 'keymodel' option is set by the |:behave| command.
4142
4143 *'keywordprg'* *'kp'*
4144'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4145 OS/2: "view /", VMS: "help")
4146 global or local to buffer |global-local|
4147 {not in Vi}
4148 Program to use for the |K| command. Environment variables are
4149 expanded |:set_env|. ":help" may be used to access the Vim internal
4150 help. (Note that previously setting the global option to the empty
4151 value did this, which is now deprecated.)
4152 When "man" is used, Vim will automatically translate a count for the
4153 "K" command to a section number. Also for "man -s", in which case the
4154 "-s" is removed when there is no count.
4155 See |option-backslash| about including spaces and backslashes.
4156 Example: >
4157 :set keywordprg=man\ -s
4158< This option cannot be set from a |modeline| or in the |sandbox|, for
4159 security reasons.
4160
4161 *'langmap'* *'lmap'* *E357* *E358*
4162'langmap' 'lmap' string (default "")
4163 global
4164 {not in Vi}
4165 {only available when compiled with the |+langmap|
4166 feature}
4167 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004168 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169 inserted directly. When in command mode the 'langmap' option takes
4170 care of translating these special characters to the original meaning
4171 of the key. This means you don't have to change the keyboard mode to
4172 be able to execute Normal mode commands.
4173 This is the opposite of the 'keymap' option, where characters are
4174 mapped in Insert mode.
4175 This only works for 8-bit characters. The value of 'langmap' may be
4176 specified with multi-byte characters (e.g., UTF-8), but only the lower
4177 8 bits of each character will be used.
4178
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004179 Example (for Greek, in UTF-8): *greek* >
4180 :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 +00004181< Example (exchanges meaning of z and y for commands): >
4182 :set langmap=zy,yz,ZY,YZ
4183<
4184 The 'langmap' option is a list of parts, separated with commas. Each
4185 part can be in one of two forms:
4186 1. A list of pairs. Each pair is a "from" character immediately
4187 followed by the "to" character. Examples: "aA", "aAbBcC".
4188 2. A list of "from" characters, a semi-colon and a list of "to"
4189 characters. Example: "abc;ABC"
4190 Example: "aA,fgh;FGH,cCdDeE"
4191 Special characters need to be preceded with a backslash. These are
4192 ";", ',' and backslash itself.
4193
4194 This will allow you to activate vim actions without having to switch
4195 back and forth between the languages. Your language characters will
4196 be understood as normal vim English characters (according to the
4197 langmap mappings) in the following cases:
4198 o Normal/Visual mode (commands, buffer/register names, user mappings)
4199 o Insert/Replace Mode: Register names after CTRL-R
4200 o Insert/Replace Mode: Mappings
4201 Characters entered in Command-line mode will NOT be affected by
4202 this option. Note that this option can be changed at any time
4203 allowing to switch between mappings for different languages/encodings.
4204 Use a mapping to avoid having to type it each time!
4205
4206 *'langmenu'* *'lm'*
4207'langmenu' 'lm' string (default "")
4208 global
4209 {not in Vi}
4210 {only available when compiled with the |+menu| and
4211 |+multi_lang| features}
4212 Language to use for menu translation. Tells which file is loaded
4213 from the "lang" directory in 'runtimepath': >
4214 "lang/menu_" . &langmenu . ".vim"
4215< (without the spaces). For example, to always use the Dutch menus, no
4216 matter what $LANG is set to: >
4217 :set langmenu=nl_NL.ISO_8859-1
4218< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004219 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 If your $LANG is set to a non-English language but you do want to use
4221 the English menus: >
4222 :set langmenu=none
4223< This option must be set before loading menus, switching on filetype
4224 detection or syntax highlighting. Once the menus are defined setting
4225 this option has no effect. But you could do this: >
4226 :source $VIMRUNTIME/delmenu.vim
4227 :set langmenu=de_DE.ISO_8859-1
4228 :source $VIMRUNTIME/menu.vim
4229< Warning: This deletes all menus that you defined yourself!
4230
4231 *'laststatus'* *'ls'*
4232'laststatus' 'ls' number (default 1)
4233 global
4234 {not in Vi}
4235 The value of this option influences when the last window will have a
4236 status line:
4237 0: never
4238 1: only if there are at least two windows
4239 2: always
4240 The screen looks nicer with a status line if you have several
4241 windows, but it takes another screen line. |status-line|
4242
4243 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4244'lazyredraw' 'lz' boolean (default off)
4245 global
4246 {not in Vi}
4247 When this option is set, the screen will not be redrawn while
4248 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004249 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004250 update use |:redraw|.
4251
4252 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4253'linebreak' 'lbr' boolean (default off)
4254 local to window
4255 {not in Vi}
4256 {not available when compiled without the |+linebreak|
4257 feature}
4258 If on Vim will wrap long lines at a character in 'breakat' rather
4259 than at the last character that fits on the screen. Unlike
4260 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4261 it only affects the way the file is displayed, not its contents. The
4262 value of 'showbreak' is used to put in front of wrapped lines.
4263 This option is not used when the 'wrap' option is off or 'list' is on.
4264 Note that <Tab> characters after an <EOL> are mostly not displayed
4265 with the right amount of white space.
4266
4267 *'lines'* *E593*
4268'lines' number (default 24 or terminal height)
4269 global
4270 Number of lines of the Vim window.
4271 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004272 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 When Vim is running in the GUI or in a resizable window, setting this
4274 option will cause the window size to be changed. When you only want
4275 to use the size for the GUI, put the command in your |gvimrc| file.
4276 Vim limits the number of lines to what fits on the screen. You can
4277 use this command to get the tallest window possible: >
4278 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004279< Minimum value is 2, maximum value is 1000.
4280 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004281 When you set this option and Vim is unable to change the physical
4282 number of lines of the display, the display may be messed up.
4283
4284 *'linespace'* *'lsp'*
4285'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4286 global
4287 {not in Vi}
4288 {only in the GUI}
4289 Number of pixel lines inserted between characters. Useful if the font
4290 uses the full character cell height, making lines touch each other.
4291 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004292 With some fonts there can be too much room between lines (to have
4293 space for ascents and descents). Then it makes sense to set
4294 'linespace' to a negative value. This may cause display problems
4295 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296
4297 *'lisp'* *'nolisp'*
4298'lisp' boolean (default off)
4299 local to buffer
4300 {not available when compiled without the |+lispindent|
4301 feature}
4302 Lisp mode: When <Enter> is typed in insert mode set the indent for
4303 the next line to Lisp standards (well, sort of). Also happens with
4304 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4305 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4306 better. Also see 'lispwords'.
4307 The '-' character is included in keyword characters. Redefines the
4308 "=" operator to use this same indentation algorithm rather than
4309 calling an external program if 'equalprg' is empty.
4310 This option is not used when 'paste' is set.
4311 {Vi: Does it a little bit differently}
4312
4313 *'lispwords'* *'lw'*
4314'lispwords' 'lw' string (default is very long)
4315 global
4316 {not in Vi}
4317 {not available when compiled without the |+lispindent|
4318 feature}
4319 Comma separated list of words that influence the Lisp indenting.
4320 |'lisp'|
4321
4322 *'list'* *'nolist'*
4323'list' boolean (default off)
4324 local to window
4325 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4326 see the difference between tabs and spaces and for trailing blanks.
4327 Note that this will also affect formatting (set with 'textwidth' or
4328 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4329 changing the way tabs are displayed.
4330
4331 *'listchars'* *'lcs'*
4332'listchars' 'lcs' string (default "eol:$")
4333 global
4334 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004335 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 settings.
4337 eol:c Character to show at the end of each line. When
4338 omitted, there is no extra character at the end of the
4339 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004340 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004342 fill the space that the tab normally occupies.
4343 "tab:>-" will show a tab that takes four spaces as
4344 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004345 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346 trailing spaces are blank.
4347 extends:c Character to show in the last column, when 'wrap' is
4348 off and the line continues beyond the right of the
4349 screen.
4350 precedes:c Character to show in the first column, when 'wrap'
4351 is off and there is text preceding the character
4352 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004353 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004354 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004356 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004357 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004358 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359
4360 Examples: >
4361 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004362 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004363 :set lcs=extends:>,precedes:<
4364< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004365 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004366 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367
4368 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4369'loadplugins' 'lpl' boolean (default on)
4370 global
4371 {not in Vi}
4372 When on the plugin scripts are loaded when starting up |load-plugins|.
4373 This option can be reset in your |vimrc| file to disable the loading
4374 of plugins.
4375 Note that using the "-u NONE" and "--noplugin" command line arguments
4376 reset this option. |-u| |--noplugin|
4377
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004378 *'macatsui'* *'nomacatsui'*
4379'macatsui' boolean (default on)
4380 global
4381 {only available in Mac GUI version}
4382 This is a workaround for when drawing doesn't work properly. When set
4383 and compiled with multi-byte support ATSUI text drawing is used. When
4384 not set ATSUI text drawing is not used. Switch this option off when
4385 you experience drawing problems. In a future version the problems may
4386 be solved and this option becomes obsolete. Therefore use this method
4387 to unset it: >
4388 if exists('&macatsui')
4389 set nomacatsui
4390 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004391< Another option to check if you have drawing problems is
4392 'termencoding'.
4393
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 *'magic'* *'nomagic'*
4395'magic' boolean (default on)
4396 global
4397 Changes the special characters that can be used in search patterns.
4398 See |pattern|.
4399 NOTE: To avoid portability problems with using patterns, always keep
4400 this option at the default "on". Only switch it off when working with
4401 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004402 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403
4404 *'makeef'* *'mef'*
4405'makeef' 'mef' string (default: "")
4406 global
4407 {not in Vi}
4408 {not available when compiled without the |+quickfix|
4409 feature}
4410 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4411 and the |:grep| command.
4412 When it is empty, an internally generated temp file will be used.
4413 When "##" is included, it is replaced by a number to make the name
4414 unique. This makes sure that the ":make" command doesn't overwrite an
4415 existing file.
4416 NOT used for the ":cf" command. See 'errorfile' for that.
4417 Environment variables are expanded |:set_env|.
4418 See |option-backslash| about including spaces and backslashes.
4419 This option cannot be set from a |modeline| or in the |sandbox|, for
4420 security reasons.
4421
4422 *'makeprg'* *'mp'*
4423'makeprg' 'mp' string (default "make", VMS: "MMS")
4424 global or local to buffer |global-local|
4425 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004426 Program to use for the ":make" command. See |:make_makeprg|.
4427 This option may contain '%' and '#' characters, which are expanded to
4428 the current and alternate file name. |:_%| |:_#|
4429 Environment variables are expanded |:set_env|. See |option-backslash|
4430 about including spaces and backslashes.
4431 Note that a '|' must be escaped twice: once for ":set" and once for
4432 the interpretation of a command. When you use a filter called
4433 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 :set makeprg=gmake\ \\\|\ myfilter
4435< The placeholder "$*" can be given (even multiple times) to specify
4436 where the arguments will be included, for example: >
4437 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4438< This option cannot be set from a |modeline| or in the |sandbox|, for
4439 security reasons.
4440
4441 *'matchpairs'* *'mps'*
4442'matchpairs' 'mps' string (default "(:),{:},[:]")
4443 local to buffer
4444 {not in Vi}
4445 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004446 other. Currently only single byte character pairs are allowed, and
4447 they must be different. The characters must be separated by a colon.
4448 The pairs must be separated by a comma. Example for including '<' and
4449 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 :set mps+=<:>
4451
4452< A more exotic example, to jump between the '=' and ';' in an
4453 assignment, useful for languages like C and Java: >
4454 :au FileType c,cpp,java set mps+==:;
4455
4456< For a more advanced way of using "%", see the matchit.vim plugin in
4457 the $VIMRUNTIME/macros directory. |add-local-help|
4458
4459 *'matchtime'* *'mat'*
4460'matchtime' 'mat' number (default 5)
4461 global
4462 {not in Vi}{in Nvi}
4463 Tenths of a second to show the matching paren, when 'showmatch' is
4464 set. Note that this is not in milliseconds, like other options that
4465 set a time. This is to be compatible with Nvi.
4466
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004467 *'maxcombine'* *'mco'*
4468'maxcombine' 'mco' number (default 2)
4469 global
4470 {not in Vi}
4471 {only available when compiled with the |+multi_byte|
4472 feature}
4473 The maximum number of combining characters supported for displaying.
4474 Only used when 'encoding' is "utf-8".
4475 The default is OK for most languages. Hebrew may require 4.
4476 Maximum value is 6.
4477 Even when this option is set to 2 you can still edit text with more
4478 combining characters, you just can't see them. Use |g8| or |ga|.
4479 See |mbyte-combining|.
4480
Bram Moolenaar071d4272004-06-13 20:20:40 +00004481 *'maxfuncdepth'* *'mfd'*
4482'maxfuncdepth' 'mfd' number (default 100)
4483 global
4484 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004485 {not available when compiled without the +eval
4486 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 Maximum depth of function calls for user functions. This normally
4488 catches endless recursion. When using a recursive function with
4489 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4490 more memory, there is the danger of failing when memory is exhausted.
4491 See also |:function|.
4492
4493 *'maxmapdepth'* *'mmd'* *E223*
4494'maxmapdepth' 'mmd' number (default 1000)
4495 global
4496 {not in Vi}
4497 Maximum number of times a mapping is done without resulting in a
4498 character to be used. This normally catches endless mappings, like
4499 ":map x y" with ":map y x". It still does not catch ":map g wg",
4500 because the 'w' is used before the next mapping is done. See also
4501 |key-mapping|.
4502
4503 *'maxmem'* *'mm'*
4504'maxmem' 'mm' number (default between 256 to 5120 (system
4505 dependent) or half the amount of memory
4506 available)
4507 global
4508 {not in Vi}
4509 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4510 limit is reached allocating extra memory for a buffer will cause
4511 other memory to be freed. Maximum value 2000000. Use this to work
4512 without a limit. Also see 'maxmemtot'.
4513
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004514 *'maxmempattern'* *'mmp'*
4515'maxmempattern' 'mmp' number (default 1000)
4516 global
4517 {not in Vi}
4518 Maximum amount of memory (in Kbyte) to use for pattern matching.
4519 Maximum value 2000000. Use this to work without a limit.
4520 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004521 When Vim runs into the limit it gives an error message and mostly
4522 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004523 Running into the limit often means that the pattern is very
4524 inefficient or too complex. This may already happen with the pattern
4525 "\(.\)*" on a very long line. ".*" works much better.
4526 Vim may run out of memory before hitting the 'maxmempattern' limit.
4527
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 *'maxmemtot'* *'mmt'*
4529'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4530 dependent) or half the amount of memory
4531 available)
4532 global
4533 {not in Vi}
4534 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004535 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 'maxmem'.
4537
4538 *'menuitems'* *'mis'*
4539'menuitems' 'mis' number (default 25)
4540 global
4541 {not in Vi}
4542 {not available when compiled without the |+menu|
4543 feature}
4544 Maximum number of items to use in a menu. Used for menus that are
4545 generated from a list of items, e.g., the Buffers menu. Changing this
4546 option has no direct effect, the menu must be refreshed first.
4547
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004548 *'mkspellmem'* *'msm'*
4549'mkspellmem' 'msm' string (default "460000,2000,500")
4550 global
4551 {not in Vi}
4552 {not available when compiled without the |+syntax|
4553 feature}
4554 Parameters for |:mkspell|. This tunes when to start compressing the
4555 word tree. Compression can be slow when there are many words, but
4556 it's needed to avoid running out of memory. The amount of memory used
4557 per word depends very much on how similar the words are, that's why
4558 this tuning is complicated.
4559
4560 There are three numbers, separated by commas:
4561 {start},{inc},{added}
4562
4563 For most languages the uncompressed word tree fits in memory. {start}
4564 gives the amount of memory in Kbyte that can be used before any
4565 compression is done. It should be a bit smaller than the amount of
4566 memory that is available to Vim.
4567
4568 When going over the {start} limit the {inc} number specifies the
4569 amount of memory in Kbyte that can be allocated before another
4570 compression is done. A low number means compression is done after
4571 less words are added, which is slow. A high number means more memory
4572 will be allocated.
4573
4574 After doing compression, {added} times 1024 words can be added before
4575 the {inc} limit is ignored and compression is done when any extra
4576 amount of memory is needed. A low number means there is a smaller
4577 chance of hitting the {inc} limit, less memory is used but it's
4578 slower.
4579
4580 The languages for which these numbers are important are Italian and
4581 Hungarian. The default works for when you have about 512 Mbyte. If
4582 you have 1 Gbyte you could use: >
4583 :set mkspellmem=900000,3000,800
4584< If you have less than 512 Mbyte |:mkspell| may fail for some
4585 languages, no matter what you set 'mkspellmem' to.
4586
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004588'modeline' 'ml' boolean (Vim default: on (off for root),
4589 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 local to buffer
4591 *'modelines'* *'mls'*
4592'modelines' 'mls' number (default 5)
4593 global
4594 {not in Vi}
4595 If 'modeline' is on 'modelines' gives the number of lines that is
4596 checked for set commands. If 'modeline' is off or 'modelines' is zero
4597 no lines are checked. See |modeline|.
4598 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4599 set and to the Vim default value when 'compatible' is reset.
4600
4601 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4602'modifiable' 'ma' boolean (default on)
4603 local to buffer
4604 {not in Vi} *E21*
4605 When off the buffer contents cannot be changed. The 'fileformat' and
4606 'fileencoding' options also can't be changed.
4607 Can be reset with the |-M| command line argument.
4608
4609 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4610'modified' 'mod' boolean (default off)
4611 local to buffer
4612 {not in Vi}
4613 When on, the buffer is considered to be modified. This option is set
4614 when:
4615 1. A change was made to the text since it was last written. Using the
4616 |undo| command to go back to the original text will reset the
4617 option. But undoing changes that were made before writing the
4618 buffer will set the option again, since the text is different from
4619 when it was written.
4620 2. 'fileformat' or 'fileencoding' is different from its original
4621 value. The original value is set when the buffer is read or
4622 written. A ":set nomodified" command also resets the original
4623 values to the current values and the 'modified' option will be
4624 reset.
4625 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4626 will be ignored.
4627
4628 *'more'* *'nomore'*
4629'more' boolean (Vim default: on, Vi default: off)
4630 global
4631 {not in Vi}
4632 When on, listings pause when the whole screen is filled. You will get
4633 the |more-prompt|. When this option is off there are no pauses, the
4634 listing continues until finished.
4635 NOTE: This option is set to the Vi default value when 'compatible' is
4636 set and to the Vim default value when 'compatible' is reset.
4637
4638 *'mouse'* *E538*
4639'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4640 global
4641 {not in Vi}
4642 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004643 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4644 sysmouse and Linux console with gpm). For using the mouse in the
4645 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004646 The mouse can be enabled for different modes:
4647 n Normal mode
4648 v Visual mode
4649 i Insert mode
4650 c Command-line mode
4651 h all previous modes when editing a help file
4652 a all previous modes
4653 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004654 Normally you would enable the mouse in all four modes with: >
4655 :set mouse=a
4656< When the mouse is not enabled, the GUI will still use the mouse for
4657 modeless selection. This doesn't move the text cursor.
4658
4659 See |mouse-using|. Also see |'clipboard'|.
4660
4661 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004662 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 the mouse buttons can still be used by keeping the shift key pressed.
4664 Also see the 'clipboard' option.
4665
4666 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4667'mousefocus' 'mousef' boolean (default off)
4668 global
4669 {not in Vi}
4670 {only works in the GUI}
4671 The window that the mouse pointer is on is automatically activated.
4672 When changing the window layout or window focus in another way, the
4673 mouse pointer is moved to the window with keyboard focus. Off is the
4674 default because it makes using the pull down menus a little goofy, as
4675 a pointer transit may activate a window unintentionally.
4676
4677 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4678'mousehide' 'mh' boolean (default on)
4679 global
4680 {not in Vi}
4681 {only works in the GUI}
4682 When on, the mouse pointer is hidden when characters are typed.
4683 The mouse pointer is restored when the mouse is moved.
4684
4685 *'mousemodel'* *'mousem'*
4686'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4687 global
4688 {not in Vi}
4689 Sets the model to use for the mouse. The name mostly specifies what
4690 the right mouse button is used for:
4691 extend Right mouse button extends a selection. This works
4692 like in an xterm.
4693 popup Right mouse button pops up a menu. The shifted left
4694 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004695 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 popup_setpos Like "popup", but the cursor will be moved to the
4697 position where the mouse was clicked, and thus the
4698 selected operation will act upon the clicked object.
4699 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004700 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 course, that right clicking outside a selection will
4702 end Visual mode.
4703 Overview of what button does what for each model:
4704 mouse extend popup(_setpos) ~
4705 left click place cursor place cursor
4706 left drag start selection start selection
4707 shift-left search word extend selection
4708 right click extend selection popup menu (place cursor)
4709 right drag extend selection -
4710 middle click paste paste
4711
4712 In the "popup" model the right mouse button produces a pop-up menu.
4713 You need to define this first, see |popup-menu|.
4714
4715 Note that you can further refine the meaning of buttons with mappings.
4716 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4717 selection (because that's handled in the GUI code directly).
4718
4719 The 'mousemodel' option is set by the |:behave| command.
4720
4721 *'mouseshape'* *'mouses'* *E547*
4722'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004723 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 global
4725 {not in Vi}
4726 {only available when compiled with the |+mouseshape|
4727 feature}
4728 This option tells Vim what the mouse pointer should look like in
4729 different modes. The option is a comma separated list of parts, much
4730 like used for 'guicursor'. Each part consist of a mode/location-list
4731 and an argument-list:
4732 mode-list:shape,mode-list:shape,..
4733 The mode-list is a dash separated list of these modes/locations:
4734 In a normal window: ~
4735 n Normal mode
4736 v Visual mode
4737 ve Visual mode with 'selection' "exclusive" (same as 'v',
4738 if not specified)
4739 o Operator-pending mode
4740 i Insert mode
4741 r Replace mode
4742
4743 Others: ~
4744 c appending to the command-line
4745 ci inserting in the command-line
4746 cr replacing in the command-line
4747 m at the 'Hit ENTER' or 'More' prompts
4748 ml idem, but cursor in the last line
4749 e any mode, pointer below last window
4750 s any mode, pointer on a status line
4751 sd any mode, while dragging a status line
4752 vs any mode, pointer on a vertical separator line
4753 vd any mode, while dragging a vertical separator line
4754 a everywhere
4755
4756 The shape is one of the following:
4757 avail name looks like ~
4758 w x arrow Normal mouse pointer
4759 w x blank no pointer at all (use with care!)
4760 w x beam I-beam
4761 w x updown up-down sizing arrows
4762 w x leftright left-right sizing arrows
4763 w x busy The system's usual busy pointer
4764 w x no The system's usual 'no input' pointer
4765 x udsizing indicates up-down resizing
4766 x lrsizing indicates left-right resizing
4767 x crosshair like a big thin +
4768 x hand1 black hand
4769 x hand2 white hand
4770 x pencil what you write with
4771 x question big ?
4772 x rightup-arrow arrow pointing right-up
4773 w x up-arrow arrow pointing up
4774 x <number> any X11 pointer number (see X11/cursorfont.h)
4775
4776 The "avail" column contains a 'w' if the shape is available for Win32,
4777 x for X11.
4778 Any modes not specified or shapes not available use the normal mouse
4779 pointer.
4780
4781 Example: >
4782 :set mouseshape=s:udsizing,m:no
4783< will make the mouse turn to a sizing arrow over the status lines and
4784 indicate no input when the hit-enter prompt is displayed (since
4785 clicking the mouse has no effect in this state.)
4786
4787 *'mousetime'* *'mouset'*
4788'mousetime' 'mouset' number (default 500)
4789 global
4790 {not in Vi}
4791 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4792 time in msec between two mouse clicks for the second click to be
4793 recognized as a multi click.
4794
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004795 *'mzquantum'* *'mzq'*
4796'mzquantum' 'mzq' number (default 100)
4797 global
4798 {not in Vi}
4799 {not available when compiled without the |+mzscheme|
4800 feature}
4801 The number of milliseconds between polls for MzScheme threads.
4802 Negative or zero value means no thread scheduling.
4803
Bram Moolenaar071d4272004-06-13 20:20:40 +00004804 *'nrformats'* *'nf'*
4805'nrformats' 'nf' string (default "octal,hex")
4806 local to buffer
4807 {not in Vi}
4808 This defines what bases Vim will consider for numbers when using the
4809 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4810 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004811 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004812 incremented or decremented. This is useful for a list with a
4813 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004814 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004815 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004816 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004817 considered to be hexadecimal. Example: Using CTRL-X on
4818 "0x100" results in "0x0ff".
4819 Numbers which simply begin with a digit in the range 1-9 are always
4820 considered decimal. This also happens for numbers that are not
4821 recognized as octal or hex.
4822
4823 *'number'* *'nu'* *'nonumber'* *'nonu'*
4824'number' 'nu' boolean (default off)
4825 local to window
4826 Print the line number in front of each line. When the 'n' option is
4827 excluded from 'cpoptions' a wrapped line will not use the column of
4828 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004829 The 'numberwidth' option can be used to set the room used for the line
4830 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004831 When a long, wrapped line doesn't start with the first character, '-'
4832 characters are put before the number.
4833 See |hl-LineNr| for the highlighting used for the number.
4834
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004835 *'numberwidth'* *'nuw'*
4836'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4837 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004838 {not in Vi}
4839 {only available when compiled with the |+linebreak|
4840 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004841 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004842 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004843 Since one space is always between the number and the text, there is
4844 one less character for the number itself.
4845 The value is the minimum width. A bigger width is used when needed to
4846 fit the highest line number in the buffer. Thus with the Vim default
4847 of 4 there is room for a line number up to 999. When the buffer has
4848 1000 lines five columns will be used.
4849 The minimum value is 1, the maximum value is 10.
4850 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4851
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004852 *'omnifunc'* *'ofu'*
4853'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004854 local to buffer
4855 {not in Vi}
4856 {not available when compiled without the +eval
4857 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004858 This option specifies a function to be used for Insert mode omni
4859 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004860 See |complete-functions| for an explanation of how the function is
4861 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004862 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004863 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004864
4865
Bram Moolenaar02467872007-05-06 13:22:01 +00004866 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004867'opendevice' 'odev' boolean (default off)
4868 global
4869 {not in Vi}
4870 {only for MS-DOS, MS-Windows and OS/2}
4871 Enable reading and writing from devices. This may get Vim stuck on a
4872 device that can be opened but doesn't actually do the I/O. Therefore
4873 it is off by default.
4874 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4875 result in editing a device.
4876
4877
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004878 *'operatorfunc'* *'opfunc'*
4879'operatorfunc' 'opfunc' string (default: empty)
4880 global
4881 {not in Vi}
4882 This option specifies a function to be called by the |g@| operator.
4883 See |:map-operator| for more info and an example.
4884
4885 This option cannot be set from a |modeline| or in the |sandbox|, for
4886 security reasons.
4887
4888
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 *'osfiletype'* *'oft'* *E366*
4890'osfiletype' 'oft' string (RISC-OS default: "Text",
4891 others default: "")
4892 local to buffer
4893 {not in Vi}
4894 {only available when compiled with the |+osfiletype|
4895 feature}
4896 Some operating systems store extra information about files besides
4897 name, datestamp and permissions. This option contains the extra
4898 information, the nature of which will vary between systems.
4899 The value of this option is usually set when the file is loaded, and
4900 use to set the file type when file is written.
4901 It can affect the pattern matching of the automatic commands.
4902 |autocmd-osfiletypes|
4903
4904 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004905'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 global
4907 Specifies the nroff macros that separate paragraphs. These are pairs
4908 of two letters (see |object-motions|).
4909
4910 *'paste'* *'nopaste'*
4911'paste' boolean (default off)
4912 global
4913 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004914 Put Vim in Paste mode. This is useful if you want to cut or copy
4915 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004916 unexpected effects.
4917 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004918 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004919 knows about pasting and will mostly do the right thing without 'paste'
4920 being set. The same is true for a terminal where Vim handles the
4921 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004922 This option is reset when starting the GUI. Thus if you set it in
4923 your .vimrc it will work in a terminal, but not in the GUI. Setting
4924 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4925 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004926 When the 'paste' option is switched on (also when it was already on):
4927 - mapping in Insert mode and Command-line mode is disabled
4928 - abbreviations are disabled
4929 - 'textwidth' is set to 0
4930 - 'wrapmargin' is set to 0
4931 - 'autoindent' is reset
4932 - 'smartindent' is reset
4933 - 'softtabstop' is set to 0
4934 - 'revins' is reset
4935 - 'ruler' is reset
4936 - 'showmatch' is reset
4937 - 'formatoptions' is used like it is empty
4938 These options keep their value, but their effect is disabled:
4939 - 'lisp'
4940 - 'indentexpr'
4941 - 'cindent'
4942 NOTE: When you start editing another file while the 'paste' option is
4943 on, settings from the modelines or autocommands may change the
4944 settings again, causing trouble when pasting text. You might want to
4945 set the 'paste' option again.
4946 When the 'paste' option is reset the mentioned options are restored to
4947 the value before the moment 'paste' was switched from off to on.
4948 Resetting 'paste' before ever setting it does not have any effect.
4949 Since mapping doesn't work while 'paste' is active, you need to use
4950 the 'pastetoggle' option to toggle the 'paste' option with some key.
4951
4952 *'pastetoggle'* *'pt'*
4953'pastetoggle' 'pt' string (default "")
4954 global
4955 {not in Vi}
4956 When non-empty, specifies the key sequence that toggles the 'paste'
4957 option. This is like specifying a mapping: >
4958 :map {keys} :set invpaste<CR>
4959< Where {keys} is the value of 'pastetoggle'.
4960 The difference is that it will work even when 'paste' is set.
4961 'pastetoggle' works in Insert mode and Normal mode, but not in
4962 Command-line mode.
4963 Mappings are checked first, thus overrule 'pastetoggle'. However,
4964 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4965 this: >
4966 :map <F10> :set paste<CR>
4967 :map <F11> :set nopaste<CR>
4968 :imap <F10> <C-O>:set paste<CR>
4969 :imap <F11> <nop>
4970 :set pastetoggle=<F11>
4971< This will make <F10> start paste mode and <F11> stop paste mode.
4972 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4973 mode everything is inserted literally, except the 'pastetoggle' key
4974 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004975 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976
4977 *'pex'* *'patchexpr'*
4978'patchexpr' 'pex' string (default "")
4979 global
4980 {not in Vi}
4981 {not available when compiled without the |+diff|
4982 feature}
4983 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004984 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
4986 *'patchmode'* *'pm'* *E206*
4987'patchmode' 'pm' string (default "")
4988 global
4989 {not in Vi}
4990 When non-empty the oldest version of a file is kept. This can be used
4991 to keep the original version of a file if you are changing files in a
4992 source distribution. Only the first time that a file is written a
4993 copy of the original file will be kept. The name of the copy is the
4994 name of the original file with the string in the 'patchmode' option
4995 appended. This option should start with a dot. Use a string like
4996 ".org". 'backupdir' must not be empty for this to work (Detail: The
4997 backup file is renamed to the patchmode file after the new file has
4998 been successfully written, that's why it must be possible to write a
4999 backup file). If there was no file to be backed up, an empty file is
5000 created.
5001 When the 'backupskip' pattern matches, a patchmode file is not made.
5002 Using 'patchmode' for compressed files appends the extension at the
5003 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5004 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005005 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005006
5007 *'path'* *'pa'* *E343* *E345* *E347*
5008'path' 'pa' string (default on Unix: ".,/usr/include,,"
5009 on OS/2: ".,/emx/include,,"
5010 other systems: ".,,")
5011 global or local to buffer |global-local|
5012 {not in Vi}
5013 This is a list of directories which will be searched when using the
5014 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
5015 being searched for has a relative path (not starting with '/'). The
5016 directories in the 'path' option may be relative or absolute.
5017 - Use commas to separate directory names: >
5018 :set path=.,/usr/local/include,/usr/include
5019< - Spaces can also be used to separate directory names (for backwards
5020 compatibility with version 3.0). To have a space in a directory
5021 name, precede it with an extra backslash, and escape the space: >
5022 :set path=.,/dir/with\\\ space
5023< - To include a comma in a directory name precede it with an extra
5024 backslash: >
5025 :set path=.,/dir/with\\,comma
5026< - To search relative to the directory of the current file, use: >
5027 :set path=.
5028< - To search in the current directory use an empty string between two
5029 commas: >
5030 :set path=,,
5031< - A directory name may end in a ':' or '/'.
5032 - Environment variables are expanded |:set_env|.
5033 - When using |netrw.vim| URLs can be used. For example, adding
5034 "http://www.vim.org" will make ":find index.html" work.
5035 - Search upwards and downwards in a directory tree:
5036 1) "*" matches a sequence of characters, e.g.: >
5037 :set path=/usr/include/*
5038< means all subdirectories in /usr/include (but not /usr/include
5039 itself). >
5040 :set path=/usr/*c
5041< matches /usr/doc and /usr/src.
5042 2) "**" matches a subtree, up to 100 directories deep. Example: >
5043 :set path=/home/user_x/src/**
5044< means search in the whole subtree under "/home/usr_x/src".
5045 3) If the path ends with a ';', this path is the startpoint
5046 for upward search.
5047 See |file-searching| for more info and exact syntax.
5048 {not available when compiled without the |+path_extra| feature}
5049 - Careful with '\' characters, type two to get one in the option: >
5050 :set path=.,c:\\include
5051< Or just use '/' instead: >
5052 :set path=.,c:/include
5053< Don't forget "." or files won't even be found in the same directory as
5054 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005055 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056 it is something like 256 or 1024 characters.
5057 You can check if all the include files are found, using the value of
5058 'path', see |:checkpath|.
5059 The use of |:set+=| and |:set-=| is preferred when adding or removing
5060 directories from the list. This avoids problems when a future version
5061 uses another default. To remove the current directory use: >
5062 :set path-=
5063< To add the current directory use: >
5064 :set path+=
5065< To use an environment variable, you probably need to replace the
5066 separator. Here is an example to append $INCL, in which directory
5067 names are separated with a semi-colon: >
5068 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5069< Replace the ';' with a ':' or whatever separator is used. Note that
5070 this doesn't work when $INCL contains a comma or white space.
5071
5072 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5073'preserveindent' 'pi' boolean (default off)
5074 local to buffer
5075 {not in Vi}
5076 When changing the indent of the current line, preserve as much of the
5077 indent structure as possible. Normally the indent is replaced by a
5078 series of tabs followed by spaces as required (unless |'expandtab'| is
5079 enabled, in which case only spaces are used). Enabling this option
5080 means the indent will preserve as many existing characters as possible
5081 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005082 'expandtab' does not apply to the preserved white space, a Tab remains
5083 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005084 NOTE: When using ">>" multiple times the resulting indent is a mix of
5085 tabs and spaces. You might not like this.
5086 NOTE: 'preserveindent' is reset when 'compatible' is set.
5087 Also see 'copyindent'.
5088 Use |:retab| to clean up white space.
5089
5090 *'previewheight'* *'pvh'*
5091'previewheight' 'pvh' number (default 12)
5092 global
5093 {not in Vi}
5094 {not available when compiled without the |+windows| or
5095 |+quickfix| feature}
5096 Default height for a preview window. Used for |:ptag| and associated
5097 commands. Used for |CTRL-W_}| when no count is given.
5098
5099 *'previewwindow'* *'nopreviewwindow'*
5100 *'pvw'* *'nopvw'* *E590*
5101'previewwindow' 'pvw' boolean (default off)
5102 local to window
5103 {not in Vi}
5104 {not available when compiled without the |+windows| or
5105 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005106 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 set. It's normally not set directly, but by using one of the commands
5108 |:ptag|, |:pedit|, etc.
5109
5110 *'printdevice'* *'pdev'*
5111'printdevice' 'pdev' string (default empty)
5112 global
5113 {not in Vi}
5114 {only available when compiled with the |+printer|
5115 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005116 The name of the printer to be used for |:hardcopy|.
5117 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005118 This option cannot be set from a |modeline| or in the |sandbox|, for
5119 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120
Bram Moolenaar8299df92004-07-10 09:47:34 +00005121 *'printencoding'* *'penc'*
5122'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 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 Sets the character encoding used when printing.
5128 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129
5130 *'printexpr'* *'pexpr'*
5131'printexpr' 'pexpr' String (default: see below)
5132 global
5133 {not in Vi}
5134 {only available when compiled with the |+printer|
5135 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005136 Expression used to print the PostScript produced with |:hardcopy|.
5137 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138
Bram Moolenaar8299df92004-07-10 09:47:34 +00005139 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140'printfont' 'pfn' string (default "courier")
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 name of the font that will be used for |:hardcopy|.
5146 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005147
5148 *'printheader'* *'pheader'*
5149'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5150 global
5151 {not in Vi}
5152 {only available when compiled with the |+printer|
5153 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005154 The format of the header produced in |:hardcopy| output.
5155 See |pheader-option|.
5156
5157 *'printmbcharset'* *'pmbcs'*
5158'printmbcharset' 'pmbcs' 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 The CJK character set to be used for CJK output from |:hardcopy|.
5164 See |pmbcs-option|.
5165
5166 *'printmbfont'* *'pmbfn'*
5167'printmbfont' 'pmbfn' string (default "")
5168 global
5169 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005170 {only available when compiled with the |+printer|,
5171 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005172 List of font names to be used for CJK output from |:hardcopy|.
5173 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174
5175 *'printoptions'* *'popt'*
5176'printoptions' 'popt' string (default "")
5177 global
5178 {not in Vi}
5179 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005180 List of items that control the format of the output of |:hardcopy|.
5181 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005183 *'prompt'* *'noprompt'*
5184'prompt' boolean (default on)
5185 global
5186 When on a ":" prompt is used in Ex mode.
5187
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005188 *'pumheight'* *'ph'*
5189'pumheight' 'ph' number (default 0)
5190 global
5191 {not available when compiled without the
5192 |+insert_expand| feature}
5193 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005194 Determines the maximum number of items to show in the popup menu for
5195 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005196 |ins-completion-menu|.
5197
5198
Bram Moolenaar677ee682005-01-27 14:41:15 +00005199 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005200'quoteescape' 'qe' string (default "\")
5201 local to buffer
5202 {not in Vi}
5203 The characters that are used to escape quotes in a string. Used for
5204 objects like a', a" and a` |a'|.
5205 When one of the characters in this option is found inside a string,
5206 the following character will be skipped. The default value makes the
5207 text "foo\"bar\\" considered to be one string.
5208
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5210'readonly' 'ro' boolean (default off)
5211 local to buffer
5212 If on, writes fail unless you use a '!'. Protects you from
5213 accidentally overwriting a file. Default on when Vim is started
5214 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005215 When using ":w!" the 'readonly' option is reset for the current
5216 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005218 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005220 *'redrawtime'* *'rdt'*
5221'redrawtime' 'rdt' number (default 2000)
5222 global
5223 {not in Vi}
5224 {only available when compiled with the |+reltime|
5225 feature}
5226 The time in milliseconds for redrawing the display. This applies to
5227 searching for patterns for 'hlsearch' and |:match| highlighting.
5228 When redrawing takes more than this many milliseconds no further
5229 matches will be highlighted. This is used to avoid that Vim hangs
5230 when using a very complicated pattern.
5231
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 *'remap'* *'noremap'*
5233'remap' boolean (default on)
5234 global
5235 Allows for mappings to work recursively. If you do not want this for
5236 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005237 NOTE: To avoid portability problems with Vim scripts, always keep
5238 this option at the default "on". Only switch it off when working with
5239 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240
5241 *'report'*
5242'report' number (default 2)
5243 global
5244 Threshold for reporting number of lines changed. When the number of
5245 changed lines is more than 'report' a message will be given for most
5246 ":" commands. If you want it always, set 'report' to 0.
5247 For the ":substitute" command the number of substitutions is used
5248 instead of the number of lines.
5249
5250 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5251'restorescreen' 'rs' boolean (default on)
5252 global
5253 {not in Vi} {only in Windows 95/NT console version}
5254 When set, the screen contents is restored when exiting Vim. This also
5255 happens when executing external commands.
5256
5257 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5258 options in your .vimrc. To disable restoring:
5259 set t_ti= t_te=
5260 To enable restoring (for an xterm):
5261 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5262 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5263
5264 *'revins'* *'ri'* *'norevins'* *'nori'*
5265'revins' 'ri' boolean (default off)
5266 global
5267 {not in Vi}
5268 {only available when compiled with the |+rightleft|
5269 feature}
5270 Inserting characters in Insert mode will work backwards. See "typing
5271 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5272 command in Insert mode, when 'allowrevins' is set.
5273 NOTE: This option is reset when 'compatible' or 'paste' is set.
5274
5275 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5276'rightleft' 'rl' boolean (default off)
5277 local to window
5278 {not in Vi}
5279 {only available when compiled with the |+rightleft|
5280 feature}
5281 When on, display orientation becomes right-to-left, i.e., characters
5282 that are stored in the file appear from the right to the left.
5283 Using this option, it is possible to edit files for languages that
5284 are written from the right to the left such as Hebrew and Arabic.
5285 This option is per window, so it is possible to edit mixed files
5286 simultaneously, or to view the same file in both ways (this is
5287 useful whenever you have a mixed text file with both right-to-left
5288 and left-to-right strings so that both sets are displayed properly
5289 in different windows). Also see |rileft.txt|.
5290
5291 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5292'rightleftcmd' 'rlc' string (default "search")
5293 local to window
5294 {not in Vi}
5295 {only available when compiled with the |+rightleft|
5296 feature}
5297 Each word in this option enables the command line editing to work in
5298 right-to-left mode for a group of commands:
5299
5300 search "/" and "?" commands
5301
5302 This is useful for languages such as Hebrew, Arabic and Farsi.
5303 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5304
5305 *'ruler'* *'ru'* *'noruler'* *'noru'*
5306'ruler' 'ru' boolean (default off)
5307 global
5308 {not in Vi}
5309 {not available when compiled without the
5310 |+cmdline_info| feature}
5311 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005312 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313 text in the file is shown on the far right:
5314 Top first line is visible
5315 Bot last line is visible
5316 All first and last line are visible
5317 45% relative position in the file
5318 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005319 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005321 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322 this option takes precedence over 'ruler' and 'rulerformat'
5323 If the number of characters displayed is different from the number of
5324 bytes in the text (e.g., for a TAB or a multi-byte character), both
5325 the text column (byte number) and the screen column are shown,
5326 separated with a dash.
5327 For an empty line "0-1" is shown.
5328 For an empty buffer the line number will also be zero: "0,0-1".
5329 This option is reset when the 'paste' option is set.
5330 If you don't want to see the ruler all the time but want to know where
5331 you are, use "g CTRL-G" |g_CTRL-G|.
5332 NOTE: This option is reset when 'compatible' is set.
5333
5334 *'rulerformat'* *'ruf'*
5335'rulerformat' 'ruf' string (default empty)
5336 global
5337 {not in Vi}
5338 {not available when compiled without the |+statusline|
5339 feature}
5340 When this option is not empty, it determines the content of the ruler
5341 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005342 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005343 The default ruler width is 17 characters. To make the ruler 15
5344 characters wide, put "%15(" at the start and "%)" at the end.
5345 Example: >
5346 :set rulerformat=%15(%c%V\ %p%%%)
5347<
5348 *'runtimepath'* *'rtp'* *vimfiles*
5349'runtimepath' 'rtp' string (default:
5350 Unix: "$HOME/.vim,
5351 $VIM/vimfiles,
5352 $VIMRUNTIME,
5353 $VIM/vimfiles/after,
5354 $HOME/.vim/after"
5355 Amiga: "home:vimfiles,
5356 $VIM/vimfiles,
5357 $VIMRUNTIME,
5358 $VIM/vimfiles/after,
5359 home:vimfiles/after"
5360 PC, OS/2: "$HOME/vimfiles,
5361 $VIM/vimfiles,
5362 $VIMRUNTIME,
5363 $VIM/vimfiles/after,
5364 $HOME/vimfiles/after"
5365 Macintosh: "$VIM:vimfiles,
5366 $VIMRUNTIME,
5367 $VIM:vimfiles:after"
5368 RISC-OS: "Choices:vimfiles,
5369 $VIMRUNTIME,
5370 Choices:vimfiles/after"
5371 VMS: "sys$login:vimfiles,
5372 $VIM/vimfiles,
5373 $VIMRUNTIME,
5374 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005375 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 global
5377 {not in Vi}
5378 This is a list of directories which will be searched for runtime
5379 files:
5380 filetype.vim filetypes by file name |new-filetype|
5381 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005382 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 colors/ color scheme files |:colorscheme|
5384 compiler/ compiler files |:compiler|
5385 doc/ documentation |write-local-help|
5386 ftplugin/ filetype plugins |write-filetype-plugin|
5387 indent/ indent scripts |indent-expression|
5388 keymap/ key mapping files |mbyte-keymap|
5389 lang/ menu translations |:menutrans|
5390 menu.vim GUI menus |menu.vim|
5391 plugin/ plugin scripts |write-plugin|
5392 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005393 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 syntax/ syntax files |mysyntaxfile|
5395 tutor/ files for vimtutor |tutor|
5396
5397 And any other file searched for with the |:runtime| command.
5398
5399 The defaults for most systems are setup to search five locations:
5400 1. In your home directory, for your personal preferences.
5401 2. In a system-wide Vim directory, for preferences from the system
5402 administrator.
5403 3. In $VIMRUNTIME, for files distributed with Vim.
5404 *after-directory*
5405 4. In the "after" directory in the system-wide Vim directory. This is
5406 for the system administrator to overrule or add to the distributed
5407 defaults (rarely needed)
5408 5. In the "after" directory in your home directory. This is for
5409 personal preferences to overrule or add to the distributed defaults
5410 or system-wide settings (rarely needed).
5411
5412 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5413 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005414 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 wildcards.
5416 See |:runtime|.
5417 Example: >
5418 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5419< This will use the directory "~/vimruntime" first (containing your
5420 personal Vim runtime files), then "/mygroup/vim" (shared between a
5421 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5422 files).
5423 You probably should always include $VIMRUNTIME somewhere, to use the
5424 distributed runtime files. You can put a directory before $VIMRUNTIME
5425 to find files which replace a distributed runtime files. You can put
5426 a directory after $VIMRUNTIME to find files which add to distributed
5427 runtime files.
5428 This option cannot be set from a |modeline| or in the |sandbox|, for
5429 security reasons.
5430
5431 *'scroll'* *'scr'*
5432'scroll' 'scr' number (default: half the window height)
5433 local to window
5434 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5435 set to half the number of lines in the window when the window size
5436 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005437 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005438 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5439 the number of screen lines instead of file lines, makes a difference
5440 when lines wrap}
5441
5442 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5443'scrollbind' 'scb' boolean (default off)
5444 local to window
5445 {not in Vi}
5446 {not available when compiled without the |+scrollbind|
5447 feature}
5448 See also |scroll-binding|. When this option is set, the current
5449 window scrolls as other scrollbind windows (windows that also have
5450 this option set) scroll. This option is useful for viewing the
5451 differences between two versions of a file, see 'diff'.
5452 See |'scrollopt'| for options that determine how this option should be
5453 interpreted.
5454 This option is mostly reset when splitting a window to edit another
5455 file. This means that ":split | edit file" results in two windows
5456 with scroll-binding, but ":split file" does not.
5457
5458 *'scrolljump'* *'sj'*
5459'scrolljump' 'sj' number (default 1)
5460 global
5461 {not in Vi}
5462 Minimal number of lines to scroll when the cursor gets off the
5463 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5464 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005465 When set to a negative number from -1 to -100 this is used as the
5466 percentage of the window height. Thus -50 scrolls half the window
5467 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 NOTE: This option is set to 1 when 'compatible' is set.
5469
5470 *'scrolloff'* *'so'*
5471'scrolloff' 'so' number (default 0)
5472 global
5473 {not in Vi}
5474 Minimal number of screen lines to keep above and below the cursor.
5475 This will make some context visible around where you are working. If
5476 you set it to a very large value (999) the cursor line will always be
5477 in the middle of the window (except at the start or end of the file or
5478 when long lines wrap).
5479 For scrolling horizontally see 'sidescrolloff'.
5480 NOTE: This option is set to 0 when 'compatible' is set.
5481
5482 *'scrollopt'* *'sbo'*
5483'scrollopt' 'sbo' string (default "ver,jump")
5484 global
5485 {not available when compiled without the |+scrollbind|
5486 feature}
5487 {not in Vi}
5488 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005489 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5490 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 The following words are available:
5492 ver Bind vertical scrolling for 'scrollbind' windows
5493 hor Bind horizontal scrolling for 'scrollbind' windows
5494 jump Applies to the offset between two windows for vertical
5495 scrolling. This offset is the difference in the first
5496 displayed line of the bound windows. When moving
5497 around in a window, another 'scrollbind' window may
5498 reach a position before the start or after the end of
5499 the buffer. The offset is not changed though, when
5500 moving back the 'scrollbind' window will try to scroll
5501 to the desired position when possible.
5502 When now making that window the current one, two
5503 things can be done with the relative offset:
5504 1. When "jump" is not included, the relative offset is
5505 adjusted for the scroll position in the new current
5506 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005507 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005508 2. When "jump" is included, the other windows are
5509 scrolled to keep the same relative offset. When
5510 going back to the other window, it still uses the
5511 same relative offset.
5512 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005513 When 'diff' mode is active there always is vertical scroll binding,
5514 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515
5516 *'sections'* *'sect'*
5517'sections' 'sect' string (default "SHNHH HUnhsh")
5518 global
5519 Specifies the nroff macros that separate sections. These are pairs of
5520 two letters (See |object-motions|). The default makes a section start
5521 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5522
5523 *'secure'* *'nosecure'* *E523*
5524'secure' boolean (default off)
5525 global
5526 {not in Vi}
5527 When on, ":autocmd", shell and write commands are not allowed in
5528 ".vimrc" and ".exrc" in the current directory and map commands are
5529 displayed. Switch it off only if you know that you will not run into
5530 problems, or when the 'exrc' option is off. On Unix this option is
5531 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005532 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005533 'secure' at the end of your ~/.vimrc then.
5534 This option cannot be set from a |modeline| or in the |sandbox|, for
5535 security reasons.
5536
5537 *'selection'* *'sel'*
5538'selection' 'sel' string (default "inclusive")
5539 global
5540 {not in Vi}
5541 This option defines the behavior of the selection. It is only used
5542 in Visual and Select mode.
5543 Possible values:
5544 value past line inclusive ~
5545 old no yes
5546 inclusive yes yes
5547 exclusive yes no
5548 "past line" means that the cursor is allowed to be positioned one
5549 character past the line.
5550 "inclusive" means that the last character of the selection is included
5551 in an operation. For example, when "x" is used to delete the
5552 selection.
5553 Note that when "exclusive" is used and selecting from the end
5554 backwards, you cannot include the last character of a line, when
5555 starting in Normal mode and 'virtualedit' empty.
5556
5557 The 'selection' option is set by the |:behave| command.
5558
5559 *'selectmode'* *'slm'*
5560'selectmode' 'slm' string (default "")
5561 global
5562 {not in Vi}
5563 This is a comma separated list of words, which specifies when to start
5564 Select mode instead of Visual mode, when a selection is started.
5565 Possible values:
5566 mouse when using the mouse
5567 key when using shifted special keys
5568 cmd when using "v", "V" or CTRL-V
5569 See |Select-mode|.
5570 The 'selectmode' option is set by the |:behave| command.
5571
5572 *'sessionoptions'* *'ssop'*
5573'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005574 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 global
5576 {not in Vi}
5577 {not available when compiled without the +mksession
5578 feature}
5579 Changes the effect of the |:mksession| command. It is a comma
5580 separated list of words. Each word enables saving and restoring
5581 something:
5582 word save and restore ~
5583 blank empty windows
5584 buffers hidden and unloaded buffers, not just those in windows
5585 curdir the current directory
5586 folds manually created folds, opened/closed folds and local
5587 fold options
5588 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005589 and contain at least one lowercase letter. Only
5590 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 help the help window
5592 localoptions options and mappings local to a window or buffer (not
5593 global values for local options)
5594 options all options and mappings (also global values for local
5595 options)
5596 resize size of the Vim window: 'lines' and 'columns'
5597 sesdir the directory in which the session file is located
5598 will become the current directory (useful with
5599 projects accessed over a network from different
5600 systems)
5601 slash backslashes in file names replaced with forward
5602 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005603 tabpages all tab pages; without this only the current tab page
5604 is restored, so that you can make a session for each
5605 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 unix with Unix end-of-line format (single <NL>), even when
5607 on Windows or DOS
5608 winpos position of the whole Vim window
5609 winsize window sizes
5610
5611 Don't include both "curdir" and "sesdir".
5612 When "curdir" nor "sesdir" is included, file names are stored with
5613 absolute paths.
5614 "slash" and "unix" are useful on Windows when sharing session files
5615 with Unix. The Unix version of Vim cannot source dos format scripts,
5616 but the Windows version of Vim can source unix format scripts.
5617
5618 *'shell'* *'sh'* *E91*
5619'shell' 'sh' string (default $SHELL or "sh",
5620 MS-DOS and Win32: "command.com" or
5621 "cmd.exe", OS/2: "cmd")
5622 global
5623 Name of the shell to use for ! and :! commands. When changing the
5624 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5625 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005626 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 See |option-backslash| about including spaces and backslashes.
5628 Environment variables are expanded |:set_env|.
5629 If the name of the shell contains a space, you might need to enclose
5630 it in quotes. Example: >
5631 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5632< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005633 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005634 "-f" is not inside the quotes, because it is not part of the command
5635 name. And Vim automagically recognizes the backslashes that are path
5636 separators.
5637 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5638 variable to change the way external commands are executed. See the
5639 libc.inf file of DJGPP.
5640 Under MS-Windows, when the executable ends in ".com" it must be
5641 included. Thus setting the shell to "command.com" or "4dos.com"
5642 works, but "command" and "4dos" do not work for all commands (e.g.,
5643 filtering).
5644 For unknown reasons, when using "4dos.com" the current directory is
5645 changed to "C:\". To avoid this set 'shell' like this: >
5646 :set shell=command.com\ /c\ 4dos
5647< This option cannot be set from a |modeline| or in the |sandbox|, for
5648 security reasons.
5649
5650 *'shellcmdflag'* *'shcf'*
5651'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5652 does not contain "sh" somewhere: "/c")
5653 global
5654 {not in Vi}
5655 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5656 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5657 systems, the default is set according to the value of 'shell', to
5658 reduce the need to set this option by the user. It's not used for
5659 OS/2 (EMX figures this out itself). See |option-backslash| about
5660 including spaces and backslashes. See |dos-shell|.
5661 This option cannot be set from a |modeline| or in the |sandbox|, for
5662 security reasons.
5663
5664 *'shellpipe'* *'sp'*
5665'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5666 global
5667 {not in Vi}
5668 {not available when compiled without the |+quickfix|
5669 feature}
5670 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005671 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 including spaces and backslashes.
5673 The name of the temporary file can be represented by "%s" if necessary
5674 (the file name is appended automatically if no %s appears in the value
5675 of this option).
5676 For the Amiga and MS-DOS the default is ">". The output is directly
5677 saved in a file and not echoed to the screen.
5678 For Unix the default it "| tee". The stdout of the compiler is saved
5679 in a file and echoed to the screen. If the 'shell' option is "csh" or
5680 "tcsh" after initializations, the default becomes "|& tee". If the
5681 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5682 "2>&1| tee". This means that stderr is also included.
5683 The initialization of this option is done after reading the ".vimrc"
5684 and the other initializations, so that when the 'shell' option is set
5685 there, the 'shellpipe' option changes automatically, unless it was
5686 explicitly set before.
5687 When 'shellpipe' is set to an empty string, no redirection of the
5688 ":make" output will be done. This is useful if you use a 'makeprg'
5689 that writes to 'makeef' by itself. If you want no piping, but do
5690 want to include the 'makeef', set 'shellpipe' to a single space.
5691 Don't forget to precede the space with a backslash: ":set sp=\ ".
5692 In the future pipes may be used for filtering and this option will
5693 become obsolete (at least for Unix).
5694 This option cannot be set from a |modeline| or in the |sandbox|, for
5695 security reasons.
5696
5697 *'shellquote'* *'shq'*
5698'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5699 contains "sh" somewhere: "\"")
5700 global
5701 {not in Vi}
5702 Quoting character(s), put around the command passed to the shell, for
5703 the "!" and ":!" commands. The redirection is kept outside of the
5704 quoting. See 'shellxquote' to include the redirection. It's
5705 probably not useful to set both options.
5706 This is an empty string by default. Only known to be useful for
5707 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5708 or bash, where it should be "\"". The default is adjusted according
5709 the value of 'shell', to reduce the need to set this option by the
5710 user. See |dos-shell|.
5711 This option cannot be set from a |modeline| or in the |sandbox|, for
5712 security reasons.
5713
5714 *'shellredir'* *'srr'*
5715'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5716 global
5717 {not in Vi}
5718 String to be used to put the output of a filter command in a temporary
5719 file. See also |:!|. See |option-backslash| about including spaces
5720 and backslashes.
5721 The name of the temporary file can be represented by "%s" if necessary
5722 (the file name is appended automatically if no %s appears in the value
5723 of this option).
5724 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5725 or "zsh" during initializations, the default becomes ">&". If the
5726 'shell' option is "sh", "ksh" or "bash" the default becomes
5727 ">%s 2>&1". This means that stderr is also included.
5728 For Win32, the Unix checks are done and additionally "cmd" is checked
5729 for, which makes the default ">%s 2>&1". Also, the same names with
5730 ".exe" appended are checked for.
5731 The initialization of this option is done after reading the ".vimrc"
5732 and the other initializations, so that when the 'shell' option is set
5733 there, the 'shellredir' option changes automatically unless it was
5734 explicitly set before.
5735 In the future pipes may be used for filtering and this option will
5736 become obsolete (at least for Unix).
5737 This option cannot be set from a |modeline| or in the |sandbox|, for
5738 security reasons.
5739
5740 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5741'shellslash' 'ssl' boolean (default off)
5742 global
5743 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5744 When set, a forward slash is used when expanding file names. This is
5745 useful when a Unix-like shell is used instead of command.com or
5746 cmd.exe. Backward slashes can still be typed, but they are changed to
5747 forward slashes by Vim.
5748 Note that setting or resetting this option has no effect for some
5749 existing file names, thus this option needs to be set before opening
5750 any file for best results. This might change in the future.
5751 'shellslash' only works when a backslash can be used as a path
5752 separator. To test if this is so use: >
5753 if exists('+shellslash')
5754<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005755 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5756'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5757 global
5758 {not in Vi}
5759 When on, use temp files for shell commands. When off use a pipe.
5760 When using a pipe is not possible temp files are used anyway.
5761 Currently a pipe is only supported on Unix. You can check it with: >
5762 :if has("filterpipe")
5763< The advantage of using a pipe is that nobody can read the temp file
5764 and the 'shell' command does not need to support redirection.
5765 The advantage of using a temp file is that the file type and encoding
5766 can be detected.
5767 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5768 |FilterWritePost| autocommands event are not triggered when
5769 'shelltemp' is off.
5770
Bram Moolenaar071d4272004-06-13 20:20:40 +00005771 *'shelltype'* *'st'*
5772'shelltype' 'st' number (default 0)
5773 global
5774 {not in Vi} {only for the Amiga}
5775 On the Amiga this option influences the way how the commands work
5776 which use a shell.
5777 0 and 1: always use the shell
5778 2 and 3: use the shell only to filter lines
5779 4 and 5: use shell only for ':sh' command
5780 When not using the shell, the command is executed directly.
5781
5782 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5783 1 and 3: use "shell cmd" to start external commands
5784
5785 *'shellxquote'* *'sxq'*
5786'shellxquote' 'sxq' string (default: "";
5787 for Win32, when 'shell' contains "sh"
5788 somewhere: "\""
5789 for Unix, when using system(): "\"")
5790 global
5791 {not in Vi}
5792 Quoting character(s), put around the command passed to the shell, for
5793 the "!" and ":!" commands. Includes the redirection. See
5794 'shellquote' to exclude the redirection. It's probably not useful
5795 to set both options.
5796 This is an empty string by default. Known to be useful for
5797 third-party shells when using the Win32 version, such as the MKS Korn
5798 Shell or bash, where it should be "\"". The default is adjusted
5799 according the value of 'shell', to reduce the need to set this option
5800 by the user. See |dos-shell|.
5801 This option cannot be set from a |modeline| or in the |sandbox|, for
5802 security reasons.
5803
5804 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5805'shiftround' 'sr' boolean (default off)
5806 global
5807 {not in Vi}
5808 Round indent to multiple of 'shiftwidth'. Applies to > and <
5809 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5810 a multiple of 'shiftwidth' (this is Vi compatible).
5811 NOTE: This option is reset when 'compatible' is set.
5812
5813 *'shiftwidth'* *'sw'*
5814'shiftwidth' 'sw' number (default 8)
5815 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005816 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005817 |'cindent'|, |>>|, |<<|, etc.
5818
5819 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005820'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5821 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005822 global
5823 {not in Vi}
5824 This option helps to avoid all the |hit-enter| prompts caused by file
5825 messages, for example with CTRL-G, and to avoid some other messages.
5826 It is a list of flags:
5827 flag meaning when present ~
5828 f use "(3 of 5)" instead of "(file 3 of 5)"
5829 i use "[noeol]" instead of "[Incomplete last line]"
5830 l use "999L, 888C" instead of "999 lines, 888 characters"
5831 m use "[+]" instead of "[Modified]"
5832 n use "[New]" instead of "[New File]"
5833 r use "[RO]" instead of "[readonly]"
5834 w use "[w]" instead of "written" for file write message
5835 and "[a]" instead of "appended" for ':w >> file' command
5836 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5837 "[unix format]" and "[mac]" instead of "[mac format]".
5838 a all of the above abbreviations
5839
5840 o overwrite message for writing a file with subsequent message
5841 for reading a file (useful for ":wn" or when 'autowrite' on)
5842 O message for reading a file overwrites any previous message.
5843 Also for quickfix message (e.g., ":cn").
5844 s don't give "search hit BOTTOM, continuing at TOP" or "search
5845 hit TOP, continuing at BOTTOM" messages
5846 t truncate file message at the start if it is too long to fit
5847 on the command-line, "<" will appear in the left most column.
5848 Ignored in Ex mode.
5849 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005850 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005851 Ignored in Ex mode.
5852 W don't give "written" or "[w]" when writing a file
5853 A don't give the "ATTENTION" message when an existing swap file
5854 is found.
5855 I don't give the intro message when starting Vim |:intro|.
5856
5857 This gives you the opportunity to avoid that a change between buffers
5858 requires you to hit <Enter>, but still gives as useful a message as
5859 possible for the space available. To get the whole message that you
5860 would have got with 'shm' empty, use ":file!"
5861 Useful values:
5862 shm= No abbreviation of message.
5863 shm=a Abbreviation, but no loss of information.
5864 shm=at Abbreviation, and truncate message when necessary.
5865
5866 NOTE: This option is set to the Vi default value when 'compatible' is
5867 set and to the Vim default value when 'compatible' is reset.
5868
5869 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5870'shortname' 'sn' boolean (default off)
5871 local to buffer
5872 {not in Vi, not in MS-DOS versions}
5873 Filenames are assumed to be 8 characters plus one extension of 3
5874 characters. Multiple dots in file names are not allowed. When this
5875 option is on, dots in file names are replaced with underscores when
5876 adding an extension (".~" or ".swp"). This option is not available
5877 for MS-DOS, because then it would always be on. This option is useful
5878 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5879 or crossdos. When running the Win32 GUI version under Win32s, this
5880 option is always on by default.
5881
5882 *'showbreak'* *'sbr'* *E595*
5883'showbreak' 'sbr' string (default "")
5884 global
5885 {not in Vi}
5886 {not available when compiled without the |+linebreak|
5887 feature}
5888 String to put at the start of lines that have been wrapped. Useful
5889 values are "> " or "+++ ".
5890 Only printable single-cell characters are allowed, excluding <Tab> and
5891 comma (in a future version the comma might be used to separate the
5892 part that is shown at the end and at the start of a line).
5893 The characters are highlighted according to the '@' flag in
5894 'highlight'.
5895 Note that tabs after the showbreak will be displayed differently.
5896 If you want the 'showbreak' to appear in between line numbers, add the
5897 "n" flag to 'cpoptions'.
5898
5899 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5900'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5901 off)
5902 global
5903 {not in Vi}
5904 {not available when compiled without the
5905 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005906 Show (partial) command in the last line of the screen. Set this
5907 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908 In Visual mode the size of the selected area is shown:
5909 - When selecting characters within a line, the number of characters.
5910 - When selecting more than one line, the number of lines.
5911 - When selecting a block, the size in screen characters: linesxcolumns.
5912 NOTE: This option is set to the Vi default value when 'compatible' is
5913 set and to the Vim default value when 'compatible' is reset.
5914
5915 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5916'showfulltag' 'sft' boolean (default off)
5917 global
5918 {not in Vi}
5919 When completing a word in insert mode (see |ins-completion|) from the
5920 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005921 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 matched a C function, you can see a template for what arguments are
5923 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00005924 Note that this doesn't work well together with having "longest" in
5925 'completeopt', because the completion from the search pattern may not
5926 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927
5928 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5929'showmatch' 'sm' boolean (default off)
5930 global
5931 When a bracket is inserted, briefly jump to the matching one. The
5932 jump is only done if the match can be seen on the screen. The time to
5933 show the match can be set with 'matchtime'.
5934 A Beep is given if there is no match (no matter if the match can be
5935 seen or not). This option is reset when the 'paste' option is set.
5936 When the 'm' flag is not included in 'cpoptions', typing a character
5937 will immediately move the cursor back to where it belongs.
5938 See the "sm" field in 'guicursor' for setting the cursor shape and
5939 blinking when showing the match.
5940 The 'matchpairs' option can be used to specify the characters to show
5941 matches for. 'rightleft' and 'revins' are used to look for opposite
5942 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005943 Also see the matchparen plugin for highlighting the match when moving
5944 around |pi_paren.txt|.
5945 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946
5947 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5948'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5949 global
5950 If in Insert, Replace or Visual mode put a message on the last line.
5951 Use the 'M' flag in 'highlight' to set the type of highlighting for
5952 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005953 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005954 doesn't mean XIM is really active, especially when 'imactivatekey' is
5955 not set.
5956 NOTE: This option is set to the Vi default value when 'compatible' is
5957 set and to the Vim default value when 'compatible' is reset.
5958
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005959 *'showtabline'* *'stal'*
5960'showtabline' 'stal' number (default 1)
5961 global
5962 {not in Vi}
5963 {not available when compiled without the +windows
5964 feature}
5965 The value of this option specifies when the line with tab page labels
5966 will be displayed:
5967 0: never
5968 1: only if there are at least two tab pages
5969 2: always
5970 This is both for the GUI and non-GUI implementation of the tab pages
5971 line.
5972 See |tab-page| for more information about tab pages.
5973
Bram Moolenaar071d4272004-06-13 20:20:40 +00005974 *'sidescroll'* *'ss'*
5975'sidescroll' 'ss' number (default 0)
5976 global
5977 {not in Vi}
5978 The minimal number of columns to scroll horizontally. Used only when
5979 the 'wrap' option is off and the cursor is moved off of the screen.
5980 When it is zero the cursor will be put in the middle of the screen.
5981 When using a slow terminal set it to a large number or 0. When using
5982 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5983 commands.
5984
5985 *'sidescrolloff'* *'siso'*
5986'sidescrolloff' 'siso' number (default 0)
5987 global
5988 {not in Vi}
5989 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005990 right of the cursor if 'nowrap' is set. Setting this option to a
5991 value greater than 0 while having |'sidescroll'| also at a non-zero
5992 value makes some context visible in the line you are scrolling in
5993 horizontally (except at beginning of the line). Setting this option
5994 to a large value (like 999) has the effect of keeping the cursor
5995 horizontally centered in the window, as long as one does not come too
5996 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 NOTE: This option is set to 0 when 'compatible' is set.
5998
5999 Example: Try this together with 'sidescroll' and 'listchars' as
6000 in the following example to never allow the cursor to move
6001 onto the "extends" character:
6002
6003 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6004 :set sidescrolloff=1
6005
6006
6007 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6008'smartcase' 'scs' boolean (default off)
6009 global
6010 {not in Vi}
6011 Override the 'ignorecase' option if the search pattern contains upper
6012 case characters. Only used when the search pattern is typed and
6013 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006014 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6016 recalling the search pattern from history and hitting <Enter>.
6017 NOTE: This option is reset when 'compatible' is set.
6018
6019 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6020'smartindent' 'si' boolean (default off)
6021 local to buffer
6022 {not in Vi}
6023 {not available when compiled without the
6024 |+smartindent| feature}
6025 Do smart autoindenting when starting a new line. Works for C-like
6026 programs, but can also be used for other languages. 'cindent' does
6027 something like this, works better in most cases, but is more strict,
6028 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6029 'indentexpr' is a more advanced alternative.
6030 Normally 'autoindent' should also be on when using 'smartindent'.
6031 An indent is automatically inserted:
6032 - After a line ending in '{'.
6033 - After a line starting with a keyword from 'cinwords'.
6034 - Before a line starting with '}' (only with the "O" command).
6035 When typing '}' as the first character in a new line, that line is
6036 given the same indent as the matching '{'.
6037 When typing '#' as the first character in a new line, the indent for
6038 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006039 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6041 When using the ">>" command, lines starting with '#' are not shifted
6042 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006043 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 is set smart indenting is disabled.
6045
6046 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6047'smarttab' 'sta' boolean (default off)
6048 global
6049 {not in Vi}
6050 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006051 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6052 <BS> will delete a 'shiftwidth' worth of space at the start of the
6053 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006054 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006055 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6056 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006057 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006058 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006059 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006060 NOTE: This option is reset when 'compatible' is set.
6061
6062 *'softtabstop'* *'sts'*
6063'softtabstop' 'sts' number (default 0)
6064 local to buffer
6065 {not in Vi}
6066 Number of spaces that a <Tab> counts for while performing editing
6067 operations, like inserting a <Tab> or using <BS>. It "feels" like
6068 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6069 used. This is useful to keep the 'ts' setting at its standard value
6070 of 8, while being able to edit like it is set to 'sts'. However,
6071 commands like "x" still work on the actual characters.
6072 When 'sts' is zero, this feature is off.
6073 'softtabstop' is set to 0 when the 'paste' option is set.
6074 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6075 spaces is minimized by using <Tab>s.
6076 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6077 set.
6078 NOTE: This option is set to 0 when 'compatible' is set.
6079
Bram Moolenaar217ad922005-03-20 22:37:15 +00006080 *'spell'* *'nospell'*
6081'spell' boolean (default off)
6082 local to window
6083 {not in Vi}
6084 {not available when compiled without the |+syntax|
6085 feature}
6086 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006087 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006088
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006089 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006090'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006091 local to buffer
6092 {not in Vi}
6093 {not available when compiled without the |+syntax|
6094 feature}
6095 Pattern to locate the end of a sentence. The following word will be
6096 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006097 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006098 When this check is not wanted make this option empty.
6099 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006100 Be careful with special characters, see |option-backslash| about
6101 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006102 To set this option automatically depending on the language, see
6103 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006104
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006105 *'spellfile'* *'spf'*
6106'spellfile' 'spf' string (default empty)
6107 local to buffer
6108 {not in Vi}
6109 {not available when compiled without the |+syntax|
6110 feature}
6111 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006112 commands. It must end in ".{encoding}.add". You need to include the
6113 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006114 *E765*
6115 It may also be a comma separated list of names. A count before the
6116 |zg| and |zw| commands can be used to access each. This allows using
6117 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006118 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006119 you: Using the first directory in 'runtimepath' that is writable. If
6120 there is no "spell" directory yet it will be created. For the file
6121 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006122 ignoring the region.
6123 The resulting ".spl" file will be used for spell checking, it does not
6124 have to appear in 'spelllang'.
6125 Normally one file is used for all regions, but you can add the region
6126 name if you want to. However, it will then only be used when
6127 'spellfile' is set to it, for entries in 'spelllang' only files
6128 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006129 This option cannot be set from a |modeline| or in the |sandbox|, for
6130 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006131
Bram Moolenaar217ad922005-03-20 22:37:15 +00006132 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006133'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006134 local to buffer
6135 {not in Vi}
6136 {not available when compiled without the |+syntax|
6137 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006138 A comma separated list of word list names. When the 'spell' option is
6139 on spellchecking will be done for these languages. Example: >
6140 set spelllang=en_us,nl,medical
6141< This means US English, Dutch and medical words are recognized. Words
6142 that are not recognized will be highlighted.
6143 The word list name must not include a comma or dot. Using a dash is
6144 recommended to separate the two letter language name from a
6145 specification. Thus "en-rare" is used for rare English words.
6146 A region name must come last and have the form "_xx", where "xx" is
6147 the two-letter, lower case region name. You can use more than one
6148 region by listing them: "en_us,en_ca" supports both US and Canadian
6149 English, but not words specific for Australia, New Zealand or Great
6150 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006151 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006152 As a special case the name of a .spl file can be given as-is. The
6153 first "_xx" in the name is removed and used as the region name
6154 (_xx is an underscore, two letters and followed by a non-letter).
6155 This is mainly for testing purposes. You must make sure the correct
6156 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006157 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006158 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6159 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006160 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006161
Bram Moolenaar98692072006-02-04 00:57:42 +00006162 If the |spellfile.vim| plugin is active and you use a language name
6163 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6164 will ask you if you want to download the file.
6165
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006166 After this option has been set successfully, Vim will source the files
6167 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006168 up to the first comma, dot or underscore.
6169 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006170
6171
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006172 *'spellsuggest'* *'sps'*
6173'spellsuggest' 'sps' string (default "best")
6174 global
6175 {not in Vi}
6176 {not available when compiled without the |+syntax|
6177 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006178 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006179 the |spellsuggest()| function. This is a comma-separated list of
6180 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006181
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006182 best Internal method that works best for English. Finds
6183 changes like "fast" and uses a bit of sound-a-like
6184 scoring to improve the ordering.
6185
6186 double Internal method that uses two methods and mixes the
6187 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006188 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006189 word. That only works when the language specifies
6190 sound folding. Can be slow and doesn't always give
6191 better results.
6192
6193 fast Internal method that only checks for simple changes:
6194 character inserts/deletes/swaps. Works well for
6195 simple typing mistakes.
6196
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006197 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006198 Not used for |spellsuggest()|. The number of
6199 suggestions is never more than the value of 'lines'
6200 minus two.
6201
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006202 file:{filename} Read file {filename}, which must have two columns,
6203 separated by a slash. The first column contains the
6204 bad word, the second column the suggested good word.
6205 Example:
6206 theribal/terrible ~
6207 Use this for common mistakes that do not appear at the
6208 top of the suggestion list with the internal methods.
6209 Lines without a slash are ignored, use this for
6210 comments.
6211 The file is used for all languages.
6212
6213 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6214 trouble with spaces. |v:val| holds the badly spelled
6215 word. The expression must evaluate to a List of
6216 Lists, each with a suggestion and a score.
6217 Example:
6218 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006219 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006220 internal methods use. A lower score is better.
6221 This may invoke |spellsuggest()| if you temporarily
6222 set 'spellsuggest' to exclude the "expr:" part.
6223 Errors are silently ignored, unless you set the
6224 'verbose' option to a non-zero value.
6225
6226 Only one of "best", "double" or "fast" may be used. The others may
6227 appear several times in any order. Example: >
6228 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6229<
6230 This option cannot be set from a |modeline| or in the |sandbox|, for
6231 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006232
6233
Bram Moolenaar071d4272004-06-13 20:20:40 +00006234 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6235'splitbelow' 'sb' boolean (default off)
6236 global
6237 {not in Vi}
6238 {not available when compiled without the +windows
6239 feature}
6240 When on, splitting a window will put the new window below the current
6241 one. |:split|
6242
6243 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6244'splitright' 'spr' boolean (default off)
6245 global
6246 {not in Vi}
6247 {not available when compiled without the +vertsplit
6248 feature}
6249 When on, splitting a window will put the new window right of the
6250 current one. |:vsplit|
6251
6252 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6253'startofline' 'sol' boolean (default on)
6254 global
6255 {not in Vi}
6256 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006257 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006258 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006259 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 with a linewise operator, with "%" with a count and to buffer changing
6261 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6262 only has a line number, e.g., ":25" or ":+".
6263 In case of buffer changing commands the cursor is placed at the column
6264 where it was the last time the buffer was edited.
6265 NOTE: This option is set when 'compatible' is set.
6266
6267 *'statusline'* *'stl'* *E540* *E541* *E542*
6268'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006269 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 {not in Vi}
6271 {not available when compiled without the |+statusline|
6272 feature}
6273 When nonempty, this option determines the content of the status line.
6274 Also see |status-line|.
6275
6276 The option consists of printf style '%' items interspersed with
6277 normal text. Each status line item is of the form:
6278 %-0{minwid}.{maxwid}{item}
6279 All fields except the {item} is optional. A single percent sign can
6280 be given as "%%". Up to 80 items can be specified.
6281
Bram Moolenaar238a5642006-02-21 22:12:05 +00006282 When the option starts with "%!" then it is used as an expression,
6283 evaluated and the result is used as the option value. Example: >
6284 :set statusline=%!MyStatusLine()
6285< The result can contain %{} items that will be evaluated too.
6286
6287 When there is error while evaluating the option then it will be made
6288 empty to avoid further errors. Otherwise screen updating would loop.
6289
Bram Moolenaar071d4272004-06-13 20:20:40 +00006290 Note that the only effect of 'ruler' when this option is set (and
6291 'laststatus' is 2) is controlling the output of |CTRL-G|.
6292
6293 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006294 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006295 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006296 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 minwid Minimum width of the item, padding as set by '-' & '0'.
6298 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006299 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006300 on the left for text items. Numeric items will be
6301 shifted down to maxwid-2 digits followed by '>'number
6302 where number is the amount of missing digits, much like
6303 an exponential notation.
6304 item A one letter code as described below.
6305
6306 Following is a description of the possible statusline items. The
6307 second character in "item" is the type:
6308 N for number
6309 S for string
6310 F for flags as described below
6311 - not applicable
6312
6313 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006314 f S Path to the file in the buffer, as typed or relative to current
6315 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006316 F S Full path to the file in the buffer.
6317 t S File name (tail) of file in the buffer.
6318 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6319 M F Modified flag, text is ",+" or ",-".
6320 r F Readonly flag, text is " [RO]".
6321 R F Readonly flag, text is ",RO".
6322 h F Help buffer flag, text is " [help]".
6323 H F Help buffer flag, text is ",HLP".
6324 w F Preview window flag, text is " [Preview]".
6325 W F Preview window flag, text is ",PRV".
6326 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6327 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6328 {not available when compiled without |+autocmd| feature}
6329 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6330 being used: "<keymap>"
6331 n N Buffer number.
6332 b N Value of byte under cursor.
6333 B N As above, in hexadecimal.
6334 o N Byte number in file of byte under cursor, first byte is 1.
6335 Mnemonic: Offset from start of file (with one added)
6336 {not available when compiled without |+byte_offset| feature}
6337 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006338 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006339 l N Line number.
6340 L N Number of lines in buffer.
6341 c N Column number.
6342 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006343 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006344 p N Percentage through file in lines as in |CTRL-G|.
6345 P S Percentage through file of displayed window. This is like the
6346 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006347 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006348 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006349 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006350 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 ( - Start of item group. Can be used for setting the width and
6352 alignment of a section. Must be followed by %) somewhere.
6353 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006354 T N For 'tabline': start of tab page N label. Use %T after the last
6355 label. This information is used for mouse clicks.
6356 X N For 'tabline': start of close tab N label. Use %X after the
6357 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6358 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 < - Where to truncate line if too long. Default is at the start.
6360 No width fields allowed.
6361 = - Separation point between left and right aligned items.
6362 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006363 # - Set highlight group. The name must follow and then a # again.
6364 Thus use %#HLname# for highlight group HLname. The same
6365 highlighting is used, also for the statusline of non-current
6366 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006368 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006369 The difference between User{N} and StatusLine will be applied
6370 to StatusLineNC for the statusline of non-current windows.
6371 The number N must be between 1 and 9. See |hl-User1..9|
6372
6373 Display of flags are controlled by the following heuristic:
6374 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006375 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 with a space it is assumed that it wants to separate itself from
6377 anything but other flags. That is: A leading comma is removed if the
6378 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006379 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 make a nice display when flags are used like in the examples below.
6381
Bram Moolenaar582fd852005-03-28 20:58:01 +00006382 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 not set) and a minwid is not set for the group, the whole group will
6384 become empty. This will make a group like the following disappear
6385 completely from the statusline when none of the flags are set. >
6386 :set statusline=...%(\ [%M%R%H]%)...
6387<
6388 Beware that an expression is evaluated each and every time the status
6389 line is displayed. The current buffer and current window will be set
6390 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006391 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006392 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006393 real current buffer.
6394
6395 The 'statusline' option may be evaluated in the |sandbox|, see
6396 |sandbox-option|.
6397
6398 It is not allowed to change text or jump to another window while
6399 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400
6401 If the statusline is not updated when you want it (e.g., after setting
6402 a variable that's used in an expression), you can force an update by
6403 setting an option without changing its value. Example: >
6404 :let &ro = &ro
6405
6406< A result of all digits is regarded a number for display purposes.
6407 Otherwise the result is taken as flag text and applied to the rules
6408 described above.
6409
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006410 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006411 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6412 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6413
6414 Examples:
6415 Emulate standard status line with 'ruler' set >
6416 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6417< Similar, but add ASCII value of char under the cursor (like "ga") >
6418 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6419< Display byte count and byte value, modified flag in red. >
6420 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6421 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6422< Display a ,GZ flag if a compressed file is loaded >
6423 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6424< In the |:autocmd|'s: >
6425 :let b:gzflag = 1
6426< And: >
6427 :unlet b:gzflag
6428< And define this function: >
6429 :function VarExists(var, val)
6430 : if exists(a:var) | return a:val | else | return '' | endif
6431 :endfunction
6432<
6433 *'suffixes'* *'su'*
6434'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6435 global
6436 {not in Vi}
6437 Files with these suffixes get a lower priority when multiple files
6438 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006439 suffixes. Spaces after the comma are ignored. A dot is also seen as
6440 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 separator, precede it with a backslash (see |option-backslash| about
6442 including spaces and backslashes).
6443 See 'wildignore' for completely ignoring files.
6444 The use of |:set+=| and |:set-=| is preferred when adding or removing
6445 suffixes from the list. This avoids problems when a future version
6446 uses another default.
6447
6448 *'suffixesadd'* *'sua'*
6449'suffixesadd' 'sua' string (default "")
6450 local to buffer
6451 {not in Vi}
6452 {not available when compiled without the
6453 |+file_in_path| feature}
6454 Comma separated list of suffixes, which are used when searching for a
6455 file for the "gf", "[I", etc. commands. Example: >
6456 :set suffixesadd=.java
6457<
6458 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6459'swapfile' 'swf' boolean (default on)
6460 local to buffer
6461 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006462 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 swapfile is not wanted for a specific buffer. For example, with
6464 confidential information that even root must not be able to access.
6465 Careful: All text will be in memory:
6466 - Don't use this for big files.
6467 - Recovery will be impossible!
6468 A swapfile will only be present when |'updatecount'| is non-zero and
6469 'swapfile' is set.
6470 When 'swapfile' is reset, the swap file for the current buffer is
6471 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6472 non-zero, a swap file is immediately created.
6473 Also see |swap-file| and |'swapsync'|.
6474
6475 This option is used together with 'bufhidden' and 'buftype' to
6476 specify special kinds of buffers. See |special-buffers|.
6477
6478 *'swapsync'* *'sws'*
6479'swapsync' 'sws' string (default "fsync")
6480 global
6481 {not in Vi}
6482 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006483 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 When this option is empty parts of the swap file may be in memory and
6485 not written to disk. When the system crashes you may lose more work.
6486 On Unix the system does a sync now and then without Vim asking for it,
6487 so the disadvantage of setting this option off is small. On some
6488 systems the swap file will not be written at all. For a unix system
6489 setting it to "sync" will use the sync() call instead of the default
6490 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006491 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006492
6493 *'switchbuf'* *'swb'*
6494'switchbuf' 'swb' string (default "")
6495 global
6496 {not in Vi}
6497 This option controls the behavior when switching between buffers.
6498 Possible values (comma separated list):
6499 useopen If included, jump to the first open window that
6500 contains the specified buffer (if there is one).
6501 Otherwise: Do not examine other windows.
6502 This setting is checked with |quickfix| commands, when
6503 jumping to errors (":cc", ":cn", "cp", etc.). It is
6504 also used in all buffer related split commands, for
6505 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006506 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006507 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006509 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006510 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006511 newtab Like "split", but open a new tab page. Overrules
6512 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006513
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006514 *'synmaxcol'* *'smc'*
6515'synmaxcol' 'smc' number (default 3000)
6516 local to buffer
6517 {not in Vi}
6518 {not available when compiled without the |+syntax|
6519 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006520 Maximum column in which to search for syntax items. In long lines the
6521 text after this column is not highlighted and following lines may not
6522 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006523 This helps to avoid very slow redrawing for an XML file that is one
6524 long line.
6525 Set to zero to remove the limit.
6526
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 *'syntax'* *'syn'*
6528'syntax' 'syn' string (default empty)
6529 local to buffer
6530 {not in Vi}
6531 {not available when compiled without the |+syntax|
6532 feature}
6533 When this option is set, the syntax with this name is loaded, unless
6534 syntax highlighting has been switched off with ":syntax off".
6535 Otherwise this option does not always reflect the current syntax (the
6536 b:current_syntax variable does).
6537 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006538 not automatically recognized. Example, in an IDL file:
6539 /* vim: set syntax=idl : */ ~
6540 When a dot appears in the value then this separates two filetype
6541 names. Example:
6542 /* vim: set syntax=c.doxygen : */ ~
6543 This will use the "c" syntax first, then the "doxygen" syntax.
6544 Note that the second one must be prepared to be loaded as an addition,
6545 otherwise it will be skipped. More than one dot may appear.
6546 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 :set syntax=OFF
6548< To switch syntax highlighting on according to the current value of the
6549 'filetype' option: >
6550 :set syntax=ON
6551< What actually happens when setting the 'syntax' option is that the
6552 Syntax autocommand event is triggered with the value as argument.
6553 This option is not copied to another buffer, independent of the 's' or
6554 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006555 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006556
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006557 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006558'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006559 global
6560 {not in Vi}
6561 {not available when compiled without the +windows
6562 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006563 When nonempty, this option determines the content of the tab pages
6564 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006565 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006566
6567 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006568 option and only when there is no GUI tab line. When 'e' is in
6569 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6570 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006571
6572 The value is evaluated like with 'statusline'. You can use
6573 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006574 the text to be displayed. Use "%1T" for the first label, "%2T" for
6575 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006576
6577 Keep in mind that only one of the tab pages is the current one, others
6578 are invisible and you can't jump to their windows.
6579
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006580
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006581 *'tabpagemax'* *'tpm'*
6582'tabpagemax' 'tpm' number (default 10)
6583 global
6584 {not in Vi}
6585 {not available when compiled without the +windows
6586 feature}
6587 Maximum number of tab pages to be opened by the |-p| command line
6588 argument or the ":tab all" command. |tabpage|
6589
6590
6591 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006592'tabstop' 'ts' number (default 8)
6593 local to buffer
6594 Number of spaces that a <Tab> in the file counts for. Also see
6595 |:retab| command, and 'softtabstop' option.
6596
6597 Note: Setting 'tabstop' to any other value than 8 can make your file
6598 appear wrong in many places (e.g., when printing it).
6599
6600 There are four main ways to use tabs in Vim:
6601 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6602 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006603 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604 behave like a tab appears every 4 (or 3) characters.
6605 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6606 'expandtab'. This way you will always insert spaces. The
6607 formatting will never be messed up when 'tabstop' is changed.
6608 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006609 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610 works when using Vim to edit the file.
6611 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6612 'noexpandtab'. This should then work (for initial indents only)
6613 for any tabstop setting that people use. It might be nice to have
6614 tabs after the first non-blank inserted as spaces if you do this
6615 though. Otherwise aligned comments will be wrong when 'tabstop' is
6616 changed.
6617
6618 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6619'tagbsearch' 'tbs' boolean (default on)
6620 global
6621 {not in Vi}
6622 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006623 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 searching makes searching for a tag a LOT faster, but a linear search
6625 will find more tags if the tags file wasn't properly sorted.
6626 Vim normally assumes that your tags files are sorted, or indicate that
6627 they are not sorted. Only when this is not the case does the
6628 'tagbsearch' option need to be switched off.
6629
6630 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006631 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 certain files, or retry all files with a linear search. When
6633 'tagbsearch' is off, only a linear search is done.
6634
6635 Linear searching is done anyway, for one file, when Vim finds a line
6636 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006637 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006638< [The whitespace before and after the '0' must be a single <Tab>]
6639
6640 When a binary search was done and no match was found in any of the
6641 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6642 instead of a normal tag name, a retry is done with a linear search.
6643 Tags in unsorted tags files, and matches with different case will only
6644 be found in the retry.
6645
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006646 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006647 linear search can be avoided for the 'ignorecase' case. Use a value
6648 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6649 case-fold sorted with the -f switch to "sort" in most unices, as in
6650 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6651 5.3 or higher the -f or --fold-case-sort switch can be used for this
6652 as well. Note that case must be folded to uppercase for this to work.
6653
6654 When 'tagbsearch' is off, tags searching is slower when a full match
6655 exists, but faster when no full match exists. Tags in unsorted tags
6656 files may only be found with 'tagbsearch' off.
6657 When the tags file is not sorted, or sorted in a wrong way (not on
6658 ASCII byte value), 'tagbsearch' should be off, or the line given above
6659 must be included in the tags file.
6660 This option doesn't affect commands that find all matching tags (e.g.,
6661 command-line completion and ":help").
6662 {Vi: always uses binary search in some versions}
6663
6664 *'taglength'* *'tl'*
6665'taglength' 'tl' number (default 0)
6666 global
6667 If non-zero, tags are significant up to this number of characters.
6668
6669 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6670'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6671 global
6672 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006673 If on and using a tags file in another directory, file names in that
6674 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006675 NOTE: This option is set to the Vi default value when 'compatible' is
6676 set and to the Vim default value when 'compatible' is reset.
6677
6678 *'tags'* *'tag'* *E433*
6679'tags' 'tag' string (default "./tags,tags", when compiled with
6680 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6681 global or local to buffer |global-local|
6682 Filenames for the tag command, separated by spaces or commas. To
6683 include a space or comma in a file name, precede it with a backslash
6684 (see |option-backslash| about including spaces and backslashes).
6685 When a file name starts with "./", the '.' is replaced with the path
6686 of the current file. But only when the 'd' flag is not included in
6687 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6688 |tags-option|.
6689 "*", "**" and other wildcards can be used to search for tags files in
6690 a directory tree. See |file-searching|. {not available when compiled
6691 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006692 The |tagfiles()| function can be used to get a list of the file names
6693 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006694 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6695 files are also supported. They are automatically recognized. The
6696 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6697 differences are ignored (MS-Windows). |emacs-tags|
6698 The use of |:set+=| and |:set-=| is preferred when adding or removing
6699 file names from the list. This avoids problems when a future version
6700 uses another default.
6701 {Vi: default is "tags /usr/lib/tags"}
6702
6703 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6704'tagstack' 'tgst' boolean (default on)
6705 global
6706 {not in all versions of Vi}
6707 When on, the |tagstack| is used normally. When off, a ":tag" or
6708 ":tselect" command with an argument will not push the tag onto the
6709 tagstack. A following ":tag" without an argument, a ":pop" command or
6710 any other command that uses the tagstack will use the unmodified
6711 tagstack, but does change the pointer to the active entry.
6712 Resetting this option is useful when using a ":tag" command in a
6713 mapping which should not change the tagstack.
6714
6715 *'term'* *E529* *E530* *E531*
6716'term' string (default is $TERM, if that fails:
6717 in the GUI: "builtin_gui"
6718 on Amiga: "amiga"
6719 on BeOS: "beos-ansi"
6720 on Mac: "mac-ansi"
6721 on MiNT: "vt52"
6722 on MS-DOS: "pcterm"
6723 on OS/2: "os2ansi"
6724 on Unix: "ansi"
6725 on VMS: "ansi"
6726 on Win 32: "win32")
6727 global
6728 Name of the terminal. Used for choosing the terminal control
6729 characters. Environment variables are expanded |:set_env|.
6730 For example: >
6731 :set term=$TERM
6732< See |termcap|.
6733
6734 *'termbidi'* *'tbidi'*
6735 *'notermbidi'* *'notbidi'*
6736'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6737 global
6738 {not in Vi}
6739 {only available when compiled with the |+arabic|
6740 feature}
6741 The terminal is in charge of Bi-directionality of text (as specified
6742 by Unicode). The terminal is also expected to do the required shaping
6743 that some languages (such as Arabic) require.
6744 Setting this option implies that 'rightleft' will not be set when
6745 'arabic' is set and the value of 'arabicshape' will be ignored.
6746 Note that setting 'termbidi' has the immediate effect that
6747 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6748 This option is reset when the GUI is started.
6749 For further details see |arabic.txt|.
6750
6751 *'termencoding'* *'tenc'*
6752'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6753 Macintosh GUI: "macroman")
6754 global
6755 {only available when compiled with the |+multi_byte|
6756 feature}
6757 {not in Vi}
6758 Encoding used for the terminal. This specifies what character
6759 encoding the keyboard produces and the display will understand. For
6760 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006761 display). Except for the Mac when 'macatsui' is off, then
6762 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006763 In the Win32 console version the default value is the console codepage
6764 when it differs from the ANSI codepage.
6765 *E617*
6766 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6767 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6768 Any attempts to set a different value will be rejected, and an error
6769 message is shown.
6770 For the Win32 GUI 'termencoding' is not used for typed characters,
6771 because the Win32 system always passes Unicode characters.
6772 When empty, the same encoding is used as for the 'encoding' option.
6773 This is the normal value.
6774 Not all combinations for 'termencoding' and 'encoding' are valid. See
6775 |encoding-table|.
6776 The value for this option must be supported by internal conversions or
6777 iconv(). When this is not possible no conversion will be done and you
6778 will probably experience problems with non-ASCII characters.
6779 Example: You are working with the locale set to euc-jp (Japanese) and
6780 want to edit a UTF-8 file: >
6781 :let &termencoding = &encoding
6782 :set encoding=utf-8
6783< You need to do this when your system has no locale support for UTF-8.
6784
6785 *'terse'* *'noterse'*
6786'terse' boolean (default off)
6787 global
6788 When set: Add 's' flag to 'shortmess' option (this makes the message
6789 for a search that hits the start or end of the file not being
6790 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6791 shortens a lot of messages}
6792
6793 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6794'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6795 global
6796 {not in Vi}
6797 This option is obsolete. Use 'fileformats'.
6798 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6799 set to the default value for the current system. When 'textauto' is
6800 reset, 'fileformats' is made empty.
6801 NOTE: This option is set to the Vi default value when 'compatible' is
6802 set and to the Vim default value when 'compatible' is reset.
6803
6804 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6805'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6806 others: default off)
6807 local to buffer
6808 {not in Vi}
6809 This option is obsolete. Use 'fileformat'.
6810 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6811 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6812 "unix".
6813
6814 *'textwidth'* *'tw'*
6815'textwidth' 'tw' number (default 0)
6816 local to buffer
6817 {not in Vi}
6818 Maximum width of text that is being inserted. A longer line will be
6819 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006820 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6821 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006823 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006824 NOTE: This option is set to 0 when 'compatible' is set.
6825
6826 *'thesaurus'* *'tsr'*
6827'thesaurus' 'tsr' string (default "")
6828 global or local to buffer |global-local|
6829 {not in Vi}
6830 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006831 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832 the file should contain words with similar meaning, separated by
6833 non-keyword characters (white space is preferred). Maximum line
6834 length is 510 bytes.
6835 To obtain a file to be used here, check out the wordlist FAQ at
6836 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006837 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006838 after a comma are ignored, otherwise spaces are included in the file
6839 name. See |option-backslash| about using backslashes.
6840 The use of |:set+=| and |:set-=| is preferred when adding or removing
6841 directories from the list. This avoids problems when a future version
6842 uses another default.
6843 Backticks cannot be used in this option for security reasons.
6844
6845 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6846'tildeop' 'top' boolean (default off)
6847 global
6848 {not in Vi}
6849 When on: The tilde command "~" behaves like an operator.
6850 NOTE: This option is reset when 'compatible' is set.
6851
6852 *'timeout'* *'to'* *'notimeout'* *'noto'*
6853'timeout' 'to' boolean (default on)
6854 global
6855 *'ttimeout'* *'nottimeout'*
6856'ttimeout' boolean (default off)
6857 global
6858 {not in Vi}
6859 These two options together determine the behavior when part of a
6860 mapped key sequence or keyboard code has been received:
6861
6862 'timeout' 'ttimeout' action ~
6863 off off do not time out
6864 on on or off time out on :mappings and key codes
6865 off on time out on key codes
6866
6867 If both options are off, Vim will wait until either the complete
6868 mapping or key sequence has been received, or it is clear that there
6869 is no mapping or key sequence for the received characters. For
6870 example: if you have mapped "vl" and Vim has received 'v', the next
6871 character is needed to see if the 'v' is followed by an 'l'.
6872 When one of the options is on, Vim will wait for about 1 second for
6873 the next character to arrive. After that the already received
6874 characters are interpreted as single characters. The waiting time can
6875 be changed with the 'timeoutlen' option.
6876 On slow terminals or very busy systems timing out may cause
6877 malfunctioning cursor keys. If both options are off, Vim waits
6878 forever after an entered <Esc> if there are key codes that start
6879 with <Esc>. You will have to type <Esc> twice. If you do not have
6880 problems with key codes, but would like to have :mapped key
6881 sequences not timing out in 1 second, set the 'ttimeout' option and
6882 reset the 'timeout' option.
6883
6884 NOTE: 'ttimeout' is reset when 'compatible' is set.
6885
6886 *'timeoutlen'* *'tm'*
6887'timeoutlen' 'tm' number (default 1000)
6888 global
6889 {not in all versions of Vi}
6890 *'ttimeoutlen'* *'ttm'*
6891'ttimeoutlen' 'ttm' number (default -1)
6892 global
6893 {not in Vi}
6894 The time in milliseconds that is waited for a key code or mapped key
6895 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6896 when part of a command has been typed.
6897 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6898 different timeout value for key codes is desired set 'ttimeoutlen' to
6899 a non-negative number.
6900
6901 ttimeoutlen mapping delay key code delay ~
6902 < 0 'timeoutlen' 'timeoutlen'
6903 >= 0 'timeoutlen' 'ttimeoutlen'
6904
6905 The timeout only happens when the 'timeout' and 'ttimeout' options
6906 tell so. A useful setting would be >
6907 :set timeout timeoutlen=3000 ttimeoutlen=100
6908< (time out on mapping after three seconds, time out on key codes after
6909 a tenth of a second).
6910
6911 *'title'* *'notitle'*
6912'title' boolean (default off, on when title can be restored)
6913 global
6914 {not in Vi}
6915 {not available when compiled without the |+title|
6916 feature}
6917 When on, the title of the window will be set to the value of
6918 'titlestring' (if it is not empty), or to:
6919 filename [+=-] (path) - VIM
6920 Where:
6921 filename the name of the file being edited
6922 - indicates the file cannot be modified, 'ma' off
6923 + indicates the file was modified
6924 = indicates the file is read-only
6925 =+ indicates the file is read-only and modified
6926 (path) is the path of the file being edited
6927 - VIM the server name |v:servername| or "VIM"
6928 Only works if the terminal supports setting window titles
6929 (currently Amiga console, Win32 console, all GUI versions and
6930 terminals with a non- empty 't_ts' option - these are Unix xterm and
6931 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6932 *X11*
6933 When Vim was compiled with HAVE_X11 defined, the original title will
6934 be restored if possible. The output of ":version" will include "+X11"
6935 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6936 works for the icon name |'icon'|.
6937 But: When Vim was started with the |-X| argument, restoring the title
6938 will not work (except in the GUI).
6939 If the title cannot be restored, it is set to the value of 'titleold'.
6940 You might want to restore the title outside of Vim then.
6941 When using an xterm from a remote machine you can use this command:
6942 rsh machine_name xterm -display $DISPLAY &
6943 then the WINDOWID environment variable should be inherited and the
6944 title of the window should change back to what it should be after
6945 exiting Vim.
6946
6947 *'titlelen'*
6948'titlelen' number (default 85)
6949 global
6950 {not in Vi}
6951 {not available when compiled without the |+title|
6952 feature}
6953 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006954 title. When the title is longer, only the end of the path name is
6955 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006956 Using a percentage makes this adapt to the width of the window. But
6957 it won't work perfectly, because the actual number of characters
6958 available also depends on the font used and other things in the title
6959 bar. When 'titlelen' is zero the full path is used. Otherwise,
6960 values from 1 to 30000 percent can be used.
6961 'titlelen' is also used for the 'titlestring' option.
6962
6963 *'titleold'*
6964'titleold' string (default "Thanks for flying Vim")
6965 global
6966 {not in Vi}
6967 {only available when compiled with the |+title|
6968 feature}
6969 This option will be used for the window title when exiting Vim if the
6970 original title cannot be restored. Only happens if 'title' is on or
6971 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006972 This option cannot be set from a |modeline| or in the |sandbox|, for
6973 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 *'titlestring'*
6975'titlestring' string (default "")
6976 global
6977 {not in Vi}
6978 {not available when compiled without the |+title|
6979 feature}
6980 When this option is not empty, it will be used for the title of the
6981 window. This happens only when the 'title' option is on.
6982 Only works if the terminal supports setting window titles (currently
6983 Amiga console, Win32 console, all GUI versions and terminals with a
6984 non-empty 't_ts' option).
6985 When Vim was compiled with HAVE_X11 defined, the original title will
6986 be restored if possible |X11|.
6987 When this option contains printf-style '%' items, they will be
6988 expanded according to the rules used for 'statusline'.
6989 Example: >
6990 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6991 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6992< The value of 'titlelen' is used to align items in the middle or right
6993 of the available space.
6994 Some people prefer to have the file name first: >
6995 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6996< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006997 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006998 separating space only when needed.
6999 NOTE: Use of special characters in 'titlestring' may cause the display
7000 to be garbled (e.g., when it contains a CR or NL character).
7001 {not available when compiled without the |+statusline| feature}
7002
7003 *'toolbar'* *'tb'*
7004'toolbar' 'tb' string (default "icons,tooltips")
7005 global
7006 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7007 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007008 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007009 possible values are:
7010 icons Toolbar buttons are shown with icons.
7011 text Toolbar buttons shown with text.
7012 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007013 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007014 tooltips Tooltips are active for toolbar buttons.
7015 Tooltips refer to the popup help text which appears after the mouse
7016 cursor is placed over a toolbar button for a brief moment.
7017
7018 If you want the toolbar to be shown with icons as well as text, do the
7019 following: >
7020 :set tb=icons,text
7021< Motif and Athena cannot display icons and text at the same time. They
7022 will show icons if both are requested.
7023
7024 If none of the strings specified in 'toolbar' are valid or if
7025 'toolbar' is empty, this option is ignored. If you want to disable
7026 the toolbar, you need to set the 'guioptions' option. For example: >
7027 :set guioptions-=T
7028< Also see |gui-toolbar|.
7029
7030 *'toolbariconsize'* *'tbis'*
7031'toolbariconsize' 'tbis' string (default "small")
7032 global
7033 {not in Vi}
7034 {only in the GTK+ 2 GUI}
7035 Controls the size of toolbar icons. The possible values are:
7036 tiny Use tiny toolbar icons.
7037 small Use small toolbar icons (default).
7038 medium Use medium-sized toolbar icons.
7039 large Use large toolbar icons.
7040 The exact dimensions in pixels of the various icon sizes depend on
7041 the current theme. Common dimensions are large=32x32, medium=24x24,
7042 small=20x20 and tiny=16x16.
7043
7044 If 'toolbariconsize' is empty, the global default size as determined
7045 by user preferences or the current theme is used.
7046
7047 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7048'ttybuiltin' 'tbi' boolean (default on)
7049 global
7050 {not in Vi}
7051 When on, the builtin termcaps are searched before the external ones.
7052 When off the builtin termcaps are searched after the external ones.
7053 When this option is changed, you should set the 'term' option next for
7054 the change to take effect, for example: >
7055 :set notbi term=$TERM
7056< See also |termcap|.
7057 Rationale: The default for this option is "on", because the builtin
7058 termcap entries are generally better (many systems contain faulty
7059 xterm entries...).
7060
7061 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7062'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7063 sun-cmd, screen, rxvt, dtterm or
7064 iris-ansi; also on when running Vim in
7065 a DOS console)
7066 global
7067 {not in Vi}
7068 Indicates a fast terminal connection. More characters will be sent to
7069 the screen for redrawing, instead of using insert/delete line
7070 commands. Improves smoothness of redrawing when there are multiple
7071 windows and the terminal does not support a scrolling region.
7072 Also enables the extra writing of characters at the end of each screen
7073 line for lines that wrap. This helps when using copy/paste with the
7074 mouse in an xterm and other terminals.
7075
7076 *'ttymouse'* *'ttym'*
7077'ttymouse' 'ttym' string (default depends on 'term')
7078 global
7079 {not in Vi}
7080 {only in Unix and VMS, doesn't work in the GUI; not
7081 available when compiled without |+mouse|}
7082 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007083 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007084 *xterm-mouse*
7085 xterm xterm-like mouse handling. The mouse generates
7086 "<Esc>[Mscr", where "scr" is three bytes:
7087 "s" = button state
7088 "c" = column plus 33
7089 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007090 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007091 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007092 xterm2 Works like "xterm", but with the xterm reporting the
7093 mouse position while the mouse is dragged. This works
7094 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007095 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007096 work. See below for how Vim detects this
7097 automatically.
7098 *netterm-mouse*
7099 netterm NetTerm mouse handling. The mouse generates
7100 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7101 for the row and column.
7102 *dec-mouse*
7103 dec DEC terminal mouse handling. The mouse generates a
7104 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007105 This is also available for an Xterm, if it was
7106 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007107 *jsbterm-mouse*
7108 jsbterm JSB term mouse handling.
7109 *pterm-mouse*
7110 pterm QNX pterm mouse handling.
7111
7112 The mouse handling must be enabled at compile time |+mouse_xterm|
7113 |+mouse_dec| |+mouse_netterm|.
7114 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7115 recognized, if enabled at compile time. DEC terminal mouse codes
7116 are recognized if enabled at compile time, and 'ttymouse' is not
7117 "xterm" (because the xterm and dec mouse codes conflict).
7118 This option is automatically set to "xterm", when the 'term' option is
7119 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7120 or "xterm2" already. The main use of this option is to set it to
7121 "xterm", when the terminal name doesn't start with "xterm", but it can
7122 handle xterm mouse codes.
7123 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007124 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 feature and if |t_RV| is set to the escape sequence to request the
7126 xterm version number. Otherwise "xterm2" must be set explicitly.
7127 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7128 t_RV to an empty string: >
7129 :set t_RV=
7130<
7131 *'ttyscroll'* *'tsl'*
7132'ttyscroll' 'tsl' number (default 999)
7133 global
7134 Maximum number of lines to scroll the screen. If there are more lines
7135 to scroll the window is redrawn. For terminals where scrolling is
7136 very slow and redrawing is not slow this can be set to a small number,
7137 e.g., 3, to speed up displaying.
7138
7139 *'ttytype'* *'tty'*
7140'ttytype' 'tty' string (default from $TERM)
7141 global
7142 Alias for 'term', see above.
7143
7144 *'undolevels'* *'ul'*
7145'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7146 Win32 and OS/2)
7147 global
7148 {not in Vi}
7149 Maximum number of changes that can be undone. Since undo information
7150 is kept in memory, higher numbers will cause more memory to be used
7151 (nevertheless, a single change can use an unlimited amount of memory).
7152 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7153 itself: >
7154 set ul=0
7155< But you can also get Vi compatibility by including the 'u' flag in
7156 'cpoptions', and still be able to use CTRL-R to repeat undo.
7157 Set to a negative number for no undo at all: >
7158 set ul=-1
7159< This helps when you run out of memory for a single change.
7160 Also see |undo-two-ways|.
7161
7162 *'updatecount'* *'uc'*
7163'updatecount' 'uc' number (default: 200)
7164 global
7165 {not in Vi}
7166 After typing this many characters the swap file will be written to
7167 disk. When zero, no swap file will be created at all (see chapter on
7168 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7169 Vim with the "-n" option, see |startup|. When editing in readonly
7170 mode this option will be initialized to 10000.
7171 The swapfile can be disabled per buffer with |'swapfile'|.
7172 When 'updatecount' is set from zero to non-zero, swap files are
7173 created for all buffers that have 'swapfile' set. When 'updatecount'
7174 is set to zero, existing swap files are not deleted.
7175 Also see |'swapsync'|.
7176 This option has no meaning in buffers where |'buftype'| is "nofile"
7177 or "nowrite".
7178
7179 *'updatetime'* *'ut'*
7180'updatetime' 'ut' number (default 4000)
7181 global
7182 {not in Vi}
7183 If this many milliseconds nothing is typed the swap file will be
7184 written to disk (see |crash-recovery|). Also used for the
7185 |CursorHold| autocommand event.
7186
7187 *'verbose'* *'vbs'*
7188'verbose' 'vbs' number (default 0)
7189 global
7190 {not in Vi, although some versions have a boolean
7191 verbose option}
7192 When bigger than zero, Vim will give messages about what it is doing.
7193 Currently, these messages are given:
7194 >= 1 When the viminfo file is read or written.
7195 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007196 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 >= 8 Files for which a group of autocommands is executed.
7198 >= 9 Every executed autocommand.
7199 >= 12 Every executed function.
7200 >= 13 When an exception is thrown, caught, finished, or discarded.
7201 >= 14 Anything pending in a ":finally" clause.
7202 >= 15 Every executed Ex command (truncated at 200 characters).
7203
7204 This option can also be set with the "-V" argument. See |-V|.
7205 This option is also set by the |:verbose| command.
7206
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007207 When the 'verbosefile' option is set then the verbose messages are not
7208 displayed.
7209
7210 *'verbosefile'* *'vfile'*
7211'verbosefile' 'vfile' string (default empty)
7212 global
7213 {not in Vi}
7214 When not empty all messages are written in a file with this name.
7215 When the file exists messages are appended.
7216 Writing to the file ends when Vim exits or when 'verbosefile' is made
7217 empty.
7218 Setting 'verbosefile' to a new value is like making it empty first.
7219 The difference with |:redir| is that verbose messages are not
7220 displayed when 'verbosefile' is set.
7221
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 *'viewdir'* *'vdir'*
7223'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7224 "$VIM/vimfiles/view",
7225 for Unix: "~/.vim/view",
7226 for Macintosh: "$VIM:vimfiles:view"
7227 for VMS: "sys$login:vimfiles/view"
7228 for RiscOS: "Choices:vimfiles/view")
7229 global
7230 {not in Vi}
7231 {not available when compiled without the +mksession
7232 feature}
7233 Name of the directory where to store files for |:mkview|.
7234 This option cannot be set from a |modeline| or in the |sandbox|, for
7235 security reasons.
7236
7237 *'viewoptions'* *'vop'*
7238'viewoptions' 'vop' string (default: "folds,options,cursor")
7239 global
7240 {not in Vi}
7241 {not available when compiled without the +mksession
7242 feature}
7243 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007244 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007245 word save and restore ~
7246 cursor cursor position in file and in window
7247 folds manually created folds, opened/closed folds and local
7248 fold options
7249 options options and mappings local to a window or buffer (not
7250 global values for local options)
7251 slash backslashes in file names replaced with forward
7252 slashes
7253 unix with Unix end-of-line format (single <NL>), even when
7254 on Windows or DOS
7255
7256 "slash" and "unix" are useful on Windows when sharing view files
7257 with Unix. The Unix version of Vim cannot source dos format scripts,
7258 but the Windows version of Vim can source unix format scripts.
7259
7260 *'viminfo'* *'vi'* *E526* *E527* *E528*
7261'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7262 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7263 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7264 for others: '20,<50,s10,h)
7265 global
7266 {not in Vi}
7267 {not available when compiled without the |+viminfo|
7268 feature}
7269 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007270 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007271 separated list of parameters, each consisting of a single character
7272 identifying the particular parameter, followed by a number or string
7273 which specifies the value of that parameter. If a particular
7274 character is left out, then the default value is used for that
7275 parameter. The following is a list of the identifying characters and
7276 the effect of their value.
7277 CHAR VALUE ~
7278 ! When included, save and restore global variables that start
7279 with an uppercase letter, and don't contain a lowercase
7280 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007281 and "_K_L_M" are not. Only String and Number types are
7282 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283 " Maximum number of lines saved for each register. Old name of
7284 the '<' item, with the disadvantage that you need to put a
7285 backslash before the ", otherwise it will be recognized as the
7286 start of a comment!
7287 % When included, save and restore the buffer list. If Vim is
7288 started with a file name argument, the buffer list is not
7289 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007290 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007291 without a file name and buffers for help files are not written
7292 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007293 When followed by a number, the number specifies the maximum
7294 number of buffers that are stored. Without a number all
7295 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007296 ' Maximum number of previously edited files for which the marks
7297 are remembered. This parameter must always be included when
7298 'viminfo' is non-empty.
7299 Including this item also means that the |jumplist| and the
7300 |changelist| are stored in the viminfo file.
7301 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007302 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007303 patterns are also saved. When not included, the value of
7304 'history' is used.
7305 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007306 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007307 < Maximum number of lines saved for each register. If zero then
7308 registers are not saved. When not included, all lines are
7309 saved. '"' is the old name for this item.
7310 Also see the 's' item below: limit specified in Kbyte.
7311 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007312 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 c When included, convert the text in the viminfo file from the
7314 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007315 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 f Whether file marks need to be stored. If zero, file marks ('0
7317 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007318 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319 cursor position (when exiting or when doing ":wviminfo").
7320 h Disable the effect of 'hlsearch' when loading the viminfo
7321 file. When not included, it depends on whether ":nohlsearch"
7322 has been used since the last search command.
7323 n Name of the viminfo file. The name must immediately follow
7324 the 'n'. Must be the last one! If the "-i" argument was
7325 given when starting Vim, that file name overrides the one
7326 given here with 'viminfo'. Environment variables are expanded
7327 when opening the file, not when setting the option.
7328 r Removable media. The argument is a string (up to the next
7329 ','). This parameter can be given several times. Each
7330 specifies the start of a path for which no marks will be
7331 stored. This is to avoid removable media. For MS-DOS you
7332 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7333 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7334 ignored. Maximum length of each 'r' argument is 50
7335 characters.
7336 s Maximum size of an item in Kbyte. If zero then registers are
7337 not saved. Currently only applies to registers. The default
7338 "s10" will exclude registers with more than 10 Kbyte of text.
7339 Also see the '<' item above: line count limit.
7340
7341 Example: >
7342 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7343<
7344 '50 Marks will be remembered for the last 50 files you
7345 edited.
7346 <1000 Contents of registers (up to 1000 lines each) will be
7347 remembered.
7348 s100 Registers with more than 100 Kbyte text are skipped.
7349 :0 Command-line history will not be saved.
7350 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7351 no / Since '/' is not specified, the default will be used,
7352 that is, save all of the search history, and also the
7353 previous search and substitute patterns.
7354 no % The buffer list will not be saved nor read back.
7355 no h 'hlsearch' highlighting will be restored.
7356
7357 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7358 load the contents of the file, this is not done automatically.
7359
7360 This option cannot be set from a |modeline| or in the |sandbox|, for
7361 security reasons.
7362
7363 *'virtualedit'* *'ve'*
7364'virtualedit' 've' string (default "")
7365 global
7366 {not in Vi}
7367 {not available when compiled without the
7368 |+virtualedit| feature}
7369 A comma separated list of these words:
7370 block Allow virtual editing in Visual block mode.
7371 insert Allow virtual editing in Insert mode.
7372 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007373 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007374
Bram Moolenaar071d4272004-06-13 20:20:40 +00007375 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007376 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007377 of the line. Useful for selecting a rectangle in Visual mode and
7378 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007379 "onemore" is not the same, it will only allow moving the cursor just
7380 after the last character of the line. This makes some commands more
7381 consistent. Previously the cursor was always past the end of the line
7382 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007383 break some plugins or Vim scripts. For example because |l| can move
7384 the cursor after the last character. Use with care!
7385 Using the |$| command will move to the last character in the line, not
7386 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007387 It doesn't make sense to combine "all" with "onemore", but you will
7388 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389
7390 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7391'visualbell' 'vb' boolean (default off)
7392 global
7393 {not in Vi}
7394 Use visual bell instead of beeping. The terminal code to display the
7395 visual bell is given with 't_vb'. When no beep or flash is wanted,
7396 use ":set vb t_vb=".
7397 Note: When the GUI starts, 't_vb' is reset to its default value. You
7398 might want to set it again in your |gvimrc|.
7399 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7400 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7401 where 40 is the time in msec.
7402 Does not work on the Amiga, you always get a screen flash.
7403 Also see 'errorbells'.
7404
7405 *'warn'* *'nowarn'*
7406'warn' boolean (default on)
7407 global
7408 Give a warning message when a shell command is used while the buffer
7409 has been changed.
7410
7411 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7412'weirdinvert' 'wiv' boolean (default off)
7413 global
7414 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007415 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 It is provided for backwards compatibility with version 4.x.
7417 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7418 vice versa. Has no effect when the GUI is running.
7419
7420 *'whichwrap'* *'ww'*
7421'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7422 global
7423 {not in Vi}
7424 Allow specified keys that move the cursor left/right to move to the
7425 previous/next line when the cursor is on the first/last character in
7426 the line. Concatenate characters to allow this for these keys:
7427 char key mode ~
7428 b <BS> Normal and Visual
7429 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007430 h "h" Normal and Visual (not recommended)
7431 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 < <Left> Normal and Visual
7433 > <Right> Normal and Visual
7434 ~ "~" Normal
7435 [ <Left> Insert and Replace
7436 ] <Right> Insert and Replace
7437 For example: >
7438 :set ww=<,>,[,]
7439< allows wrap only when cursor keys are used.
7440 When the movement keys are used in combination with a delete or change
7441 operator, the <EOL> also counts for a character. This makes "3h"
7442 different from "3dh" when the cursor crosses the end of a line. This
7443 is also true for "x" and "X", because they do the same as "dl" and
7444 "dh". If you use this, you may also want to use the mapping
7445 ":map <BS> X" to make backspace delete the character in front of the
7446 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007447 When 'l' is included and it is used after an operator at the end of a
7448 line then it will not move to the next line. This makes "dl", "cl",
7449 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 NOTE: This option is set to the Vi default value when 'compatible' is
7451 set and to the Vim default value when 'compatible' is reset.
7452
7453 *'wildchar'* *'wc'*
7454'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7455 global
7456 {not in Vi}
7457 Character you have to type to start wildcard expansion in the
7458 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007459 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 The character is not recognized when used inside a macro. See
7461 'wildcharm' for that.
7462 Although 'wc' is a number option, you can set it to a special key: >
7463 :set wc=<Esc>
7464< NOTE: This option is set to the Vi default value when 'compatible' is
7465 set and to the Vim default value when 'compatible' is reset.
7466
7467 *'wildcharm'* *'wcm'*
7468'wildcharm' 'wcm' number (default: none (0))
7469 global
7470 {not in Vi}
7471 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007472 recognized when used inside a macro. You can find "spare" command-line
7473 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007474 you'll never actually type 'wildcharm', just use it in mappings that
7475 automatically invoke completion mode, e.g.: >
7476 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007477 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478< Then after typing :ss you can use CTRL-P & CTRL-N.
7479
7480 *'wildignore'* *'wig'*
7481'wildignore' 'wig' string (default "")
7482 global
7483 {not in Vi}
7484 {not available when compiled without the |+wildignore|
7485 feature}
7486 A list of file patterns. A file that matches with one of these
7487 patterns is ignored when completing file or directory names.
7488 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7489 Also see 'suffixes'.
7490 Example: >
7491 :set wildignore=*.o,*.obj
7492< The use of |:set+=| and |:set-=| is preferred when adding or removing
7493 a pattern from the list. This avoids problems when a future version
7494 uses another default.
7495
7496 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7497'wildmenu' 'wmnu' boolean (default off)
7498 global
7499 {not in Vi}
7500 {not available if compiled without the |+wildmenu|
7501 feature}
7502 When 'wildmenu' is on, command-line completion operates in an enhanced
7503 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7504 the possible matches are shown just above the command line, with the
7505 first match highlighted (overwriting the status line, if there is
7506 one). Keys that show the previous/next match, such as <Tab> or
7507 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7508 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7509 specified. "longest" and "list" do not start "wildmenu" mode.
7510 If there are more matches than can fit in the line, a ">" is shown on
7511 the right and/or a "<" is shown on the left. The status line scrolls
7512 as needed.
7513 The "wildmenu" mode is abandoned when a key is hit that is not used
7514 for selecting a completion.
7515 While the "wildmenu" is active the following keys have special
7516 meanings:
7517
7518 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7519 <Down> - in filename/menu name completion: move into a
7520 subdirectory or submenu.
7521 <CR> - in menu completion, when the cursor is just after a
7522 dot: move into a submenu.
7523 <Up> - in filename/menu name completion: move up into
7524 parent directory or parent menu.
7525
7526 This makes the menus accessible from the console |console-menus|.
7527
7528 If you prefer the <Left> and <Right> keys to move the cursor instead
7529 of selecting a different match, use this: >
7530 :cnoremap <Left> <Space><BS><Left>
7531 :cnoremap <Right> <Space><BS><Right>
7532<
7533 The "WildMenu" highlighting is used for displaying the current match
7534 |hl-WildMenu|.
7535
7536 *'wildmode'* *'wim'*
7537'wildmode' 'wim' string (Vim default: "full")
7538 global
7539 {not in Vi}
7540 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007541 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007542 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007543 first part specifies the behavior for the first use of 'wildchar',
7544 The second part for the second use, etc.
7545 These are the possible values for each part:
7546 "" Complete only the first match.
7547 "full" Complete the next full match. After the last match,
7548 the original string is used and then the first match
7549 again.
7550 "longest" Complete till longest common string. If this doesn't
7551 result in a longer string, use the next part.
7552 "longest:full" Like "longest", but also start 'wildmenu' if it is
7553 enabled.
7554 "list" When more than one match, list all matches.
7555 "list:full" When more than one match, list all matches and
7556 complete first match.
7557 "list:longest" When more than one match, list all matches and
7558 complete till longest common string.
7559 When there is only a single match, it is fully completed in all cases.
7560
7561 Examples: >
7562 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007563< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 :set wildmode=longest,full
7565< Complete longest common string, then each full match >
7566 :set wildmode=list:full
7567< List all matches and complete each full match >
7568 :set wildmode=list,full
7569< List all matches without completing, then each full match >
7570 :set wildmode=longest,list
7571< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007572 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007574 *'wildoptions'* *'wop'*
7575'wildoptions' 'wop' string (default "")
7576 global
7577 {not in Vi}
7578 {not available when compiled without the |+wildignore|
7579 feature}
7580 A list of words that change how command line completion is done.
7581 Currently only one word is allowed:
7582 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007583 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007584 is displayed per line. Often used tag kinds are:
7585 d #define
7586 f function
7587 Also see |cmdline-completion|.
7588
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 *'winaltkeys'* *'wak'*
7590'winaltkeys' 'wak' string (default "menu")
7591 global
7592 {not in Vi}
7593 {only used in Win32, Motif, GTK and Photon GUI}
7594 Some GUI versions allow the access to menu entries by using the ALT
7595 key in combination with a character that appears underlined in the
7596 menu. This conflicts with the use of the ALT key for mappings and
7597 entering special characters. This option tells what to do:
7598 no Don't use ALT keys for menus. ALT key combinations can be
7599 mapped, but there is no automatic handling. This can then be
7600 done with the |:simalt| command.
7601 yes ALT key handling is done by the windowing system. ALT key
7602 combinations cannot be mapped.
7603 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007604 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007605 keys can be mapped.
7606 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7607 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007608 This option is not used for <F10>; on Win32 and with GTK <F10> will
7609 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007610
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007611 *'window'* *'wi'*
7612'window' 'wi' number (default screen height - 1)
7613 global
7614 Window height. Do not confuse this with the height of the Vim window,
7615 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007616 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7617 value is smaller than 'lines' minus one. The screen will scroll
7618 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007619 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7620 in a much smarter way, taking care of wrapping lines.
7621 When resizing the Vim window, the value is smaller than 1 or more than
7622 or equal to 'lines' it will be set to 'lines' minus 1.
7623 {Vi also uses the option to specify the number of displayed lines}
7624
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 *'winheight'* *'wh'* *E591*
7626'winheight' 'wh' number (default 1)
7627 global
7628 {not in Vi}
7629 {not available when compiled without the +windows
7630 feature}
7631 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007632 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007633 focus goes to a window that is smaller, its size is increased, at the
7634 cost of the height of other windows.
7635 Set 'winheight' to a small number for normal editing.
7636 Set it to 999 to make the current window fill most of the screen.
7637 Other windows will be only 'winminheight' high. This has the drawback
7638 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7639 to create only two windows, set the option after startup is done,
7640 using the |VimEnter| event: >
7641 au VimEnter * set winheight=999
7642< Minimum value is 1.
7643 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 height of the current window.
7645 'winheight' applies to the current window. Use 'winminheight' to set
7646 the minimal height for other windows.
7647
7648 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7649'winfixheight' 'wfh' boolean (default off)
7650 local to window
7651 {not in Vi}
7652 {not available when compiled without the +windows
7653 feature}
7654 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007655 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7656 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007657 The height may be changed anyway when running out of room.
7658
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007659 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7660'winfixwidth' 'wfw' boolean (default off)
7661 local to window
7662 {not in Vi}
7663 {not available when compiled without the +windows
7664 feature}
7665 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007666 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007667 The width may be changed anyway when running out of room.
7668
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 *'winminheight'* *'wmh'*
7670'winminheight' 'wmh' number (default 1)
7671 global
7672 {not in Vi}
7673 {not available when compiled without the +windows
7674 feature}
7675 The minimal height of a window, when it's not the current window.
7676 This is a hard minimum, windows will never become smaller.
7677 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7678 status bar) if necessary. They will return to at least one line when
7679 they become active (since the cursor has to have somewhere to go.)
7680 Use 'winheight' to set the minimal height of the current window.
7681 This option is only checked when making a window smaller. Don't use a
7682 large number, it will cause errors when opening more than a few
7683 windows. A value of 0 to 3 is reasonable.
7684
7685 *'winminwidth'* *'wmw'*
7686'winminwidth' 'wmw' number (default 1)
7687 global
7688 {not in Vi}
7689 {not available when compiled without the +vertsplit
7690 feature}
7691 The minimal width of a window, when it's not the current window.
7692 This is a hard minimum, windows will never become smaller.
7693 When set to zero, windows may be "squashed" to zero columns (i.e. just
7694 a vertical separator) if necessary. They will return to at least one
7695 line when they become active (since the cursor has to have somewhere
7696 to go.)
7697 Use 'winwidth' to set the minimal width of the current window.
7698 This option is only checked when making a window smaller. Don't use a
7699 large number, it will cause errors when opening more than a few
7700 windows. A value of 0 to 12 is reasonable.
7701
7702 *'winwidth'* *'wiw'* *E592*
7703'winwidth' 'wiw' number (default 20)
7704 global
7705 {not in Vi}
7706 {not available when compiled without the +vertsplit
7707 feature}
7708 Minimal number of columns for the current window. This is not a hard
7709 minimum, Vim will use fewer columns if there is not enough room. If
7710 the current window is smaller, its size is increased, at the cost of
7711 the width of other windows. Set it to 999 to make the current window
7712 always fill the screen. Set it to a small number for normal editing.
7713 The width is not adjusted after one of the commands to change the
7714 width of the current window.
7715 'winwidth' applies to the current window. Use 'winminwidth' to set
7716 the minimal width for other windows.
7717
7718 *'wrap'* *'nowrap'*
7719'wrap' boolean (default on)
7720 local to window
7721 {not in Vi}
7722 This option changes how text is displayed. It doesn't change the text
7723 in the buffer, see 'textwidth' for that.
7724 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007725 displaying continues on the next line. When off lines will not wrap
7726 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007727 moved to a part that is not shown, the screen will scroll
7728 horizontally.
7729 The line will be broken in the middle of a word if necessary. See
7730 'linebreak' to get the break at a word boundary.
7731 To make scrolling horizontally a bit more useful, try this: >
7732 :set sidescroll=5
7733 :set listchars+=precedes:<,extends:>
7734< See 'sidescroll', 'listchars' and |wrap-off|.
7735
7736 *'wrapmargin'* *'wm'*
7737'wrapmargin' 'wm' number (default 0)
7738 local to buffer
7739 Number of characters from the right window border where wrapping
7740 starts. When typing text beyond this limit, an <EOL> will be inserted
7741 and inserting continues on the next line.
7742 Options that add a margin, such as 'number' and 'foldcolumn', cause
7743 the text width to be further reduced. This is Vi compatible.
7744 When 'textwidth' is non-zero, this option is not used.
7745 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7746 and less usefully}
7747
7748 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7749'wrapscan' 'ws' boolean (default on) *E384* *E385*
7750 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007751 Searches wrap around the end of the file. Also applies to |]s| and
7752 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007753
7754 *'write'* *'nowrite'*
7755'write' boolean (default on)
7756 global
7757 {not in Vi}
7758 Allows writing files. When not set, writing a file is not allowed.
7759 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007760 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007761 argument. Filtering text is still possible, even though this requires
7762 writing a temporary file.
7763
7764 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7765'writeany' 'wa' boolean (default off)
7766 global
7767 Allows writing to any file with no need for "!" override.
7768
7769 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7770'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7771 otherwise)
7772 global
7773 {not in Vi}
7774 Make a backup before overwriting a file. The backup is removed after
7775 the file was successfully written, unless the 'backup' option is
7776 also on. Reset this option if your file system is almost full. See
7777 |backup-table| for another explanation.
7778 When the 'backupskip' pattern matches, a backup is not made anyway.
7779 NOTE: This option is set to the default value when 'compatible' is
7780 set.
7781
7782 *'writedelay'* *'wd'*
7783'writedelay' 'wd' number (default 0)
7784 global
7785 {not in Vi}
7786 The number of microseconds to wait for each character sent to the
7787 screen. When non-zero, characters are sent to the terminal one by
7788 one. For MS-DOS pcterm this does not work. For debugging purposes.
7789
7790 vim:tw=78:ts=8:ft=help:norl: