blob: 7cf41a252b6043560de0301d1005fdac56e3fde0 [file] [log] [blame]
Bram Moolenaar02467872007-05-06 13:22:01 +00001*options.txt* For Vim version 7.1a. Last change: 2007 May 05
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000081 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000272:setl[ocal] {option}< Set the local value of {option} to its global value by
273 copying the value.
274 {not in Vi}
275
276:se[t] {option}< Set the local value of {option} to its global value by
277 making it empty. Only makes sense for |global-local|
278 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 {not in Vi}
280
281 *:setg* *:setglobal*
282:setg[lobal] ... Like ":set" but set only the global value for a local
283 option without changing the local value.
284 When displaying an option, the global value is shown.
285 With the "all" argument: display all local option's
286 global values.
287 Without argument: display all local option's global
288 values which are different from the default.
289 {not in Vi}
290
291For buffer-local and window-local options:
292 Command global value local value ~
293 :set option=value set set
294 :setlocal option=value - set
295:setglobal option=value set -
296 :set option? - display
297 :setlocal option? - display
298:setglobal option? display -
299
300
301Global options with a local value *global-local*
302
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000303Options are global when you mostly use one value for all buffers and windows.
304For some global options it's useful to sometimes have a different local value.
305You can set the local value with ":setlocal". That buffer or window will then
306use the local value, while other buffers and windows continue using the global
307value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
309For example, you have two windows, both on C source code. They use the global
310'makeprg' option. If you do this in one of the two windows: >
311 :set makeprg=gmake
312then the other window will switch to the same value. There is no need to set
313the 'makeprg' option in the other C source window too.
314However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000315another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000316files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 :setlocal makeprg=perlmake
318You can switch back to using the global value by making the local value empty: >
319 :setlocal makeprg=
320This only works for a string option. For a boolean option you need to use the
321"<" flag, like this: >
322 :setlocal autoread<
323Note that for non-boolean options using "<" copies the global value to the
324local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000325when the global value changes later). You can also use: >
326 :set path<
327This will make the local value of 'path' empty, so that the global value is
328used. Thus it does the same as: >
329 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330Note: In the future more global options can be made global-local. Using
331":setlocal" on a global option might work differently then.
332
333
334Setting the filetype
335
336:setf[iletype] {filetype} *:setf* *:setfiletype*
337 Set the 'filetype' option to {filetype}, but only if
338 not done yet in a sequence of (nested) autocommands.
339 This is short for: >
340 :if !did_filetype()
341 : setlocal filetype={filetype}
342 :endif
343< This command is used in a filetype.vim file to avoid
344 setting the 'filetype' option twice, causing different
345 settings and syntax files to be loaded.
346 {not in Vi}
347
348:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
349:opt[ions] Open a window for viewing and setting all options.
350 Options are grouped by function.
351 Offers short help for each option. Hit <CR> on the
352 short help to open a help window with more help for
353 the option.
354 Modify the value of the option and hit <CR> on the
355 "set" line to set the new value. For window and
356 buffer specific options, the last accessed window is
357 used to set the option value in, unless this is a help
358 window, in which case the window below help window is
359 used (skipping the option-window).
360 {not available when compiled without the |+eval| or
361 |+autocmd| features}
362
363 *$HOME*
364Using "~" is like using "$HOME", but it is only recognized at the start of an
365option and after a space or comma.
366
367On Unix systems "~user" can be used too. It is replaced by the home directory
368of user "user". Example: >
369 :set path=~mool/include,/usr/include,.
370
371On Unix systems the form "${HOME}" can be used too. The name between {} can
372contain non-id characters then. Note that if you want to use this for the
373"gf" command, you need to add the '{' and '}' characters to 'isfname'.
374
375NOTE: expanding environment variables and "~/" is only done with the ":set"
376command, not when assigning a value to an option with ":let".
377
378
379Note the maximum length of an expanded option is limited. How much depends on
380the system, mostly it is something like 256 or 1024 characters.
381
382 *:fix* *:fixdel*
383:fix[del] Set the value of 't_kD':
384 't_kb' is 't_kD' becomes ~
385 CTRL-? CTRL-H
386 not CTRL-? CTRL-?
387
388 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
389
390 If your delete key terminal code is wrong, but the
391 code for backspace is alright, you can put this in
392 your .vimrc: >
393 :fixdel
394< This works no matter what the actual code for
395 backspace is.
396
397 If the backspace key terminal code is wrong you can
398 use this: >
399 :if &term == "termname"
400 : set t_kb=^V<BS>
401 : fixdel
402 :endif
403< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000404 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 with your terminal name.
406
407 If your <Delete> key sends a strange key sequence (not
408 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
409 :if &term == "termname"
410 : set t_kD=^V<Delete>
411 :endif
412< Where "^V" is CTRL-V and "<Delete>" is the delete key
413 (don't type eight characters!). Replace "termname"
414 with your terminal name.
415
416 *Linux-backspace*
417 Note about Linux: By default the backspace key
418 produces CTRL-?, which is wrong. You can fix it by
419 putting this line in your rc.local: >
420 echo "keycode 14 = BackSpace" | loadkeys
421<
422 *NetBSD-backspace*
423 Note about NetBSD: If your backspace doesn't produce
424 the right code, try this: >
425 xmodmap -e "keycode 22 = BackSpace"
426< If this works, add this in your .Xmodmap file: >
427 keysym 22 = BackSpace
428< You need to restart for this to take effect.
429
430==============================================================================
4312. Automatically setting options *auto-setting*
432
433Besides changing options with the ":set" command, there are three alternatives
434to set options automatically for one or more files:
435
4361. When starting Vim initializations are read from various places. See
437 |initialization|. Most of them are performed for all editing sessions,
438 and some of them depend on the directory where Vim is started.
439 You can create an initialization file with |:mkvimrc|, |:mkview| and
440 |:mksession|.
4412. If you start editing a new file, the automatic commands are executed.
442 This can be used to set options for files matching a particular pattern and
443 many other things. See |autocommand|.
4443. If you start editing a new file, and the 'modeline' option is on, a
445 number of lines at the beginning and end of the file are checked for
446 modelines. This is explained here.
447
448 *modeline* *vim:* *vi:* *ex:* *E520*
449There are two forms of modelines. The first form:
450 [text]{white}{vi:|vim:|ex:}[white]{options}
451
452[text] any text or empty
453{white} at least one blank character (<Space> or <Tab>)
454{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
455[white] optional white space
456{options} a list of option settings, separated with white space or ':',
457 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000458 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000459
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000460Example:
461 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462
463The second form (this is compatible with some versions of Vi):
464
465 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
466
467[text] any text or empty
468{white} at least one blank character (<Space> or <Tab>)
469{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
470[white] optional white space
471se[t] the string "set " or "se " (note the space)
472{options} a list of options, separated with white space, which is the
473 argument for a ":set" command
474: a colon
475[text] any text or empty
476
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000477Example:
478 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479
480The white space before {vi:|vim:|ex:} is required. This minimizes the chance
481that a normal word like "lex:" is caught. There is one exception: "vi:" and
482"vim:" can also be at the start of the line (for compatibility with version
4833.0). Using "ex:" at the start of the line will be ignored (this could be
484short for "example:").
485
486 *modeline-local*
487The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000488buffer and window that contain the file. Although it's possible to set global
489options from a modeline, this is unusual. If you have two windows open and
490the files in it set the same global option to a different value, the result
491depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000493When editing a file that was already loaded, only the window-local options
494from the modeline are used. Thus if you manually changed a buffer-local
495option after opening the file, it won't be changed if you edit the same buffer
496in another window. But window-local options will be set.
497
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 *modeline-version*
499If the modeline is only to be used for some versions of Vim, the version
500number can be specified where "vim:" is used:
501 vim{vers}: version {vers} or later
502 vim<{vers}: version before {vers}
503 vim={vers}: version {vers}
504 vim>{vers}: version after {vers}
505{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000506For example, to use a modeline only for Vim 6.0 and later:
507 /* vim600: set foldmethod=marker: */ ~
508To use a modeline for Vim before version 5.7:
509 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510There can be no blanks between "vim" and the ":".
511
512
513The number of lines that are checked can be set with the 'modelines' option.
514If 'modeline' is off or 'modelines' is 0 no lines are checked.
515
516Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000517like:
518 /* vi:ts=4: */ ~
519will give an error message for the trailing "*/". This line is OK:
520 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522If an error is detected the rest of the line is skipped.
523
524If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000525backslash in front of the ':' will be removed. Example:
526 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527This sets the 'dir' option to "c:\tmp". Only a single backslash before the
528':' is removed. Thus to include "\:" you have to specify "\\:".
529
530No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000531might create a Trojan horse text file with modelines). And not all options
532can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000533|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000534causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
535are wrapped unexpectedly. So disable modelines before editing untrusted text.
536The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538Hint: If you would like to do something else than setting an option, you could
539define an autocommand that checks the file for a specific string. For
540example: >
541 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
542And define a function SetVar() that does something with the line containing
543"VAR".
544
545==============================================================================
5463. Options summary *option-summary*
547
548In the list below all the options are mentioned with their full name and with
549an abbreviation if there is one. Both forms may be used.
550
551In this document when a boolean option is "set" that means that ":set option"
552is entered. When an option is "reset", ":set nooption" is used.
553
554For some options there are two default values: The "Vim default", which is
555used when 'compatible' is not set, and the "Vi default", which is used when
556'compatible' is set.
557
558Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000559are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000560different value in each window. For example the 'list' option can be set in
561one window and reset in another for the same text, giving both types of view
562at the same time. There are a few options that are specific to a certain
563file. These can have a different value for each file or buffer. For example
564the 'textwidth' option can be 78 for a normal text file and 0 for a C
565program.
566
567 global one option for all buffers and windows
568 local to window each window has its own copy of this option
569 local to buffer each buffer has its own copy of this option
570
571When creating a new window the option values from the currently active window
572are used as a default value for the window-specific options. For the
573buffer-specific options this depends on the 's' and 'S' flags in the
574'cpoptions' option. If 's' is included (which is the default) the values for
575buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000576first entered. If 'S' is present the options are copied each time the buffer
577is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000578present, the options are copied from the currently active buffer when the
579buffer is created.
580
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000581Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000583Not all options are supported in all versions. This depends on the supported
584features and sometimes on the system. A remark about this is in curly braces
585below. When an option is not supported it may still be set without getting an
586error, this is called a hidden option. You can't get the value of a hidden
587option though, it is not stored.
588
589To test if option "foo" can be used with ":set" use something like this: >
590 if exists('&foo')
591This also returns true for a hidden option. To test if option "foo" is really
592supported use something like this: >
593 if exists('+foo')
594<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000595 *E355*
596A jump table for the options with a short description can be found at |Q_op|.
597
598 *'aleph'* *'al'* *aleph* *Aleph*
599'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
600 global
601 {not in Vi}
602 {only available when compiled with the |+rightleft|
603 feature}
604 The ASCII code for the first letter of the Hebrew alphabet. The
605 routine that maps the keyboard in Hebrew mode, both in Insert mode
606 (when hkmap is set) and on the command-line (when hitting CTRL-_)
607 outputs the Hebrew characters in the range [aleph..aleph+26].
608 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
609 See |rileft.txt|.
610
611 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
612'allowrevins' 'ari' boolean (default off)
613 global
614 {not in Vi}
615 {only available when compiled with the |+rightleft|
616 feature}
617 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
618 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
619 into reverse Insert mode, and don't know how to get out. See
620 'revins'.
621 NOTE: This option is reset when 'compatible' is set.
622
623 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
624'altkeymap' 'akm' boolean (default off)
625 global
626 {not in Vi}
627 {only available when compiled with the |+farsi|
628 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000629 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000630 the keyboard map between Farsi and English, when 'allowrevins' set.
631
Bram Moolenaar582fd852005-03-28 20:58:01 +0000632 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633 is useful to start the Vim in native mode i.e. English (left-to-right
634 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000635 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000636
637 *'ambiwidth'* *'ambw'*
638'ambiwidth' 'ambw' string (default: "single")
639 global
640 {not in Vi}
641 {only available when compiled with the |+multi_byte|
642 feature}
643 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
644 Tells Vim what to do with characters with East Asian Width Class
645 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
646 letters, Cyrillic letters).
647
648 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000649 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 expected by most users.
651 "double": Use twice the width of ASCII characters.
652
653 There are a number of CJK fonts for which the width of glyphs for
654 those characters are solely based on how many octets they take in
655 legacy/traditional CJK encodings. In those encodings, Euro,
656 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000657 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000658 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000659 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000660 Vim is running inside a terminal (emulators) that uses a CJK font
661 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
662 this option should be set to "double" to match the width perceived
663 by Vim with the width of glyphs in the font. Perhaps it also has
664 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
665 when the system locale is set to one of CJK locales. See Unicode
666 Standard Annex #11 (http://www.unicode.org/reports/tr11).
667
668 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
669'antialias' 'anti' boolean (default: off)
670 global
671 {not in Vi}
672 {only available when compiled with GUI enabled
673 on Mac OS X}
674 This option only has an effect in the GUI version of Vim on Mac OS X
675 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
676 which can be easier to read at certain sizes on certain displays.
677 Setting this option can sometimes cause problems if 'guifont' is set
678 to its default (empty string).
679
680 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
681'autochdir' 'acd' boolean (default off)
682 global
683 {not in Vi}
684 {only available when compiled with the
685 |+netbeans_intg| or |+sun_workshop| feature}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000686 When on, Vim will change the current working directory whenever you
687 open a file, switch buffers, delete a buffer or open/close a window.
688 It will change to the directory containing the file which was opened
689 or selected.
690 This option is provided for backward compatibility with the Vim
691 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000692 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000693
694 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
695'arabic' 'arab' boolean (default off)
696 local to window
697 {not in Vi}
698 {only available when compiled with the |+arabic|
699 feature}
700 This option can be set to start editing Arabic text.
701 Setting this option will:
702 - Set the 'rightleft' option, unless 'termbidi' is set.
703 - Set the 'arabicshape' option, unless 'termbidi' is set.
704 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
705 between typing English and Arabic key mapping.
706 - Set the 'delcombine' option
707 Note that 'encoding' must be "utf-8" for working with Arabic text.
708
709 Resetting this option will:
710 - Reset the 'rightleft' option.
711 - Disable the use of 'keymap' (without changing its value).
712 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
713 option.
714 Also see |arabic.txt|.
715
716 *'arabicshape'* *'arshape'*
717 *'noarabicshape'* *'noarshape'*
718'arabicshape' 'arshape' boolean (default on)
719 global
720 {not in Vi}
721 {only available when compiled with the |+arabic|
722 feature}
723 When on and 'termbidi' is off, the required visual character
724 corrections that need to take place for displaying the Arabic language
725 take affect. Shaping, in essence, gets enabled; the term is a broad
726 one which encompasses:
727 a) the changing/morphing of characters based on their location
728 within a word (initial, medial, final and stand-alone).
729 b) the enabling of the ability to compose characters
730 c) the enabling of the required combining of some characters
731 When disabled the character display reverts back to each character's
732 true stand-alone form.
733 Arabic is a complex language which requires other settings, for
734 further details see |arabic.txt|.
735
736 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
737'autoindent' 'ai' boolean (default off)
738 local to buffer
739 Copy indent from current line when starting a new line (typing <CR>
740 in Insert mode or when using the "o" or "O" command). If you do not
741 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000742 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
743 to another line has the same effect, unless the 'I' flag is included
744 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000745 When autoindent is on, formatting (with the "gq" command or when you
746 reach 'textwidth' in Insert mode) uses the indentation of the first
747 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000748 When 'smartindent' or 'cindent' is on the indent is changed in
749 a different way.
750 The 'autoindent' option is reset when the 'paste' option is set.
751 {small difference from Vi: After the indent is deleted when typing
752 <Esc> or <CR>, the cursor position when moving up or down is after the
753 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
754
755 *'autoread'* *'ar'* *'noautoread'* *'noar'*
756'autoread' 'ar' boolean (default off)
757 global or local to buffer |global-local|
758 {not in Vi}
759 When a file has been detected to have been changed outside of Vim and
760 it has not been changed inside of Vim, automatically read it again.
761 When the file has been deleted this is not done. |timestamp|
762 If this option has a local value, use this command to switch back to
763 using the global value: >
764 :set autoread<
765<
766 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
767'autowrite' 'aw' boolean (default off)
768 global
769 Write the contents of the file, if it has been modified, on each
770 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000771 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000772 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
773 Note that for some commands the 'autowrite' option is not used, see
774 'autowriteall' for that.
775
776 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
777'autowriteall' 'awa' boolean (default off)
778 global
779 {not in Vi}
780 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
781 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
782 Setting this option also implies that Vim behaves like 'autowrite' has
783 been set.
784
785 *'background'* *'bg'*
786'background' 'bg' string (default "dark" or "light")
787 global
788 {not in Vi}
789 When set to "dark", Vim will try to use colors that look good on a
790 dark background. When set to "light", Vim will try to use colors that
791 look good on a light background. Any other value is illegal.
792 Vim tries to set the default value according to the terminal used.
793 This will not always be correct.
794 Setting this option does not change the background color, it tells Vim
795 what the background color looks like. For changing the background
796 color, see |:hi-normal|.
797
798 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000799 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000800 change.
801 When a color scheme is loaded (the "colors_name" variable is set)
802 setting 'background' will cause the color scheme to be reloaded. If
803 the color scheme adjusts to the value of 'background' this will work.
804 However, if the color scheme sets 'background' itself the effect may
805 be undone. First delete the "colors_name" variable when needed.
806
807 When setting 'background' to the default value with: >
808 :set background&
809< Vim will guess the value. In the GUI this should work correctly,
810 in other cases Vim might not be able to guess the right value.
811
812 When starting the GUI, the default value for 'background' will be
813 "light". When the value is not set in the .gvimrc, and Vim detects
814 that the background is actually quite dark, 'background' is set to
815 "dark". But this happens only AFTER the .gvimrc file has been read
816 (because the window needs to be opened to find the actual background
817 color). To get around this, force the GUI window to be opened by
818 putting a ":gui" command in the .gvimrc file, before where the value
819 of 'background' is used (e.g., before ":syntax on").
820 Normally this option would be set in the .vimrc file. Possibly
821 depending on the terminal name. Example: >
822 :if &term == "pcterm"
823 : set background=dark
824 :endif
825< When this option is set, the default settings for the highlight groups
826 will change. To use other settings, place ":highlight" commands AFTER
827 the setting of the 'background' option.
828 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
829 to select the colors for syntax highlighting. After changing this
830 option, you must load syntax.vim again to see the result. This can be
831 done with ":syntax on".
832
833 *'backspace'* *'bs'*
834'backspace' 'bs' string (default "")
835 global
836 {not in Vi}
837 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
838 mode. This is a list of items, separated by commas. Each item allows
839 a way to backspace over something:
840 value effect ~
841 indent allow backspacing over autoindent
842 eol allow backspacing over line breaks (join lines)
843 start allow backspacing over the start of insert; CTRL-W and CTRL-U
844 stop once at the start of insert.
845
846 When the value is empty, Vi compatible backspacing is used.
847
848 For backwards compatibility with version 5.4 and earlier:
849 value effect ~
850 0 same as ":set backspace=" (Vi compatible)
851 1 same as ":set backspace=indent,eol"
852 2 same as ":set backspace=indent,eol,start"
853
854 See |:fixdel| if your <BS> or <Del> key does not do what you want.
855 NOTE: This option is set to "" when 'compatible' is set.
856
857 *'backup'* *'bk'* *'nobackup'* *'nobk'*
858'backup' 'bk' boolean (default off)
859 global
860 {not in Vi}
861 Make a backup before overwriting a file. Leave it around after the
862 file has been successfully written. If you do not want to keep the
863 backup file, but you do want a backup while the file is being
864 written, reset this option and set the 'writebackup' option (this is
865 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000866 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 |backup-table| for more explanations.
868 When the 'backupskip' pattern matches, a backup is not made anyway.
869 When 'patchmode' is set, the backup may be renamed to become the
870 oldest version of a file.
871 NOTE: This option is reset when 'compatible' is set.
872
873 *'backupcopy'* *'bkc'*
874'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
875 global
876 {not in Vi}
877 When writing a file and a backup is made, this option tells how it's
878 done. This is a comma separated list of words.
879
880 The main values are:
881 "yes" make a copy of the file and overwrite the original one
882 "no" rename the file and write a new one
883 "auto" one of the previous, what works best
884
885 Extra values that can be combined with the ones above are:
886 "breaksymlink" always break symlinks when writing
887 "breakhardlink" always break hardlinks when writing
888
889 Making a copy and overwriting the original file:
890 - Takes extra time to copy the file.
891 + When the file has special attributes, is a (hard/symbolic) link or
892 has a resource fork, all this is preserved.
893 - When the file is a link the backup will have the name of the link,
894 not of the real file.
895
896 Renaming the file and writing a new one:
897 + It's fast.
898 - Sometimes not all attributes of the file can be copied to the new
899 file.
900 - When the file is a link the new file will not be a link.
901
902 The "auto" value is the middle way: When Vim sees that renaming file
903 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000904 the file is not a link) that is used. When problems are expected, a
905 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000906
907 The "breaksymlink" and "breakhardlink" values can be used in
908 combination with any of "yes", "no" and "auto". When included, they
909 force Vim to always break either symbolic or hard links by doing
910 exactly what the "no" option does, renaming the original file to
911 become the backup and writing a new file in its place. This can be
912 useful for example in source trees where all the files are symbolic or
913 hard links and any changes should stay in the local source tree, not
914 be propagated back to the original source.
915 *crontab*
916 One situation where "no" and "auto" will cause problems: A program
917 that opens a file, invokes Vim to edit that file, and then tests if
918 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000919 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000920 example.
921
922 When a copy is made, the original file is truncated and then filled
923 with the new text. This means that protection bits, owner and
924 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000925 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000926 group of the backup is set to the group of the original file. If this
927 fails, the protection bits for the group are made the same as for
928 others.
929
930 When the file is renamed this is the other way around: The backup has
931 the same attributes of the original file, and the newly written file
932 is owned by the current user. When the file was a (hard/symbolic)
933 link, the new file will not! That's why the "auto" value doesn't
934 rename when the file is a link. The owner and group of the newly
935 written file will be set to the same ones as the original file, but
936 the system may refuse to do this. In that case the "auto" value will
937 again not rename the file.
938
939 *'backupdir'* *'bdir'*
940'backupdir' 'bdir' string (default for Amiga: ".,t:",
941 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
942 for Unix: ".,~/tmp,~/")
943 global
944 {not in Vi}
945 List of directories for the backup file, separated with commas.
946 - The backup file will be created in the first directory in the list
947 where this is possible.
948 - Empty means that no backup file will be created ('patchmode' is
949 impossible!). Writing may fail because of this.
950 - A directory "." means to put the backup file in the same directory
951 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000952 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000953 put the backup file relative to where the edited file is. The
954 leading "." is replaced with the path name of the edited file.
955 ("." inside a directory name has no special meaning).
956 - Spaces after the comma are ignored, other spaces are considered part
957 of the directory name. To have a space at the start of a directory
958 name, precede it with a backslash.
959 - To include a comma in a directory name precede it with a backslash.
960 - A directory name may end in an '/'.
961 - Environment variables are expanded |:set_env|.
962 - Careful with '\' characters, type one before a space, type two to
963 get one in the option (see |option-backslash|), for example: >
964 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
965< - For backwards compatibility with Vim version 3.0 a '>' at the start
966 of the option is removed.
967 See also 'backup' and 'writebackup' options.
968 If you want to hide your backup files on Unix, consider this value: >
969 :set backupdir=./.backup,~/.backup,.,/tmp
970< You must create a ".backup" directory in each directory and in your
971 home directory for this to work properly.
972 The use of |:set+=| and |:set-=| is preferred when adding or removing
973 directories from the list. This avoids problems when a future version
974 uses another default.
975 This option cannot be set from a |modeline| or in the |sandbox|, for
976 security reasons.
977
978 *'backupext'* *'bex'* *E589*
979'backupext' 'bex' string (default "~", for VMS: "_")
980 global
981 {not in Vi}
982 String which is appended to a file name to make the name of the
983 backup file. The default is quite unusual, because this avoids
984 accidentally overwriting existing files with a backup file. You might
985 prefer using ".bak", but make sure that you don't have files with
986 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000987 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000988
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +0000989 If you like to keep a lot of backups, you could use a BufWritePre
990 autocommand to change 'backupext' just before writing the file to
991 include a timestamp. >
992 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
993< Use 'backupdir' to put the backup in a different directory.
994
Bram Moolenaar071d4272004-06-13 20:20:40 +0000995 *'backupskip'* *'bsk'*
996'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
997 global
998 {not in Vi}
999 {not available when compiled without the |+wildignore|
1000 feature}
1001 A list of file patterns. When one of the patterns matches with the
1002 name of the file which is written, no backup file is created. Both
1003 the specified file name and the full path name of the file are used.
1004 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1005 Watch out for special characters, see |option-backslash|.
1006 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001007 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001008
1009 Note that environment variables are not expanded. If you want to use
1010 $HOME you must expand it explicitly, e.g.: >
1011 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1012
1013< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001014 backup would be made by renaming the original file crontab won't see
1015 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001016
1017 *'balloondelay'* *'bdlay'*
1018'balloondelay' 'bdlay' number (default: 600)
1019 global
1020 {not in Vi}
1021 {only available when compiled with the |+balloon_eval|
1022 feature}
1023 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1024
1025 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1026'ballooneval' 'beval' boolean (default off)
1027 global
1028 {not in Vi}
1029 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001030 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001031 Switch on the |balloon-eval| functionality.
1032
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001033 *'balloonexpr'* *'bexpr'*
1034'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001035 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001036 {not in Vi}
1037 {only available when compiled with the |+balloon_eval|
1038 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001039 Expression for text to show in evaluation balloon. It is only used
1040 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001041
1042 v:beval_bufnr number of the buffer in which balloon is going to show
1043 v:beval_winnr number of the window
1044 v:beval_lnum line number
1045 v:beval_col column number (byte index)
1046 v:beval_text word under or after the mouse pointer
1047
1048 The evaluation of the expression must not have side effects!
1049 Example: >
1050 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001051 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001052 \', column ' . v:beval_col .
1053 \ ' of file ' . bufname(v:beval_bufnr) .
1054 \ ' on word "' . v:beval_text . '"'
1055 endfunction
1056 set bexpr=MyBalloonExpr()
1057 set ballooneval
1058<
1059 NOTE: The balloon is displayed only if the cursor is on a text
1060 character. If the result of evaluating 'balloonexpr' is not empty,
1061 Vim does not try to send a message to an external debugger (Netbeans
1062 or Sun Workshop).
1063
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001064 The expression may be evaluated in the |sandbox|, see
1065 |sandbox-option|.
1066
1067 It is not allowed to change text or jump to another window while
1068 evaluating 'balloonexpr' |textlock|.
1069
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001070 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001071 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001072< When they are supported "\n" characters will start a new line. If the
1073 expression evaluates to a |List| this is equal to using each List item
1074 as a string and putting "\n" in between them.
1075
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1077'binary' 'bin' boolean (default off)
1078 local to buffer
1079 {not in Vi}
1080 This option should be set before editing a binary file. You can also
1081 use the |-b| Vim argument. When this option is switched on a few
1082 options will be changed (also when it already was on):
1083 'textwidth' will be set to 0
1084 'wrapmargin' will be set to 0
1085 'modeline' will be off
1086 'expandtab' will be off
1087 Also, 'fileformat' and 'fileformats' options will not be used, the
1088 file is read and written like 'fileformat' was "unix" (a single <NL>
1089 separates lines).
1090 The 'fileencoding' and 'fileencodings' options will not be used, the
1091 file is read without conversion.
1092 NOTE: When you start editing a(nother) file while the 'bin' option is
1093 on, settings from autocommands may change the settings again (e.g.,
1094 'textwidth'), causing trouble when editing. You might want to set
1095 'bin' again when the file has been loaded.
1096 The previous values of these options are remembered and restored when
1097 'bin' is switched from on to off. Each buffer has its own set of
1098 saved option values.
1099 To edit a file with 'binary' set you can use the |++bin| argument.
1100 This avoids you have to do ":set bin", which would have effect for all
1101 files you edit.
1102 When writing a file the <EOL> for the last line is only written if
1103 there was one in the original file (normally Vim appends an <EOL> to
1104 the last line if there is none; this would make the file longer). See
1105 the 'endofline' option.
1106
1107 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1108'bioskey' 'biosk' boolean (default on)
1109 global
1110 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001111 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001112 better to detect CTRL-C, but only works for the console. When using a
1113 terminal over a serial port reset this option.
1114 Also see |'conskey'|.
1115
1116 *'bomb'* *'nobomb'*
1117'bomb' boolean (default off)
1118 local to buffer
1119 {not in Vi}
1120 {only available when compiled with the |+multi_byte|
1121 feature}
1122 When writing a file and the following conditions are met, a BOM (Byte
1123 Order Mark) is prepended to the file:
1124 - this option is on
1125 - the 'binary' option is off
1126 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1127 endian variants.
1128 Some applications use the BOM to recognize the encoding of the file.
1129 Often used for UCS-2 files on MS-Windows. For other applications it
1130 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1131 appear halfway the resulting file.
1132 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1133 check for the presence of the BOM is done and 'bomb' set accordingly.
1134 Unless 'binary' is set, it is removed from the first line, so that you
1135 don't see it when editing. When you don't change the options, the BOM
1136 will be restored when writing the file.
1137
1138 *'breakat'* *'brk'*
1139'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1140 global
1141 {not in Vi}
1142 {not available when compiled without the |+linebreak|
1143 feature}
1144 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001145 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1146 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001147
1148 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001149'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001150 global
1151 {not in Vi} {only for Motif and Win32 GUI}
1152 Which directory to use for the file browser:
1153 last Use same directory as with last file browser.
1154 buffer Use the directory of the related buffer.
1155 current Use the current directory.
1156 {path} Use the specified directory
1157
1158 *'bufhidden'* *'bh'*
1159'bufhidden' 'bh' string (default: "")
1160 local to buffer
1161 {not in Vi}
1162 {not available when compiled without the |+quickfix|
1163 feature}
1164 This option specifies what happens when a buffer is no longer
1165 displayed in a window:
1166 <empty> follow the global 'hidden' option
1167 hide hide the buffer (don't unload it), also when 'hidden'
1168 is not set
1169 unload unload the buffer, also when 'hidden' is set or using
1170 |:hide|
1171 delete delete the buffer from the buffer list, also when
1172 'hidden' is set or using |:hide|, like using
1173 |:bdelete|
1174 wipe wipe out the buffer from the buffer list, also when
1175 'hidden' is set or using |:hide|, like using
1176 |:bwipeout|
1177
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001178 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1179 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001180 This option is used together with 'buftype' and 'swapfile' to specify
1181 special kinds of buffers. See |special-buffers|.
1182
1183 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1184'buflisted' 'bl' boolean (default: on)
1185 local to buffer
1186 {not in Vi}
1187 When this option is set, the buffer shows up in the buffer list. If
1188 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1189 This option is reset by Vim for buffers that are only used to remember
1190 a file name or marks. Vim sets it when starting to edit a buffer.
1191 But not when moving to a buffer with ":buffer".
1192
1193 *'buftype'* *'bt'* *E382*
1194'buftype' 'bt' string (default: "")
1195 local to buffer
1196 {not in Vi}
1197 {not available when compiled without the |+quickfix|
1198 feature}
1199 The value of this option specifies the type of a buffer:
1200 <empty> normal buffer
1201 nofile buffer which is not related to a file and will not be
1202 written
1203 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001204 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001205 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001206 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001207 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001208 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001209 help help buffer (you are not supposed to set this
1210 manually)
1211
1212 This option is used together with 'bufhidden' and 'swapfile' to
1213 specify special kinds of buffers. See |special-buffers|.
1214
1215 Be careful with changing this option, it can have many side effects!
1216
Bram Moolenaar280f1262006-01-30 00:14:18 +00001217 A "quickfix" buffer is only used for the error list and the location
1218 list. This value is set by the |:cwindow| and |:lwindow| commands and
1219 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001220
1221 "nofile" and "nowrite" buffers are similar:
1222 both: The buffer is not to be written to disk, ":w" doesn't
1223 work (":w filename" does work though).
1224 both: The buffer is never considered to be |'modified'|.
1225 There is no warning when the changes will be lost, for
1226 example when you quit Vim.
1227 both: A swap file is only created when using too much memory
1228 (when 'swapfile' has been reset there is never a swap
1229 file).
1230 nofile only: The buffer name is fixed, it is not handled like a
1231 file name. It is not modified in response to a |:cd|
1232 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001233 *E676*
1234 "acwrite" implies that the buffer name is not related to a file, like
1235 "nofile", but it will be written. Thus, in contrast to "nofile" and
1236 "nowrite", ":w" does work and a modified buffer can't be abandoned
1237 without saving. For writing there must be matching |BufWriteCmd|,
1238 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 *'casemap'* *'cmp'*
1241'casemap' 'cmp' string (default: "internal,keepascii")
1242 global
1243 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001244 {only available when compiled with the |+multi_byte|
1245 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001246 Specifies details about changing the case of letters. It may contain
1247 these words, separated by a comma:
1248 internal Use internal case mapping functions, the current
1249 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001250 matters when 'encoding' is a Unicode encoding,
1251 "latin1" or "iso-8859-15". When "internal" is
1252 omitted, the towupper() and towlower() system library
1253 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1255 case mapping, the current locale is not effective.
1256 This probably only matters for Turkish.
1257
1258 *'cdpath'* *'cd'* *E344* *E346*
1259'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1260 global
1261 {not in Vi}
1262 {not available when compiled without the
1263 |+file_in_path| feature}
1264 This is a list of directories which will be searched when using the
1265 |:cd| and |:lcd| commands, provided that the directory being searched
1266 for has a relative path (not starting with "/", "./" or "../").
1267 The 'cdpath' option's value has the same form and semantics as
1268 |'path'|. Also see |file-searching|.
1269 The default value is taken from $CDPATH, with a "," prepended to look
1270 in the current directory first.
1271 If the default value taken from $CDPATH is not what you want, include
1272 a modified version of the following command in your vimrc file to
1273 override it: >
1274 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1275< This option cannot be set from a |modeline| or in the |sandbox|, for
1276 security reasons.
1277 (parts of 'cdpath' can be passed to the shell to expand file names).
1278
1279 *'cedit'*
1280'cedit' string (Vi default: "", Vim default: CTRL-F)
1281 global
1282 {not in Vi}
1283 {not available when compiled without the |+vertsplit|
1284 feature}
1285 The key used in Command-line Mode to open the command-line window.
1286 The default is CTRL-F when 'compatible' is off.
1287 Only non-printable keys are allowed.
1288 The key can be specified as a single character, but it is difficult to
1289 type. The preferred way is to use the <> notation. Examples: >
1290 :set cedit=<C-Y>
1291 :set cedit=<Esc>
1292< |Nvi| also has this option, but it only uses the first character.
1293 See |cmdwin|.
1294
1295 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1296'charconvert' 'ccv' string (default "")
1297 global
1298 {only available when compiled with the |+multi_byte|
1299 feature and the |+eval| feature}
1300 {not in Vi}
1301 An expression that is used for character encoding conversion. It is
1302 evaluated when a file that is to be read or has been written has a
1303 different encoding from what is desired.
1304 'charconvert' is not used when the internal iconv() function is
1305 supported and is able to do the conversion. Using iconv() is
1306 preferred, because it is much faster.
1307 'charconvert' is not used when reading stdin |--|, because there is no
1308 file to convert from. You will have to save the text in a file first.
1309 The expression must return zero or an empty string for success,
1310 non-zero for failure.
1311 The possible encoding names encountered are in 'encoding'.
1312 Additionally, names given in 'fileencodings' and 'fileencoding' are
1313 used.
1314 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1315 is done internally by Vim, 'charconvert' is not used for this.
1316 'charconvert' is also used to convert the viminfo file, if the 'c'
1317 flag is present in 'viminfo'. Also used for Unicode conversion.
1318 Example: >
1319 set charconvert=CharConvert()
1320 fun CharConvert()
1321 system("recode "
1322 \ . v:charconvert_from . ".." . v:charconvert_to
1323 \ . " <" . v:fname_in . " >" v:fname_out)
1324 return v:shell_error
1325 endfun
1326< The related Vim variables are:
1327 v:charconvert_from name of the current encoding
1328 v:charconvert_to name of the desired encoding
1329 v:fname_in name of the input file
1330 v:fname_out name of the output file
1331 Note that v:fname_in and v:fname_out will never be the same.
1332 Note that v:charconvert_from and v:charconvert_to may be different
1333 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1334 Encryption is not done by Vim when using 'charconvert'. If you want
1335 to encrypt the file after conversion, 'charconvert' should take care
1336 of this.
1337 This option cannot be set from a |modeline| or in the |sandbox|, for
1338 security reasons.
1339
1340 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1341'cindent' 'cin' boolean (default off)
1342 local to buffer
1343 {not in Vi}
1344 {not available when compiled without the |+cindent|
1345 feature}
1346 Enables automatic C program indenting See 'cinkeys' to set the keys
1347 that trigger reindenting in insert mode and 'cinoptions' to set your
1348 preferred indent style.
1349 If 'indentexpr' is not empty, it overrules 'cindent'.
1350 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1351 the "=" operator indents using this algorithm rather than calling an
1352 external program.
1353 See |C-indenting|.
1354 When you don't like the way 'cindent' works, try the 'smartindent'
1355 option or 'indentexpr'.
1356 This option is not used when 'paste' is set.
1357 NOTE: This option is reset when 'compatible' is set.
1358
1359 *'cinkeys'* *'cink'*
1360'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1361 local to buffer
1362 {not in Vi}
1363 {not available when compiled without the |+cindent|
1364 feature}
1365 A list of keys that, when typed in Insert mode, cause reindenting of
1366 the current line. Only used if 'cindent' is on and 'indentexpr' is
1367 empty.
1368 For the format of this option see |cinkeys-format|.
1369 See |C-indenting|.
1370
1371 *'cinoptions'* *'cino'*
1372'cinoptions' 'cino' string (default "")
1373 local to buffer
1374 {not in Vi}
1375 {not available when compiled without the |+cindent|
1376 feature}
1377 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1378 program. See |cinoptions-values| for the values of this option, and
1379 |C-indenting| for info on C indenting in general.
1380
1381
1382 *'cinwords'* *'cinw'*
1383'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1384 local to buffer
1385 {not in Vi}
1386 {not available when compiled without both the
1387 |+cindent| and the |+smartindent| features}
1388 These keywords start an extra indent in the next line when
1389 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1390 an appropriate place (inside {}).
1391 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1392 matter, include the keyword both the uppercase and lowercase:
1393 "if,If,IF".
1394
1395 *'clipboard'* *'cb'*
1396'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1397 for X-windows, "" otherwise)
1398 global
1399 {not in Vi}
1400 {only in GUI versions or when the |+xterm_clipboard|
1401 feature is included}
1402 This option is a list of comma separated names.
1403 These names are recognized:
1404
1405 unnamed When included, Vim will use the clipboard register '*'
1406 for all yank, delete, change and put operations which
1407 would normally go to the unnamed register. When a
1408 register is explicitly specified, it will always be
1409 used regardless of whether "unnamed" is in 'clipboard'
1410 or not. The clipboard register can always be
1411 explicitly accessed using the "* notation. Also see
1412 |gui-clipboard|.
1413
1414 autoselect Works like the 'a' flag in 'guioptions': If present,
1415 then whenever Visual mode is started, or the Visual
1416 area extended, Vim tries to become the owner of the
1417 windowing system's global selection or put the
1418 selected text on the clipboard used by the selection
1419 register "*. See |guioptions_a| and |quotestar| for
1420 details. When the GUI is active, the 'a' flag in
1421 'guioptions' is used, when the GUI is not active, this
1422 "autoselect" flag is used.
1423 Also applies to the modeless selection.
1424
1425 autoselectml Like "autoselect", but for the modeless selection
1426 only. Compare to the 'A' flag in 'guioptions'.
1427
1428 exclude:{pattern}
1429 Defines a pattern that is matched against the name of
1430 the terminal 'term'. If there is a match, no
1431 connection will be made to the X server. This is
1432 useful in this situation:
1433 - Running Vim in a console.
1434 - $DISPLAY is set to start applications on another
1435 display.
1436 - You do not want to connect to the X server in the
1437 console, but do want this in a terminal emulator.
1438 To never connect to the X server use: >
1439 exclude:.*
1440< This has the same effect as using the |-X| argument.
1441 Note that when there is no connection to the X server
1442 the window title won't be restored and the clipboard
1443 cannot be accessed.
1444 The value of 'magic' is ignored, {pattern} is
1445 interpreted as if 'magic' was on.
1446 The rest of the option value will be used for
1447 {pattern}, this must be the last entry.
1448
1449 *'cmdheight'* *'ch'*
1450'cmdheight' 'ch' number (default 1)
1451 global
1452 {not in Vi}
1453 Number of screen lines to use for the command-line. Helps avoiding
1454 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001455 The value of this option is stored with the tab page, so that each tab
1456 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457
1458 *'cmdwinheight'* *'cwh'*
1459'cmdwinheight' 'cwh' number (default 7)
1460 global
1461 {not in Vi}
1462 {not available when compiled without the |+vertsplit|
1463 feature}
1464 Number of screen lines to use for the command-line window. |cmdwin|
1465
1466 *'columns'* *'co'* *E594*
1467'columns' 'co' number (default 80 or terminal width)
1468 global
1469 {not in Vi}
1470 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001471 initialization and does not have to be set by hand. Also see
1472 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001473 When Vim is running in the GUI or in a resizable window, setting this
1474 option will cause the window size to be changed. When you only want
1475 to use the size for the GUI, put the command in your |gvimrc| file.
1476 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001477 number of columns of the display, the display may be messed up. For
1478 the GUI it is always possible and Vim limits the number of columns to
1479 what fits on the screen. You can use this command to get the widest
1480 window possible: >
1481 :set columns=9999
1482< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001483
1484 *'comments'* *'com'* *E524* *E525*
1485'comments' 'com' string (default
1486 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1487 local to buffer
1488 {not in Vi}
1489 {not available when compiled without the |+comments|
1490 feature}
1491 A comma separated list of strings that can start a comment line. See
1492 |format-comments|. See |option-backslash| about using backslashes to
1493 insert a space.
1494
1495 *'commentstring'* *'cms'* *E537*
1496'commentstring' 'cms' string (default "/*%s*/")
1497 local to buffer
1498 {not in Vi}
1499 {not available when compiled without the |+folding|
1500 feature}
1501 A template for a comment. The "%s" in the value is replaced with the
1502 comment text. Currently only used to add markers for folding, see
1503 |fold-marker|.
1504
1505 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001506'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1507 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001508 global
1509 {not in Vi}
1510 This option has the effect of making Vim either more Vi-compatible, or
1511 make Vim behave in a more useful way.
1512 This is a special kind of option, because when it's set or reset,
1513 other options are also changed as a side effect. CAREFUL: Setting or
1514 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001515 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001516 set this option in your vimrc file, you should probably put it at the
1517 very start.
1518 By default this option is on and the Vi defaults are used for the
1519 options. This default was chosen for those people who want to use Vim
1520 just like Vi, and don't even (want to) know about the 'compatible'
1521 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001522 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001523 this option is switched off, and all options that have not been
1524 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001525 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001526 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001527 happen for the system-wide vimrc or gvimrc file, nor for a file given
1528 with the |-u| argument). Also see |compatible-default| and
1529 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 You can also set this option with the "-C" argument, and reset it with
1531 "-N". See |-C| and |-N|.
1532 Switching this option off makes the Vim defaults be used for options
1533 that have a different Vi and Vim default value. See the options
1534 marked with a '+' below. Other options are not modified.
1535 At the moment this option is set, several other options will be set
1536 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001537 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001538 editing.
1539 See also 'cpoptions'.
1540
1541 option + set value effect ~
1542
1543 'allowrevins' off no CTRL-_ command
1544 'backupcopy' Unix: "yes" backup file is a copy
1545 others: "auto" copy or rename backup file
1546 'backspace' "" normal backspace
1547 'backup' off no backup file
1548 'cindent' off no C code indentation
1549 'cedit' + "" no key to open the |cmdwin|
1550 'cpoptions' + (all flags) Vi-compatible flags
1551 'cscopetag' off don't use cscope for ":tag"
1552 'cscopetagorder' 0 see |cscopetagorder|
1553 'cscopeverbose' off see |cscopeverbose|
1554 'digraph' off no digraphs
1555 'esckeys' + off no <Esc>-keys in Insert mode
1556 'expandtab' off tabs not expanded to spaces
1557 'fileformats' + "" no automatic file format detection,
1558 "dos,unix" except for DOS, Windows and OS/2
1559 'formatoptions' + "vt" Vi compatible formatting
1560 'gdefault' off no default 'g' flag for ":s"
1561 'history' + 0 no commandline history
1562 'hkmap' off no Hebrew keyboard mapping
1563 'hkmapp' off no phonetic Hebrew keyboard mapping
1564 'hlsearch' off no highlighting of search matches
1565 'incsearch' off no incremental searching
1566 'indentexpr' "" no indenting by expression
1567 'insertmode' off do not start in Insert mode
1568 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1569 characters and '_'
1570 'joinspaces' on insert 2 spaces after period
1571 'modeline' + off no modelines
1572 'more' + off no pauses in listings
1573 'revins' off no reverse insert
1574 'ruler' off no ruler
1575 'scrolljump' 1 no jump scroll
1576 'scrolloff' 0 no scroll offset
1577 'shiftround' off indent not rounded to shiftwidth
1578 'shortmess' + "" no shortening of messages
1579 'showcmd' + off command characters not shown
1580 'showmode' + off current mode not shown
1581 'smartcase' off no automatic ignore case switch
1582 'smartindent' off no smart indentation
1583 'smarttab' off no smart tab size
1584 'softtabstop' 0 tabs are always 'tabstop' positions
1585 'startofline' on goto startofline with some commands
1586 'tagrelative' + off tag file names are not relative
1587 'textauto' + off no automatic textmode detection
1588 'textwidth' 0 no automatic line wrap
1589 'tildeop' off tilde is not an operator
1590 'ttimeout' off no terminal timeout
1591 'whichwrap' + "" left-right movements don't wrap
1592 'wildchar' + CTRL-E only when the current value is <Tab>
1593 use CTRL-E for cmdline completion
1594 'writebackup' on or off depends on +writebackup feature
1595
1596 *'complete'* *'cpt'* *E535*
1597'complete' 'cpt' string (default: ".,w,b,u,t,i")
1598 local to buffer
1599 {not in Vi}
1600 This option specifies how keyword completion |ins-completion| works
1601 when CTRL-P or CTRL-N are used. It is also used for whole-line
1602 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1603 and the places to scan. It is a comma separated list of flags:
1604 . scan the current buffer ('wrapscan' is ignored)
1605 w scan buffers from other windows
1606 b scan other loaded buffers that are in the buffer list
1607 u scan the unloaded buffers that are in the buffer list
1608 U scan the buffers that are not in the buffer list
1609 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001610 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001611 k{dict} scan the file {dict}. Several "k" flags can be given,
1612 patterns are valid too. For example: >
1613 :set cpt=k/usr/dict/*,k~/spanish
1614< s scan the files given with the 'thesaurus' option
1615 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1616 are valid too.
1617 i scan current and included files
1618 d scan current and included files for defined name or macro
1619 |i_CTRL-X_CTRL-D|
1620 ] tag completion
1621 t same as "]"
1622
1623 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1624 not executed, this may lead to unexpected completions from some files
1625 (gzipped files for example). Unloaded buffers are not scanned for
1626 whole-line completion.
1627
1628 The default is ".,w,b,u,t,i", which means to scan:
1629 1. the current buffer
1630 2. buffers in other windows
1631 3. other loaded buffers
1632 4. unloaded buffers
1633 5. tags
1634 6. included files
1635
1636 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001637 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1638 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001640 *'completefunc'* *'cfu'*
1641'completefunc' 'cfu' string (default: empty)
1642 local to buffer
1643 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001644 {not available when compiled without the +eval
1645 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001646 This option specifies a function to be used for Insert mode completion
1647 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001648 See |complete-functions| for an explanation of how the function is
1649 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001650
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001651
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001652 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001653'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001654 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001655 {not available when compiled without the
1656 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001657 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001658 A comma separated list of options for Insert mode completion
1659 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001660
1661 menu Use a popup menu to show the possible completions. The
1662 menu is only shown when there is more than one match and
1663 sufficient colors are available. |ins-completion-menu|
1664
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001665 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001666 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001667 match, e.g., what file it comes from.
1668
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001669 longest Only insert the longest common text of the matches. If
1670 the menu is displayed you can use CTRL-L to add more
1671 characters. Whether case is ignored depends on the kind
1672 of completion. For buffer text the 'ignorecase' option is
1673 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001674
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001675 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001676 completion in the preview window. Only works in
1677 combination with "menu" or "menuone".
1678
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001679
Bram Moolenaar071d4272004-06-13 20:20:40 +00001680 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1681'confirm' 'cf' boolean (default off)
1682 global
1683 {not in Vi}
1684 When 'confirm' is on, certain operations that would normally
1685 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1686 instead raise a |dialog| asking if you wish to save the current
1687 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1688 If 'confirm' is off you can still activate confirmation for one
1689 command only (this is most useful in mappings) with the |:confirm|
1690 command.
1691 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1692
1693 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1694'conskey' 'consk' boolean (default off)
1695 global
1696 {not in Vi} {only for MS-DOS}
1697 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001698 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001699 three methods of console input are available:
1700 'conskey' 'bioskey' action ~
1701 on on or off direct console input
1702 off on BIOS
1703 off off STDIN
1704
1705 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1706'copyindent' 'ci' boolean (default off)
1707 local to buffer
1708 {not in Vi}
1709 Copy the structure of the existing lines indent when autoindenting a
1710 new line. Normally the new indent is reconstructed by a series of
1711 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1712 in which case only spaces are used). Enabling this option makes the
1713 new line copy whatever characters were used for indenting on the
1714 existing line. If the new indent is greater than on the existing
1715 line, the remaining space is filled in the normal manner.
1716 NOTE: 'copyindent' is reset when 'compatible' is set.
1717 Also see 'preserveindent'.
1718
1719 *'cpoptions'* *'cpo'*
1720'cpoptions' 'cpo' string (Vim default: "aABceFs",
1721 Vi default: all flags)
1722 global
1723 {not in Vi}
1724 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001725 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001726 not being vi-compatible is mostly or sometimes preferred.
1727 'cpoptions' stands for "compatible-options".
1728 Commas can be added for readability.
1729 To avoid problems with flags that are added in the future, use the
1730 "+=" and "-=" feature of ":set" |add-option-flags|.
1731 NOTE: This option is set to the Vi default value when 'compatible' is
1732 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001733 NOTE: This option is set to the POSIX default value at startup when
1734 the Vi default value would be used and the $VIM_POSIX environment
1735 variable exists |posix|. This means tries to behave like the POSIX
1736 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001737
1738 contains behavior ~
1739 *cpo-a*
1740 a When included, a ":read" command with a file name
1741 argument will set the alternate file name for the
1742 current window.
1743 *cpo-A*
1744 A When included, a ":write" command with a file name
1745 argument will set the alternate file name for the
1746 current window.
1747 *cpo-b*
1748 b "\|" in a ":map" command is recognized as the end of
1749 the map command. The '\' is included in the mapping,
1750 the text after the '|' is interpreted as the next
1751 command. Use a CTRL-V instead of a backslash to
1752 include the '|' in the mapping. Applies to all
1753 mapping, abbreviation, menu and autocmd commands.
1754 See also |map_bar|.
1755 *cpo-B*
1756 B A backslash has no special meaning in mappings,
1757 abbreviations and the "to" part of the menu commands.
1758 Remove this flag to be able to use a backslash like a
1759 CTRL-V. For example, the command ":map X \<Esc>"
1760 results in X being mapped to:
1761 'B' included: "\^[" (^[ is a real <Esc>)
1762 'B' excluded: "<Esc>" (5 characters)
1763 ('<' excluded in both cases)
1764 *cpo-c*
1765 c Searching continues at the end of any match at the
1766 cursor position, but not further than the start of the
1767 next line. When not present searching continues
1768 one character from the cursor position. With 'c'
1769 "abababababab" only gets three matches when repeating
1770 "/abab", without 'c' there are five matches.
1771 *cpo-C*
1772 C Do not concatenate sourced lines that start with a
1773 backslash. See |line-continuation|.
1774 *cpo-d*
1775 d Using "./" in the 'tags' option doesn't mean to use
1776 the tags file relative to the current file, but the
1777 tags file in the current directory.
1778 *cpo-D*
1779 D Can't use CTRL-K to enter a digraph after Normal mode
1780 commands with a character argument, like |r|, |f| and
1781 |t|.
1782 *cpo-e*
1783 e When executing a register with ":@r", always add a
1784 <CR> to the last line, also when the register is not
1785 linewise. If this flag is not present, the register
1786 is not linewise and the last line does not end in a
1787 <CR>, then the last line is put on the command-line
1788 and can be edited before hitting <CR>.
1789 *cpo-E*
1790 E It is an error when using "y", "d", "c", "g~", "gu" or
1791 "gU" on an Empty region. The operators only work when
1792 at least one character is to be operate on. Example:
1793 This makes "y0" fail in the first column.
1794 *cpo-f*
1795 f When included, a ":read" command with a file name
1796 argument will set the file name for the current buffer,
1797 if the current buffer doesn't have a file name yet.
1798 *cpo-F*
1799 F When included, a ":write" command with a file name
1800 argument will set the file name for the current
1801 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001802 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 *cpo-g*
1804 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001805 *cpo-H*
1806 H When using "I" on a line with only blanks, insert
1807 before the last blank. Without this flag insert after
1808 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 *cpo-i*
1810 i When included, interrupting the reading of a file will
1811 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001812 *cpo-I*
1813 I When moving the cursor up or down just after inserting
1814 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001815 *cpo-j*
1816 j When joining lines, only add two spaces after a '.',
1817 not after '!' or '?'. Also see 'joinspaces'.
1818 *cpo-J*
1819 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001820 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 white space.
1822 *cpo-k*
1823 k Disable the recognition of raw key codes in
1824 mappings, abbreviations, and the "to" part of menu
1825 commands. For example, if <Key> sends ^[OA (where ^[
1826 is <Esc>), the command ":map X ^[OA" results in X
1827 being mapped to:
1828 'k' included: "^[OA" (3 characters)
1829 'k' excluded: "<Key>" (one key code)
1830 Also see the '<' flag below.
1831 *cpo-K*
1832 K Don't wait for a key code to complete when it is
1833 halfway a mapping. This breaks mapping <F1><F1> when
1834 only part of the second <F1> has been read. It
1835 enables cancelling the mapping by typing <F1><Esc>.
1836 *cpo-l*
1837 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001838 literally, only "\]", "\^", "\-" and "\\" are special.
1839 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1841 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001842 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001843 *cpo-L*
1844 L When the 'list' option is set, 'wrapmargin',
1845 'textwidth', 'softtabstop' and Virtual Replace mode
1846 (see |gR|) count a <Tab> as two characters, instead of
1847 the normal behavior of a <Tab>.
1848 *cpo-m*
1849 m When included, a showmatch will always wait half a
1850 second. When not included, a showmatch will wait half
1851 a second or until a character is typed. |'showmatch'|
1852 *cpo-M*
1853 M When excluded, "%" matching will take backslashes into
1854 account. Thus in "( \( )" and "\( ( \)" the outer
1855 parenthesis match. When included "%" ignores
1856 backslashes, which is Vi compatible.
1857 *cpo-n*
1858 n When included, the column used for 'number' will also
1859 be used for text of wrapped lines.
1860 *cpo-o*
1861 o Line offset to search command is not remembered for
1862 next search.
1863 *cpo-O*
1864 O Don't complain if a file is being overwritten, even
1865 when it didn't exist when editing it. This is a
1866 protection against a file unexpectedly created by
1867 someone else. Vi didn't complain about this.
1868 *cpo-p*
1869 p Vi compatible Lisp indenting. When not present, a
1870 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001871 *cpo-P*
1872 P When included, a ":write" command that appends to a
1873 file will set the file name for the current buffer, if
1874 the current buffer doesn't have a file name yet and
1875 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001876 *cpo-q*
1877 q When joining multiple lines leave the cursor at the
1878 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001879 *cpo-r*
1880 r Redo ("." command) uses "/" to repeat a search
1881 command, instead of the actually used search string.
1882 *cpo-R*
1883 R Remove marks from filtered lines. Without this flag
1884 marks are kept like |:keepmarks| was used.
1885 *cpo-s*
1886 s Set buffer options when entering the buffer for the
1887 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001888 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001889 set when the buffer is created.
1890 *cpo-S*
1891 S Set buffer options always when entering a buffer
1892 (except 'readonly', 'fileformat', 'filetype' and
1893 'syntax'). This is the (most) Vi compatible setting.
1894 The options are set to the values in the current
1895 buffer. When you change an option and go to another
1896 buffer, the value is copied. Effectively makes the
1897 buffer options global to all buffers.
1898
1899 's' 'S' copy buffer options
1900 no no when buffer created
1901 yes no when buffer first entered (default)
1902 X yes each time when buffer entered (vi comp.)
1903 *cpo-t*
1904 t Search pattern for the tag command is remembered for
1905 "n" command. Otherwise Vim only puts the pattern in
1906 the history for search pattern, but doesn't change the
1907 last used search pattern.
1908 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001909 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001910 *cpo-v*
1911 v Backspaced characters remain visible on the screen in
1912 Insert mode. Without this flag the characters are
1913 erased from the screen right away. With this flag the
1914 screen newly typed text overwrites backspaced
1915 characters.
1916 *cpo-w*
1917 w When using "cw" on a blank character, only change one
1918 character and not all blanks until the start of the
1919 next word.
1920 *cpo-W*
1921 W Don't overwrite a readonly file. When omitted, ":w!"
1922 overwrites a readonly file, if possible.
1923 *cpo-x*
1924 x <Esc> on the command-line executes the command-line.
1925 The default in Vim is to abandon the command-line,
1926 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001927 *cpo-X*
1928 X When using a count with "R" the replaced text is
1929 deleted only once. Also when repeating "R" with "."
1930 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001931 *cpo-y*
1932 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001933 *cpo-Z*
1934 Z When using "w!" while the 'readonly' option is set,
1935 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001936 *cpo-!*
1937 ! When redoing a filter command, use the last used
1938 external command, whatever it was. Otherwise the last
1939 used -filter- command is used.
1940 *cpo-$*
1941 $ When making a change to one line, don't redisplay the
1942 line, but put a '$' at the end of the changed text.
1943 The changed text will be overwritten when you type the
1944 new text. The line is redisplayed if you type any
1945 command that moves the cursor from the insertion
1946 point.
1947 *cpo-%*
1948 % Vi-compatible matching is done for the "%" command.
1949 Does not recognize "#if", "#endif", etc.
1950 Does not recognize "/*" and "*/".
1951 Parens inside single and double quotes are also
1952 counted, causing a string that contains a paren to
1953 disturb the matching. For example, in a line like
1954 "if (strcmp("foo(", s))" the first paren does not
1955 match the last one. When this flag is not included,
1956 parens inside single and double quotes are treated
1957 specially. When matching a paren outside of quotes,
1958 everything inside quotes is ignored. When matching a
1959 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001960 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001961 This flag is also used for other features, such as
1962 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001963 *cpo--*
1964 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001965 it would go above the first line or below the last
1966 line. Without it the cursor moves to the first or
1967 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001968 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001969 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001970 *cpo-+*
1971 + When included, a ":write file" command will reset the
1972 'modified' flag of the buffer, even though the buffer
1973 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001974 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001975 * Use ":*" in the same way as ":@". When not included,
1976 ":*" is an alias for ":'<,'>", select the Visual area.
1977 *cpo-<*
1978 < Disable the recognition of special key codes in |<>|
1979 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001980 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001981 ":map X <Tab>" results in X being mapped to:
1982 '<' included: "<Tab>" (5 characters)
1983 '<' excluded: "^I" (^I is a real <Tab>)
1984 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001985 *cpo->*
1986 > When appending to a register, put a line break before
1987 the appended text.
1988
1989 POSIX flags. These are not included in the Vi default value, except
1990 when $VIM_POSIX was set on startup. |posix|
1991
1992 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001993 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001994 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001995 *cpo-&*
1996 & When ":preserve" was used keep the swap file when
1997 exiting normally while this buffer is still loaded.
1998 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001999 *cpo-\*
2000 \ Backslash in a [] range in a search pattern is taken
2001 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002002 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2003 '\' excluded: "/[ \-]" finds <Space> and '-'
2004 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002005 *cpo-/*
2006 / When "%" is used as the replacement string in a |:s|
2007 command, use the previous replacement string. |:s%|
2008 *cpo-{*
2009 { The |{| and |}| commands also stop at a "{" character
2010 at the start of a line.
2011 *cpo-.*
2012 . The ":chdir" and ":cd" commands fail if the current
2013 buffer is modified, unless ! is used. Vim doesn't
2014 need this, since it remembers the full path of an
2015 opened file.
2016 *cpo-bar*
2017 | The value of the $LINES and $COLUMNS environment
2018 variables overrule the terminal size values obtained
2019 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002020
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021
2022 *'cscopepathcomp'* *'cspc'*
2023'cscopepathcomp' 'cspc' number (default 0)
2024 global
2025 {not available when compiled without the |+cscope|
2026 feature}
2027 {not in Vi}
2028 Determines how many components of the path to show in a list of tags.
2029 See |cscopepathcomp|.
2030
2031 *'cscopeprg'* *'csprg'*
2032'cscopeprg' 'csprg' string (default "cscope")
2033 global
2034 {not available when compiled without the |+cscope|
2035 feature}
2036 {not in Vi}
2037 Specifies the command to execute cscope. See |cscopeprg|.
2038 This option cannot be set from a |modeline| or in the |sandbox|, for
2039 security reasons.
2040
2041 *'cscopequickfix'* *'csqf'*
2042'cscopequickfix' 'csqf' string (default "")
2043 global
2044 {not available when compiled without the |+cscope|
2045 or |+quickfix| features}
2046 {not in Vi}
2047 Specifies whether to use quickfix window to show cscope results.
2048 See |cscopequickfix|.
2049
2050 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2051'cscopetag' 'cst' boolean (default off)
2052 global
2053 {not available when compiled without the |+cscope|
2054 feature}
2055 {not in Vi}
2056 Use cscope for tag commands. See |cscope-options|.
2057 NOTE: This option is reset when 'compatible' is set.
2058
2059 *'cscopetagorder'* *'csto'*
2060'cscopetagorder' 'csto' number (default 0)
2061 global
2062 {not available when compiled without the |+cscope|
2063 feature}
2064 {not in Vi}
2065 Determines the order in which ":cstag" performs a search. See
2066 |cscopetagorder|.
2067 NOTE: This option is set to 0 when 'compatible' is set.
2068
2069 *'cscopeverbose'* *'csverb'*
2070 *'nocscopeverbose'* *'nocsverb'*
2071'cscopeverbose' 'csverb' boolean (default off)
2072 global
2073 {not available when compiled without the |+cscope|
2074 feature}
2075 {not in Vi}
2076 Give messages when adding a cscope database. See |cscopeverbose|.
2077 NOTE: This option is reset when 'compatible' is set.
2078
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002079
2080 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2081'cursorcolumn' 'cuc' boolean (default off)
2082 local to window
2083 {not in Vi}
2084 {not available when compiled without the |+syntax|
2085 feature}
2086 Highlight the screen column of the cursor with CursorColumn
2087 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2088 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002089 If you only want the highlighting in the current window you can use
2090 these autocommands: >
2091 au WinLeave * set nocursorline nocursorcolumn
2092 au WinEnter * set cursorline cursorcolumn
2093<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002094
2095 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2096'cursorline' 'cul' boolean (default off)
2097 local to window
2098 {not in Vi}
2099 {not available when compiled without the |+syntax|
2100 feature}
2101 Highlight the screen line of the cursor with CursorLine
2102 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2103 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002104 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002105 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002106
2107
Bram Moolenaar071d4272004-06-13 20:20:40 +00002108 *'debug'*
2109'debug' string (default "")
2110 global
2111 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002112 These values can be used:
2113 msg Error messages that would otherwise be omitted will be given
2114 anyway.
2115 throw Error messages that would otherwise be omitted will be given
2116 anyway and also throw an exception and set |v:errmsg|.
2117 beep A message will be given when otherwise only a beep would be
2118 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002119 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002120 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2121 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122
2123 *'define'* *'def'*
2124'define' 'def' string (default "^\s*#\s*define")
2125 global or local to buffer |global-local|
2126 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002127 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 pattern, just like for the "/" command. This option is used for the
2129 commands like "[i" and "[d" |include-search|. The 'isident' option is
2130 used to recognize the defined name after the match:
2131 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2132 See |option-backslash| about inserting backslashes to include a space
2133 or backslash.
2134 The default value is for C programs. For C++ this value would be
2135 useful, to include const type declarations: >
2136 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2137< When using the ":set" command, you need to double the backslashes!
2138
2139 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2140'delcombine' 'deco' boolean (default off)
2141 global
2142 {not in Vi}
2143 {only available when compiled with the |+multi_byte|
2144 feature}
2145 If editing Unicode and this option is set, backspace and Normal mode
2146 "x" delete each combining character on its own. When it is off (the
2147 default) the character along with its combining characters are
2148 deleted.
2149 Note: When 'delcombine' is set "xx" may work different from "2x"!
2150
2151 This is useful for Arabic, Hebrew and many other languages where one
2152 may have combining characters overtop of base characters, and want
2153 to remove only the combining ones.
2154
2155 *'dictionary'* *'dict'*
2156'dictionary' 'dict' string (default "")
2157 global or local to buffer |global-local|
2158 {not in Vi}
2159 List of file names, separated by commas, that are used to lookup words
2160 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2161 contain a list of words. This can be one word per line, or several
2162 words per line, separated by non-keyword characters (white space is
2163 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002164 When this option is empty, or an entry "spell" is present, spell
2165 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002166 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002167 after a comma are ignored, otherwise spaces are included in the file
2168 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002169 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002170 Where to find a list of words?
2171 - On FreeBSD, there is the file "/usr/share/dict/words".
2172 - In the Simtel archive, look in the "msdos/linguist" directory.
2173 - In "miscfiles" of the GNU collection.
2174 The use of |:set+=| and |:set-=| is preferred when adding or removing
2175 directories from the list. This avoids problems when a future version
2176 uses another default.
2177 Backticks cannot be used in this option for security reasons.
2178
2179 *'diff'* *'nodiff'*
2180'diff' boolean (default off)
2181 local to window
2182 {not in Vi}
2183 {not available when compiled without the |+diff|
2184 feature}
2185 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002186 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187
2188 *'dex'* *'diffexpr'*
2189'diffexpr' 'dex' string (default "")
2190 global
2191 {not in Vi}
2192 {not available when compiled without the |+diff|
2193 feature}
2194 Expression which is evaluated to obtain an ed-style diff file from two
2195 versions of a file. See |diff-diffexpr|.
2196 This option cannot be set from a |modeline| or in the |sandbox|, for
2197 security reasons.
2198
2199 *'dip'* *'diffopt'*
2200'diffopt' 'dip' string (default "filler")
2201 global
2202 {not in Vi}
2203 {not available when compiled without the |+diff|
2204 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002205 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002206 All are optional. Items must be separated by a comma.
2207
2208 filler Show filler lines, to keep the text
2209 synchronized with a window that has inserted
2210 lines at the same position. Mostly useful
2211 when windows are side-by-side and 'scrollbind'
2212 is set.
2213
2214 context:{n} Use a context of {n} lines between a change
2215 and a fold that contains unchanged lines.
2216 When omitted a context of six lines is used.
2217 See |fold-diff|.
2218
2219 icase Ignore changes in case of text. "a" and "A"
2220 are considered the same. Adds the "-i" flag
2221 to the "diff" command if 'diffexpr' is empty.
2222
2223 iwhite Ignore changes in amount of white space. Adds
2224 the "-b" flag to the "diff" command if
2225 'diffexpr' is empty. Check the documentation
2226 of the "diff" command for what this does
2227 exactly. It should ignore adding trailing
2228 white space, but not leading white space.
2229
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002230 horizontal Start diff mode with horizontal splits (unless
2231 explicitly specified otherwise).
2232
2233 vertical Start diff mode with vertical splits (unless
2234 explicitly specified otherwise).
2235
2236 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2237 starting diff mode. Without this 2 is used.
2238
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 Examples: >
2240
2241 :set diffopt=filler,context:4
2242 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002243 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002244<
2245 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2246'digraph' 'dg' boolean (default off)
2247 global
2248 {not in Vi}
2249 {not available when compiled without the |+digraphs|
2250 feature}
2251 Enable the entering of digraphs in Insert mode with {char1} <BS>
2252 {char2}. See |digraphs|.
2253 NOTE: This option is reset when 'compatible' is set.
2254
2255 *'directory'* *'dir'*
2256'directory' 'dir' string (default for Amiga: ".,t:",
2257 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2258 for Unix: ".,~/tmp,/var/tmp,/tmp")
2259 global
2260 List of directory names for the swap file, separated with commas.
2261 - The swap file will be created in the first directory where this is
2262 possible.
2263 - Empty means that no swap file will be used (recovery is
2264 impossible!).
2265 - A directory "." means to put the swap file in the same directory as
2266 the edited file. On Unix, a dot is prepended to the file name, so
2267 it doesn't show in a directory listing. On MS-Windows the "hidden"
2268 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002269 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270 put the swap file relative to where the edited file is. The leading
2271 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002272 - For Unix and Win32, if a directory ends in two path separators "//"
2273 or "\\", the swap file name will be built from the complete path to
2274 the file with all path separators substituted to percent '%' signs.
2275 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 - Spaces after the comma are ignored, other spaces are considered part
2277 of the directory name. To have a space at the start of a directory
2278 name, precede it with a backslash.
2279 - To include a comma in a directory name precede it with a backslash.
2280 - A directory name may end in an ':' or '/'.
2281 - Environment variables are expanded |:set_env|.
2282 - Careful with '\' characters, type one before a space, type two to
2283 get one in the option (see |option-backslash|), for example: >
2284 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2285< - For backwards compatibility with Vim version 3.0 a '>' at the start
2286 of the option is removed.
2287 Using "." first in the list is recommended. This means that editing
2288 the same file twice will result in a warning. Using "/tmp" on Unix is
2289 discouraged: When the system crashes you lose the swap file.
2290 "/var/tmp" is often not cleared when rebooting, thus is a better
2291 choice than "/tmp". But it can contain a lot of files, your swap
2292 files get lost in the crowd. That is why a "tmp" directory in your
2293 home directory is tried first.
2294 The use of |:set+=| and |:set-=| is preferred when adding or removing
2295 directories from the list. This avoids problems when a future version
2296 uses another default.
2297 This option cannot be set from a |modeline| or in the |sandbox|, for
2298 security reasons.
2299 {Vi: directory to put temp file in, defaults to "/tmp"}
2300
2301 *'display'* *'dy'*
2302'display' 'dy' string (default "")
2303 global
2304 {not in Vi}
2305 Change the way text is displayed. This is comma separated list of
2306 flags:
2307 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002308 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002309 last line that doesn't fit is replaced with "@" lines.
2310 uhex Show unprintable characters hexadecimal as <xx>
2311 instead of using ^C and ~C.
2312
2313 *'eadirection'* *'ead'*
2314'eadirection' 'ead' string (default "both")
2315 global
2316 {not in Vi}
2317 {not available when compiled without the +vertsplit
2318 feature}
2319 Tells when the 'equalalways' option applies:
2320 ver vertically, width of windows is not affected
2321 hor horizontally, height of windows is not affected
2322 both width and height of windows is affected
2323
2324 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2325'edcompatible' 'ed' boolean (default off)
2326 global
2327 Makes the 'g' and 'c' flags of the ":substitute" command to be
2328 toggled each time the flag is given. See |complex-change|. See
2329 also 'gdefault' option.
2330 Switching this option on is discouraged!
2331
2332 *'encoding'* *'enc'* *E543*
2333'encoding' 'enc' string (default: "latin1" or value from $LANG)
2334 global
2335 {only available when compiled with the |+multi_byte|
2336 feature}
2337 {not in Vi}
2338 Sets the character encoding used inside Vim. It applies to text in
2339 the buffers, registers, Strings in expressions, text stored in the
2340 viminfo file, etc. It sets the kind of characters which Vim can work
2341 with. See |encoding-names| for the possible values.
2342
2343 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002344 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002345 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002346 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002347
2348 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2349 "utf-8". Although care has been taken to allow different values of
2350 'encoding', "utf-8" is the natural choice for the environment and
2351 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 versions, and to avoid changing the encoding of newly created files
2354 without your knowledge (in case 'fileencodings' is empty).
2355
2356 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002357 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002358 iconv() or as specified with 'charconvert'.
2359
2360 Normally 'encoding' will be equal to your current locale. This will
2361 be the default if Vim recognizes your environment settings. If
2362 'encoding' is not set to the current locale, 'termencoding' must be
2363 set to convert typed and displayed text. See |encoding-table|.
2364
2365 When you set this option, it fires the |EncodingChanged| autocommand
2366 event so that you can set up fonts if necessary.
2367
2368 When the option is set, the value is converted to lowercase. Thus
2369 you can set it with uppercase values too. Underscores are translated
2370 to '-' signs.
2371 When the encoding is recognized, it is changed to the standard name.
2372 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2373 "iso-8859-2" and "utf8" becomes "utf-8".
2374
2375 Note: "latin1" is also used when the encoding could not be detected.
2376 This only works when editing files in the same encoding! When the
2377 actual character set is not latin1, make sure 'fileencoding' and
2378 'fileencodings' are empty. When conversion is needed, switch to using
2379 utf-8.
2380
2381 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2382 You don't notice this while editing, but it does matter for the
2383 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2384 setting 'encoding' to one of these values instead of utf-8 only has
2385 effect for encoding used for files when 'fileencoding' is empty.
2386
Bram Moolenaar661b1822005-07-28 22:36:45 +00002387 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2388 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002389
2390 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2391'endofline' 'eol' boolean (default on)
2392 local to buffer
2393 {not in Vi}
2394 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002395 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 option is automatically set when starting to edit a new file, unless
2397 the file does not have an <EOL> for the last line in the file, in
2398 which case it is reset. Normally you don't have to set or reset this
2399 option. When 'binary' is off the value is not used when writing the
2400 file. When 'binary' is on it is used to remember the presence of a
2401 <EOL> for the last line in the file, so that when you write the file
2402 the situation from the original file can be kept. But you can change
2403 it if you want to.
2404
2405 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2406'equalalways' 'ea' boolean (default on)
2407 global
2408 {not in Vi}
2409 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002410 splitting or closing a window. This also happens the moment the
2411 option is switched on. When off, splitting a window will reduce the
2412 size of the current window and leave the other windows the same. When
2413 closing a window the extra lines are given to the window next to it
2414 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 When mixing vertically and horizontally split windows, a minimal size
2416 is computed and some windows may be larger if there is room. The
2417 'eadirection' option tells in which direction the size is affected.
2418 Changing the height of a window can be avoided by setting
2419 'winfixheight'.
2420
2421 *'equalprg'* *'ep'*
2422'equalprg' 'ep' string (default "")
2423 global or local to buffer |global-local|
2424 {not in Vi}
2425 External program to use for "=" command. When this option is empty
2426 the internal formatting functions are used ('lisp', 'cindent' or
2427 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002428 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002429 about including spaces and backslashes.
2430 This option cannot be set from a |modeline| or in the |sandbox|, for
2431 security reasons.
2432
2433 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2434'errorbells' 'eb' boolean (default off)
2435 global
2436 Ring the bell (beep or screen flash) for error messages. This only
2437 makes a difference for error messages, the bell will be used always
2438 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002439 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002440 screen flash or do nothing.
2441
2442 *'errorfile'* *'ef'*
2443'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2444 others: "errors.err")
2445 global
2446 {not in Vi}
2447 {not available when compiled without the |+quickfix|
2448 feature}
2449 Name of the errorfile for the QuickFix mode (see |:cf|).
2450 When the "-q" command-line argument is used, 'errorfile' is set to the
2451 following argument. See |-q|.
2452 NOT used for the ":make" command. See 'makeef' for that.
2453 Environment variables are expanded |:set_env|.
2454 See |option-backslash| about including spaces and backslashes.
2455 This option cannot be set from a |modeline| or in the |sandbox|, for
2456 security reasons.
2457
2458 *'errorformat'* *'efm'*
2459'errorformat' 'efm' string (default is very long)
2460 global or local to buffer |global-local|
2461 {not in Vi}
2462 {not available when compiled without the |+quickfix|
2463 feature}
2464 Scanf-like description of the format for the lines in the error file
2465 (see |errorformat|).
2466
2467 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2468'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2469 global
2470 {not in Vi}
2471 Function keys that start with an <Esc> are recognized in Insert
2472 mode. When this option is off, the cursor and function keys cannot be
2473 used in Insert mode if they start with an <Esc>. The advantage of
2474 this is that the single <Esc> is recognized immediately, instead of
2475 after one second. Instead of resetting this option, you might want to
2476 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2477 when 'esckeys' is off, you can still map anything, but the cursor keys
2478 won't work by default.
2479 NOTE: This option is set to the Vi default value when 'compatible' is
2480 set and to the Vim default value when 'compatible' is reset.
2481
2482 *'eventignore'* *'ei'*
2483'eventignore' 'ei' string (default "")
2484 global
2485 {not in Vi}
2486 {not available when compiled without the |+autocmd|
2487 feature}
2488 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002489 When set to "all" or when "all" is one of the items, all autocommand
2490 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002491 Otherwise this is a comma separated list of event names. Example: >
2492 :set ei=WinEnter,WinLeave
2493<
2494 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2495'expandtab' 'et' boolean (default off)
2496 local to buffer
2497 {not in Vi}
2498 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002499 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2501 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2502 NOTE: This option is reset when 'compatible' is set.
2503
2504 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2505'exrc' 'ex' boolean (default off)
2506 global
2507 {not in Vi}
2508 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2509 directory. If you switch this option on you should also consider
2510 setting the 'secure' option (see |initialization|). Using a local
2511 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2512 also see |.vimrc| and |gui-init|.
2513 This option cannot be set from a |modeline| or in the |sandbox|, for
2514 security reasons.
2515
2516 *'fileencoding'* *'fenc'* *E213*
2517'fileencoding' 'fenc' string (default: "")
2518 local to buffer
2519 {only available when compiled with the |+multi_byte|
2520 feature}
2521 {not in Vi}
2522 Sets the character encoding for the file of this buffer.
2523 When 'fileencoding' is different from 'encoding', conversion will be
2524 done when reading and writing the file.
2525 When 'fileencoding' is empty, the same value as 'encoding' will be
2526 used (no conversion when reading or writing a file).
2527 WARNING: Conversion can cause loss of information! When
2528 'encoding' is "utf-8" conversion is most likely done in a way
2529 that the reverse conversion results in the same text. When
2530 'encoding' is not "utf-8" some characters may be lost!
2531 See 'encoding' for the possible values. Additionally, values may be
2532 specified that can be handled by the converter, see
2533 |mbyte-conversion|.
2534 When reading a file 'fileencoding' will be set from 'fileencodings'.
2535 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002536 'fileencoding', use the |++enc| argument. One exception: when
2537 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002538 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2540 When the option is set, the value is converted to lowercase. Thus
2541 you can set it with uppercase values too. '_' characters are
2542 replaced with '-'. If a name is recognized from the list for
2543 'encoding', it is replaced by the standard name. For example
2544 "ISO8859-2" becomes "iso-8859-2".
2545 When this option is set, after starting to edit a file, the 'modified'
2546 option is set, because the file would be different when written.
2547 If you do this in a modeline, you might want to set 'nomodified' to
2548 avoid this.
2549 This option can not be changed when 'modifiable' is off.
2550
2551 *'fe'*
2552 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002553 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002554 old short name was 'fe', which is no longer used.
2555
2556 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002557'fileencodings' 'fencs' string (default: "ucs-bom",
2558 "ucs-bom,utf-8,default,latin1" when
2559 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002560 global
2561 {only available when compiled with the |+multi_byte|
2562 feature}
2563 {not in Vi}
2564 This is a list of character encodings considered when starting to edit
2565 an existing file. When a file is read, Vim tries to use the first
2566 mentioned character encoding. If an error is detected, the next one
2567 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569 an empty string, which means the value of 'encoding' is used.
2570 WARNING: Conversion can cause loss of information! When
2571 'encoding' is "utf-8" (or one of the other Unicode variants)
2572 conversion is most likely done in a way that the reverse
2573 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002574 "utf-8" some non-ASCII characters may be lost! You can use
2575 the |++bad| argument to specify what is done with characters
2576 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 For an empty file or a file with only ASCII characters most encodings
2578 will work and the first entry of 'fileencodings' will be used (except
2579 "ucs-bom", which requires the BOM to be present). If you prefer
2580 another encoding use an BufReadPost autocommand event to test if your
2581 preferred encoding is to be used. Example: >
2582 au BufReadPost * if search('\S', 'w') == 0 |
2583 \ set fenc=iso-2022-jp | endif
2584< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2585 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002586 When the |++enc| argument is used then the value of 'fileencodings' is
2587 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002588 Note that 'fileencodings' is not used for a new file, the global value
2589 of 'fileencoding' is used instead. You can set it with: >
2590 :setglobal fenc=iso-8859-2
2591< This means that a non-existing file may get a different encoding than
2592 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 The special value "ucs-bom" can be used to check for a Unicode BOM
2594 (Byte Order Mark) at the start of the file. It must not be preceded
2595 by "utf-8" or another Unicode encoding for this to work properly.
2596 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2597 because Vim cannot detect an error, thus the encoding is always
2598 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002599 The special value "default" can be used for the encoding from the
2600 environment. This is the default value for 'encoding'. It is useful
2601 when 'encoding' is set to "utf-8" and your environment uses a
2602 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002603 When 'encoding' is "utf-8" and a file contains an illegal byte
2604 sequence it won't be recognized as UTF-8. You can use the |8g8|
2605 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002606 WRONG VALUES: WHAT'S WRONG:
2607 latin1,utf-8 "latin1" will always be used
2608 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2609 file
2610 cp1250,latin1 "cp1250" will always be used
2611 If 'fileencodings' is empty, 'fileencoding' is not modified.
2612 See 'fileencoding' for the possible values.
2613 Setting this option does not have an effect until the next time a file
2614 is read.
2615
2616 *'fileformat'* *'ff'*
2617'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2618 Unix default: "unix",
2619 Macintosh default: "mac")
2620 local to buffer
2621 {not in Vi}
2622 This gives the <EOL> of the current buffer, which is used for
2623 reading/writing the buffer from/to a file:
2624 dos <CR> <NL>
2625 unix <NL>
2626 mac <CR>
2627 When "dos" is used, CTRL-Z at the end of a file is ignored.
2628 See |file-formats| and |file-read|.
2629 For the character encoding of the file see 'fileencoding'.
2630 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2631 works like it was set to "unix'.
2632 This option is set automatically when starting to edit a file and
2633 'fileformats' is not empty and 'binary' is off.
2634 When this option is set, after starting to edit a file, the 'modified'
2635 option is set, because the file would be different when written.
2636 This option can not be changed when 'modifiable' is off.
2637 For backwards compatibility: When this option is set to "dos",
2638 'textmode' is set, otherwise 'textmode' is reset.
2639
2640 *'fileformats'* *'ffs'*
2641'fileformats' 'ffs' string (default:
2642 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2643 Vim Unix: "unix,dos",
2644 Vim Mac: "mac,unix,dos",
2645 Vi Cygwin: "unix,dos",
2646 Vi others: "")
2647 global
2648 {not in Vi}
2649 This gives the end-of-line (<EOL>) formats that will be tried when
2650 starting to edit a new buffer and when reading a file into an existing
2651 buffer:
2652 - When empty, the format defined with 'fileformat' will be used
2653 always. It is not set automatically.
2654 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002655 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002656 'fileformats' name will be used when a file is read into an existing
2657 buffer, no matter what 'fileformat' for that buffer is set to.
2658 - When more than one name is present, separated by commas, automatic
2659 <EOL> detection will be done when reading a file. When starting to
2660 edit a file, a check is done for the <EOL>:
2661 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2662 'fileformat' is set to "dos".
2663 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002664 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665 preceding <CR>, "unix" is preferred over "dos".
2666 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2667 This means that "mac" is only chosen when "unix" is not present,
2668 or when no <NL> is found in the file, and when "dos" is not
2669 present, or no <CR><NL> is present in the file.
2670 Also if "unix" was first chosen, but the first <CR> is before
2671 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2672 the file, then 'fileformat' is set to "mac".
2673 4. If 'fileformat' is still not set, the first name from
2674 'fileformats' is used.
2675 When reading a file into an existing buffer, the same is done, but
2676 this happens like 'fileformat' has been set appropriately for that
2677 file only, the option is not changed.
2678 When 'binary' is set, the value of 'fileformats' is not used.
2679
2680 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2681 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2682 done:
2683 - When 'fileformats' is empty, there is no automatic detection. Dos
2684 format will be used.
2685 - When 'fileformats' is set to one or more names, automatic detection
2686 is done. This is based on the first <NL> in the file: If there is a
2687 <CR> in front of it, Dos format is used, otherwise Unix format is
2688 used.
2689 Also see |file-formats|.
2690 For backwards compatibility: When this option is set to an empty
2691 string or one format (no comma is included), 'textauto' is reset,
2692 otherwise 'textauto' is set.
2693 NOTE: This option is set to the Vi default value when 'compatible' is
2694 set and to the Vim default value when 'compatible' is reset.
2695
2696 *'filetype'* *'ft'*
2697'filetype' 'ft' string (default: "")
2698 local to buffer
2699 {not in Vi}
2700 {not available when compiled without the |+autocmd|
2701 feature}
2702 When this option is set, the FileType autocommand event is triggered.
2703 All autocommands that match with the value of this option will be
2704 executed. Thus the value of 'filetype' is used in place of the file
2705 name.
2706 Otherwise this option does not always reflect the current file type.
2707 This option is normally set when the file type is detected. To enable
2708 this use the ":filetype on" command. |:filetype|
2709 Setting this option to a different value is most useful in a modeline,
2710 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002711 Example, for in an IDL file:
2712 /* vim: set filetype=idl : */ ~
2713 |FileType| |filetypes|
2714 When a dot appears in the value then this separates two filetype
2715 names. Example:
2716 /* vim: set filetype=c.doxygen : */ ~
2717 This will use the "c" filetype first, then the "doxygen" filetype.
2718 This works both for filetype plugins and for syntax files. More than
2719 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002720 Do not confuse this option with 'osfiletype', which is for the file
2721 type that is actually stored with the file.
2722 This option is not copied to another buffer, independent of the 's' or
2723 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002724 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725
2726 *'fillchars'* *'fcs'*
2727'fillchars' 'fcs' string (default "vert:|,fold:-")
2728 global
2729 {not in Vi}
2730 {not available when compiled without the |+windows|
2731 and |+folding| features}
2732 Characters to fill the statuslines and vertical separators.
2733 It is a comma separated list of items:
2734
2735 item default Used for ~
2736 stl:c ' ' or '^' statusline of the current window
2737 stlnc:c ' ' or '-' statusline of the non-current windows
2738 vert:c '|' vertical separators |:vsplit|
2739 fold:c '-' filling 'foldtext'
2740 diff:c '-' deleted lines of the 'diff' option
2741
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002742 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 "stlnc" the space will be used when there is highlighting, '^' or '-'
2744 otherwise.
2745
2746 Example: >
2747 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2748< This is similar to the default, except that these characters will also
2749 be used when there is highlighting.
2750
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002751 for "stl" and "stlnc" only single-byte values are supported.
2752
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 The highlighting used for these items:
2754 item highlight group ~
2755 stl:c StatusLine |hl-StatusLine|
2756 stlnc:c StatusLineNC |hl-StatusLineNC|
2757 vert:c VertSplit |hl-VertSplit|
2758 fold:c Folded |hl-Folded|
2759 diff:c DiffDelete |hl-DiffDelete|
2760
2761 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2762'fkmap' 'fk' boolean (default off) *E198*
2763 global
2764 {not in Vi}
2765 {only available when compiled with the |+rightleft|
2766 feature}
2767 When on, the keyboard is mapped for the Farsi character set.
2768 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002769 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770
2771 *'foldclose'* *'fcl'*
2772'foldclose' 'fcl' string (default "")
2773 global
2774 {not in Vi}
2775 {not available when compiled without the |+folding|
2776 feature}
2777 When set to "all", a fold is closed when the cursor isn't in it and
2778 its level is higher than 'foldlevel'. Useful if you want folds to
2779 automatically close when moving out of them.
2780
2781 *'foldcolumn'* *'fdc'*
2782'foldcolumn' 'fdc' number (default 0)
2783 local to window
2784 {not in Vi}
2785 {not available when compiled without the |+folding|
2786 feature}
2787 When non-zero, a column with the specified width is shown at the side
2788 of the window which indicates open and closed folds. The maximum
2789 value is 12.
2790 See |folding|.
2791
2792 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2793'foldenable' 'fen' boolean (default on)
2794 local to window
2795 {not in Vi}
2796 {not available when compiled without the |+folding|
2797 feature}
2798 When off, all folds are open. This option can be used to quickly
2799 switch between showing all text unfolded and viewing the text with
2800 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002801 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 'foldenable' is off.
2803 This option is set by commands that create a new fold or close a fold.
2804 See |folding|.
2805
2806 *'foldexpr'* *'fde'*
2807'foldexpr' 'fde' string (default: "0")
2808 local to window
2809 {not in Vi}
2810 {not available when compiled without the |+folding|
2811 or |+eval| feature}
2812 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002813 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002814
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002815 The expression may be evaluated in the |sandbox|, see
2816 |sandbox-option|.
2817
2818 It is not allowed to change text or jump to another window while
2819 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002820
2821 *'foldignore'* *'fdi'*
2822'foldignore' 'fdi' string (default: "#")
2823 local to window
2824 {not in Vi}
2825 {not available when compiled without the |+folding|
2826 feature}
2827 Used only when 'foldmethod' is "indent". Lines starting with
2828 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002829 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 The default "#" works well for C programs. See |fold-indent|.
2831
2832 *'foldlevel'* *'fdl'*
2833'foldlevel' 'fdl' number (default: 0)
2834 local to window
2835 {not in Vi}
2836 {not available when compiled without the |+folding|
2837 feature}
2838 Sets the fold level: Folds with a higher level will be closed.
2839 Setting this option to zero will close all folds. Higher numbers will
2840 close fewer folds.
2841 This option is set by commands like |zm|, |zM| and |zR|.
2842 See |fold-foldlevel|.
2843
2844 *'foldlevelstart'* *'fdls'*
2845'foldlevelstart' 'fdls' number (default: -1)
2846 global
2847 {not in Vi}
2848 {not available when compiled without the |+folding|
2849 feature}
2850 Sets 'foldlevel' when starting to edit another buffer in a window.
2851 Useful to always start editing with all folds closed (value zero),
2852 some folds closed (one) or no folds closed (99).
2853 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002854 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 ignores this option and closes all folds.
2856 It is also done before BufReadPre autocommands, to allow an autocmd to
2857 overrule the 'foldlevel' value for specific files.
2858 When the value is negative, it is not used.
2859
2860 *'foldmarker'* *'fmr'* *E536*
2861'foldmarker' 'fmr' string (default: "{{{,}}}")
2862 local to window
2863 {not in Vi}
2864 {not available when compiled without the |+folding|
2865 feature}
2866 The start and end marker used when 'foldmethod' is "marker". There
2867 must be one comma, which separates the start and end marker. The
2868 marker is a literal string (a regular expression would be too slow).
2869 See |fold-marker|.
2870
2871 *'foldmethod'* *'fdm'*
2872'foldmethod' 'fdm' string (default: "manual")
2873 local to window
2874 {not in Vi}
2875 {not available when compiled without the |+folding|
2876 feature}
2877 The kind of folding used for the current window. Possible values:
2878 |fold-manual| manual Folds are created manually.
2879 |fold-indent| indent Lines with equal indent form a fold.
2880 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2881 |fold-marker| marker Markers are used to specify folds.
2882 |fold-syntax| syntax Syntax highlighting items specify folds.
2883 |fold-diff| diff Fold text that is not changed.
2884
2885 *'foldminlines'* *'fml'*
2886'foldminlines' 'fml' number (default: 1)
2887 local to window
2888 {not in Vi}
2889 {not available when compiled without the |+folding|
2890 feature}
2891 Sets the minimum number of screen lines for a fold to be displayed
2892 closed. Also for manually closed folds.
2893 Note that this only has an effect of what is displayed. After using
2894 "zc" to close a fold, which is displayed open because it's smaller
2895 than 'foldminlines', a following "zc" may close a containing fold.
2896
2897 *'foldnestmax'* *'fdn'*
2898'foldnestmax' 'fdn' number (default: 20)
2899 local to window
2900 {not in Vi}
2901 {not available when compiled without the |+folding|
2902 feature}
2903 Sets the maximum nesting of folds for the "indent" and "syntax"
2904 methods. This avoids that too many folds will be created. Using more
2905 than 20 doesn't work, because the internal limit is 20.
2906
2907 *'foldopen'* *'fdo'*
2908'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2909 search,tag,undo")
2910 global
2911 {not in Vi}
2912 {not available when compiled without the |+folding|
2913 feature}
2914 Specifies for which type of commands folds will be opened, if the
2915 command moves the cursor into a closed fold. It is a comma separated
2916 list of items.
2917 item commands ~
2918 all any
2919 block "(", "{", "[[", "[{", etc.
2920 hor horizontal movements: "l", "w", "fx", etc.
2921 insert any command in Insert mode
2922 jump far jumps: "G", "gg", etc.
2923 mark jumping to a mark: "'m", CTRL-O, etc.
2924 percent "%"
2925 quickfix ":cn", ":crew", ":make", etc.
2926 search search for a pattern: "/", "n", "*", "gd", etc.
2927 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002928 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002929 tag jumping to a tag: ":ta", CTRL-T, etc.
2930 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002931 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 the |zv| command to the mapping to get the same effect.
2933 When a movement command is used for an operator (e.g., "dl" or "y%")
2934 this option is not used. This means the operator will include the
2935 whole closed fold.
2936 Note that vertical movements are not here, because it would make it
2937 very difficult to move onto a closed fold.
2938 In insert mode the folds containing the cursor will always be open
2939 when text is inserted.
2940 To close folds you can re-apply 'foldlevel' with the |zx| command or
2941 set the 'foldclose' option to "all".
2942
2943 *'foldtext'* *'fdt'*
2944'foldtext' 'fdt' string (default: "foldtext()")
2945 local to window
2946 {not in Vi}
2947 {not available when compiled without the |+folding|
2948 feature}
2949 An expression which is used to specify the text displayed for a closed
2950 fold. See |fold-foldtext|.
2951
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002952 The expression may be evaluated in the |sandbox|, see
2953 |sandbox-option|.
2954
2955 It is not allowed to change text or jump to another window while
2956 evaluating 'foldtext' |textlock|.
2957
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 *'formatoptions'* *'fo'*
2959'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2960 local to buffer
2961 {not in Vi}
2962 This is a sequence of letters which describes how automatic
2963 formatting is to be done. See |fo-table|. When the 'paste' option is
2964 on, no formatting is done (like 'formatoptions' is empty). Commas can
2965 be inserted for readability.
2966 To avoid problems with flags that are added in the future, use the
2967 "+=" and "-=" feature of ":set" |add-option-flags|.
2968 NOTE: This option is set to the Vi default value when 'compatible' is
2969 set and to the Vim default value when 'compatible' is reset.
2970
Bram Moolenaar86b68352004-12-27 21:59:20 +00002971 *'formatlistpat'* *'flp'*
2972'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2973 local to buffer
2974 {not in Vi}
2975 A pattern that is used to recognize a list header. This is used for
2976 the "n" flag in 'formatoptions'.
2977 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002978 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002979 while still checking more characters. There must be a character
2980 following the pattern, when it matches the whole line it is handled
2981 like there is no match.
2982 The default recognizes a number, followed by an optional punctuation
2983 character and white space.
2984
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 *'formatprg'* *'fp'*
2986'formatprg' 'fp' string (default "")
2987 global
2988 {not in Vi}
2989 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002990 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002992 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002993 If the 'formatexpr' option is not empty it will be used instead.
2994 Otherwise, if 'formatprg' option is an empty string, the internal
2995 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002996 Environment variables are expanded |:set_env|. See |option-backslash|
2997 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002998 The expression may be evaluated in the |sandbox|, see
2999 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003000
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003001 *'formatexpr'* *'fex'*
3002'formatexpr' 'fex' string (default "")
3003 local to buffer
3004 {not in Vi}
3005 {not available when compiled without the |+eval|
3006 feature}
3007 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003008 operator. When this option is empty 'formatprg' is used.
3009
3010 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003011 The |v:count| variable holds the number of lines to be formatted.
3012 The |v:char| variable holds the character that is going to be
3013 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003014
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003015 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003016 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003017< This will invoke the mylang#Format() function in the
3018 autoload/mylang.vim file in 'runtimepath'. |autoload|
3019
3020 The expression is also evaluated when 'textwidth' is set and adding
3021 text beyond that limit. This happens under the same conditions as
3022 when internal formatting is used. Make sure the cursor is kept in the
3023 same spot relative to the text then! The |mode()| function will
3024 return "i" or "R" in this situation. When the function returns
3025 non-zero Vim will fall back to using the internal format mechanism.
3026
3027 The expression may be evaluated in the |sandbox|, see
3028 |sandbox-option|.
3029
3030 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003031'fsync' 'fs' boolean (default on)
3032 global
3033 {not in Vi}
3034 When on, the library function fsync() will be called after writing a
3035 file. This will flush a file to disk, ensuring that it is safely
3036 written even on filesystems which do metadata-only journaling. This
3037 will force the harddrive to spin up on Linux systems running in laptop
3038 mode, so it may be undesirable in some situations. Be warned that
3039 turning this off increases the chances of data loss after a crash. On
3040 systems without an fsync() implementation, this variable is always
3041 off.
3042 Also see 'swapsync' for controlling fsync() on swap files.
3043
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3045'gdefault' 'gd' boolean (default off)
3046 global
3047 {not in Vi}
3048 When on, the ":substitute" flag 'g' is default on. This means that
3049 all matches in a line are substituted instead of one. When a 'g' flag
3050 is given to a ":substitute" command, this will toggle the substitution
3051 of all or one match. See |complex-change|.
3052
3053 command 'gdefault' on 'gdefault' off ~
3054 :s/// subst. all subst. one
3055 :s///g subst. one subst. all
3056 :s///gg subst. all subst. one
3057
3058 NOTE: This option is reset when 'compatible' is set.
3059
3060 *'grepformat'* *'gfm'*
3061'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3062 global
3063 {not in Vi}
3064 Format to recognize for the ":grep" command output.
3065 This is a scanf-like string that uses the same format as the
3066 'errorformat' option: see |errorformat|.
3067
3068 *'grepprg'* *'gp'*
3069'grepprg' 'gp' string (default "grep -n ",
3070 Unix: "grep -n $* /dev/null",
3071 Win32: "findstr /n" or "grep -n",
3072 VMS: "SEARCH/NUMBERS ")
3073 global or local to buffer |global-local|
3074 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003075 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003076 and '#' characters, which are expanded like when used in a command-
3077 line. The placeholder "$*" is allowed to specify where the arguments
3078 will be included. Environment variables are expanded |:set_env|. See
3079 |option-backslash| about including spaces and backslashes.
3080 When your "grep" accepts the "-H" argument, use this to make ":grep"
3081 also work well with a single file: >
3082 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003083< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003084 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3085 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003086 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 apply equally to 'grepprg'.
3088 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3089 otherwise it's "grep -n".
3090 This option cannot be set from a |modeline| or in the |sandbox|, for
3091 security reasons.
3092
3093 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3094'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3095 ve:ver35-Cursor,
3096 o:hor50-Cursor,
3097 i-ci:ver25-Cursor/lCursor,
3098 r-cr:hor20-Cursor/lCursor,
3099 sm:block-Cursor
3100 -blinkwait175-blinkoff150-blinkon175",
3101 for MS-DOS and Win32 console:
3102 "n-v-c:block,o:hor50,i-ci:hor15,
3103 r-cr:hor30,sm:block")
3104 global
3105 {not in Vi}
3106 {only available when compiled with GUI enabled, and
3107 for MS-DOS and Win32 console}
3108 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003109 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 the height of the cursor can be changed. This can be done by
3111 specifying a block cursor, or a percentage for a vertical or
3112 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003113 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003114
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003115 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 mode-list and an argument-list:
3117 mode-list:argument-list,mode-list:argument-list,..
3118 The mode-list is a dash separated list of these modes:
3119 n Normal mode
3120 v Visual mode
3121 ve Visual mode with 'selection' "exclusive" (same as 'v',
3122 if not specified)
3123 o Operator-pending mode
3124 i Insert mode
3125 r Replace mode
3126 c Command-line Normal (append) mode
3127 ci Command-line Insert mode
3128 cr Command-line Replace mode
3129 sm showmatch in Insert mode
3130 a all modes
3131 The argument-list is a dash separated list of these arguments:
3132 hor{N} horizontal bar, {N} percent of the character height
3133 ver{N} vertical bar, {N} percent of the character width
3134 block block cursor, fills the whole character
3135 [only one of the above three should be present]
3136 blinkwait{N} *cursor-blinking*
3137 blinkon{N}
3138 blinkoff{N}
3139 blink times for cursor: blinkwait is the delay before
3140 the cursor starts blinking, blinkon is the time that
3141 the cursor is shown and blinkoff is the time that the
3142 cursor is not shown. The times are in msec. When one
3143 of the numbers is zero, there is no blinking. The
3144 default is: "blinkwait700-blinkon400-blinkoff250".
3145 These numbers are used for a missing entry. This
3146 means that blinking is enabled by default. To switch
3147 blinking off you can use "blinkon0". The cursor only
3148 blinks when Vim is waiting for input, not while
3149 executing a command.
3150 To make the cursor blink in an xterm, see
3151 |xterm-blink|.
3152 {group-name}
3153 a highlight group name, that sets the color and font
3154 for the cursor
3155 {group-name}/{group-name}
3156 Two highlight group names, the first is used when
3157 no language mappings are used, the other when they
3158 are. |language-mapping|
3159
3160 Examples of parts:
3161 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3162 block cursor with colors from the "nCursor"
3163 highlight group
3164 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3165 In Insert and Command-line Insert mode, use a
3166 30% vertical bar cursor with colors from the
3167 "iCursor" highlight group. Blink a bit
3168 faster.
3169
3170 The 'a' mode is different. It will set the given argument-list for
3171 all modes. It does not reset anything to defaults. This can be used
3172 to do a common setting for all modes. For example, to switch off
3173 blinking: "a:blinkon0"
3174
3175 Examples of cursor highlighting: >
3176 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3177 :highlight Cursor gui=NONE guifg=bg guibg=fg
3178<
3179 *'guifont'* *'gfn'*
3180 *E235* *E596* *E610* *E611*
3181'guifont' 'gfn' string (default "")
3182 global
3183 {not in Vi}
3184 {only available when compiled with GUI enabled}
3185 This is a list of fonts which will be used for the GUI version of Vim.
3186 In its simplest form the value is just one font name. When
3187 the font cannot be found you will get an error message. To try other
3188 font names a list can be specified, font names separated with commas.
3189 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003190
Bram Moolenaar05159a02005-02-26 23:04:13 +00003191 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3192 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003193
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 Spaces after a comma are ignored. To include a comma in a font name
3195 precede it with a backslash. Setting an option requires an extra
3196 backslash before a space and a backslash. See also
3197 |option-backslash|. For example: >
3198 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003199< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003201
3202 If none of the fonts can be loaded, Vim will keep the current setting.
3203 If an empty font list is given, Vim will try using other resource
3204 settings (for X, it will use the Vim.font resource), and finally it
3205 will try some builtin default which should always be there ("7x13" in
3206 the case of X). The font names given should be "normal" fonts. Vim
3207 will try to find the related bold and italic fonts.
3208
Bram Moolenaar05159a02005-02-26 23:04:13 +00003209 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003210 :set guifont=*
3211< will bring up a font requester, where you can pick the font you want.
3212
3213 The font name depends on the GUI used. See |setting-guifont| for a
3214 way to set 'guifont' for various systems.
3215
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 For the GTK+ 2 GUI the font name looks like this: >
3217 :set guifont=Andale\ Mono\ 11
3218< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003219
3220 For Mac OSX you can use something like this: >
3221 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003222< Also see 'macatsui', it can help fix display problems.
3223 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003224 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003225 width). An exception is GTK 2: all fonts are accepted, but
3226 mono-spaced fonts look best.
3227
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 To preview a font on X11, you might be able to use the "xfontsel"
3229 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003230
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 For the Win32 GUI *E244* *E245*
3232 - takes these options in the font name:
3233 hXX - height is XX (points, can be floating-point)
3234 wXX - width is XX (points, can be floating-point)
3235 b - bold
3236 i - italic
3237 u - underline
3238 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003239 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3241 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3242 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003243 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003244
3245 Use a ':' to separate the options.
3246 - A '_' can be used in the place of a space, so you don't need to use
3247 backslashes to escape the spaces.
3248 - Examples: >
3249 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3250 :set guifont=Andale_Mono:h7.5:w4.5
3251< See also |font-sizes|.
3252
3253 *'guifontset'* *'gfs'*
3254 *E250* *E252* *E234* *E597* *E598*
3255'guifontset' 'gfs' string (default "")
3256 global
3257 {not in Vi}
3258 {only available when compiled with GUI enabled and
3259 with the |+xfontset| feature}
3260 {not available in the GTK+ 2 GUI}
3261 When not empty, specifies two (or more) fonts to be used. The first
3262 one for normal English, the second one for your special language. See
3263 |xfontset|.
3264 Setting this option also means that all font names will be handled as
3265 a fontset name. Also the ones used for the "font" argument of the
3266 |:highlight| command.
3267 The fonts must match with the current locale. If fonts for the
3268 character sets that the current locale uses are not included, setting
3269 'guifontset' will fail.
3270 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3271 the comma-separated names are alternative names, one of which will be
3272 used. In 'guifontset' the whole string is one fontset name,
3273 including the commas. It is not possible to specify alternative
3274 fontset names.
3275 This example works on many X11 systems: >
3276 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3277<
3278 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3279'guifontwide' 'gfw' string (default "")
3280 global
3281 {not in Vi}
3282 {only available when compiled with GUI enabled}
3283 When not empty, specifies a comma-separated list of fonts to be used
3284 for double-width characters. The first font that can be loaded is
3285 used.
3286 Note: The size of these fonts must be exactly twice as wide as the one
3287 specified with 'guifont' and the same height.
3288
3289 All GUI versions but GTK+ 2:
3290
3291 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3292 'guifontset' is empty or invalid.
3293 When 'guifont' is set and a valid font is found in it and
3294 'guifontwide' is empty Vim will attempt to find a matching
3295 double-width font and set 'guifontwide' to it.
3296
3297 GTK+ 2 GUI only: *guifontwide_gtk2*
3298
3299 If set and valid, 'guifontwide' is always used for double width
3300 characters, even if 'encoding' is not set to "utf-8".
3301 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003302 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003303 font for characters not available in 'guifont'. Thus you do not need
3304 to set 'guifontwide' at all unless you want to override the choice
3305 made by Pango/Xft.
3306
3307 *'guiheadroom'* *'ghr'*
3308'guiheadroom' 'ghr' number (default 50)
3309 global
3310 {not in Vi} {only for GTK and X11 GUI}
3311 The number of pixels subtracted from the screen height when fitting
3312 the GUI window on the screen. Set this before the GUI is started,
3313 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003314 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003315 lines will be left for window decorations and other items on the
3316 screen. Set it to a negative value to allow windows taller than the
3317 screen.
3318
3319 *'guioptions'* *'go'*
3320'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003321 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 global
3323 {not in Vi}
3324 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003325 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003326 sequence of letters which describes what components and options of the
3327 GUI should be used.
3328 To avoid problems with flags that are added in the future, use the
3329 "+=" and "-=" feature of ":set" |add-option-flags|.
3330
3331 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003332 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003333 'a' Autoselect: If present, then whenever VISUAL mode is started,
3334 or the Visual area extended, Vim tries to become the owner of
3335 the windowing system's global selection. This means that the
3336 Visually highlighted text is available for pasting into other
3337 applications as well as into Vim itself. When the Visual mode
3338 ends, possibly due to an operation on the text, or when an
3339 application wants to paste the selection, the highlighted text
3340 is automatically yanked into the "* selection register.
3341 Thus the selection is still available for pasting into other
3342 applications after the VISUAL mode has ended.
3343 If not present, then Vim won't become the owner of the
3344 windowing system's global selection unless explicitly told to
3345 by a yank or delete operation for the "* register.
3346 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003347 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003348 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003349 applies to the modeless selection.
3350
3351 'guioptions' autoselect Visual autoselect modeless ~
3352 "" - -
3353 "a" yes yes
3354 "A" - yes
3355 "aA" yes yes
3356
Bram Moolenaar02467872007-05-06 13:22:01 +00003357 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 'c' Use console dialogs instead of popup dialogs for simple
3359 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003360 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003361 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003362 'guitablabel' can be used to change the text in the labels.
3363 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003364 The GUI tabs are only supported on some systems, currently
3365 GTK, Motif and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003366 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 'f' Foreground: Don't use fork() to detach the GUI from the shell
3368 where it was started. Use this for programs that wait for the
3369 editor to finish (e.g., an e-mail program). Alternatively you
3370 can use "gvim -f" or ":gui -f" to start the GUI in the
3371 foreground. |gui-fork|
3372 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003373 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003374 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3376 corner of the window. It's black&white on non-GTK, because of
3377 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003378 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003380 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003381 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003383 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 file is sourced the system menu has already been loaded; the
3385 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003386 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003387 'g' Grey menu items: Make menu items that are not active grey. If
3388 'g' is not included inactive menu items are not shown at all.
3389 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003390 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 't' Include tearoff menu items. Currently only works for Win32,
3392 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003393 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003394 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003395 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003396 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003398 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 'R' Right-hand scrollbar is present when there is a vertically
3400 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003401 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003403 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 'L' Left-hand scrollbar is present when there is a vertically
3405 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003406 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003407 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3408 the longest visible line, or on the cursor line if the 'h'
3409 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003410 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 'h' Limit horizontal scrollbar size to the length of the cursor
3412 line. Reduces computations. |gui-horiz-scroll|
3413
3414 And yes, you may even have scrollbars on the left AND the right if
3415 you really want to :-). See |gui-scrollbars| for more information.
3416
Bram Moolenaar02467872007-05-06 13:22:01 +00003417 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 'v' Use a vertical button layout for dialogs. When not included,
3419 a horizontal layout is preferred, but when it doesn't fit a
3420 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003421 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003422 'p' Use Pointer callbacks for X11 GUI. This is required for some
3423 window managers. If the cursor is not blinking or hollow at
3424 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003425 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003427 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003428 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429
Bram Moolenaar02467872007-05-06 13:22:01 +00003430
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431 *'guipty'* *'noguipty'*
3432'guipty' boolean (default on)
3433 global
3434 {not in Vi}
3435 {only available when compiled with GUI enabled}
3436 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3437 I/O to/from shell commands. See |gui-pty|.
3438
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003439 *'guitablabel'* *'gtl'*
3440'guitablabel' 'gtl' string (default empty)
3441 global
3442 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003443 {only available when compiled with GUI enabled and
3444 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003445 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003446 pages line. When empty and when the result is empty Vim will use a
3447 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003448
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003449 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003450 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003451
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003452 Only used when the GUI tab pages line is displayed. 'e' must be
3453 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3454 used.
3455
Bram Moolenaar57657d82006-04-21 22:12:41 +00003456 *'guitabtooltip'* *'gtt'*
3457'guitabtooltip' 'gtt' string (default empty)
3458 global
3459 {not in Vi}
3460 {only available when compiled with GUI enabled and
3461 with the +windows feature}
3462 When nonempty describes the text to use in a tooltip for the GUI tab
3463 pages line. When empty Vim will use a default tooltip.
3464 This option is otherwise just like 'guitablabel' above.
3465
Bram Moolenaar57657d82006-04-21 22:12:41 +00003466
Bram Moolenaar071d4272004-06-13 20:20:40 +00003467 *'helpfile'* *'hf'*
3468'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3469 (others) "$VIMRUNTIME/doc/help.txt")
3470 global
3471 {not in Vi}
3472 Name of the main help file. All distributed help files should be
3473 placed together in one directory. Additionally, all "doc" directories
3474 in 'runtimepath' will be used.
3475 Environment variables are expanded |:set_env|. For example:
3476 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003477 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003478 spaces and backslashes.
3479 This option cannot be set from a |modeline| or in the |sandbox|, for
3480 security reasons.
3481
3482 *'helpheight'* *'hh'*
3483'helpheight' 'hh' number (default 20)
3484 global
3485 {not in Vi}
3486 {not available when compiled without the +windows
3487 feature}
3488 Minimal initial height of the help window when it is opened with the
3489 ":help" command. The initial height of the help window is half of the
3490 current window, or (when the 'ea' option is on) the same as other
3491 windows. When the height is less than 'helpheight', the height is
3492 set to 'helpheight'. Set to zero to disable.
3493
3494 *'helplang'* *'hlg'*
3495'helplang' 'hlg' string (default: messages language or empty)
3496 global
3497 {only available when compiled with the |+multi_lang|
3498 feature}
3499 {not in Vi}
3500 Comma separated list of languages. Vim will use the first language
3501 for which the desired help can be found. The English help will always
3502 be used as a last resort. You can add "en" to prefer English over
3503 another language, but that will only find tags that exist in that
3504 language and not in the English help.
3505 Example: >
3506 :set helplang=de,it
3507< This will first search German, then Italian and finally English help
3508 files.
3509 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3510 try to find the tag in the current language before using this option.
3511 See |help-translated|.
3512
3513 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3514'hidden' 'hid' boolean (default off)
3515 global
3516 {not in Vi}
3517 When off a buffer is unloaded when it is |abandon|ed. When on a
3518 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3519 displayed in another window, it does not become hidden, of course.
3520 The commands that move through the buffer list sometimes make a buffer
3521 hidden although the 'hidden' option is off: When the buffer is
3522 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003523 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003524 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 This option is set for one command with ":hide {command}" |:hide|.
3526 WARNING: It's easy to forget that you have changes in hidden buffers.
3527 Think twice when using ":q!" or ":qa!".
3528
3529 *'highlight'* *'hl'*
3530'highlight' 'hl' string (default (as a single string):
3531 "8:SpecialKey,@:NonText,d:Directory,
3532 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3533 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003534 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3536 f:Folded,F:FoldColumn,A:DiffAdd,
3537 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003538 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003539 R:SpellRare,L:SpellLocal,
3540 +:Pmenu,=:PmenuSel,
3541 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 global
3543 {not in Vi}
3544 This option can be used to set highlighting mode for various
3545 occasions. It is a comma separated list of character pairs. The
3546 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003547 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3549 |hl-NonText| @ '~' and '@' at the end of the window and
3550 characters from 'showbreak'
3551 |hl-Directory| d directories in CTRL-D listing and other special
3552 things in listings
3553 |hl-ErrorMsg| e error messages
3554 h (obsolete, ignored)
3555 |hl-IncSearch| i 'incsearch' highlighting
3556 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3557 |hl-MoreMsg| m |more-prompt|
3558 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3559 |hl-LineNr| n line number for ":number" and ":#" commands
3560 |hl-Question| r |hit-enter| prompt and yes/no questions
3561 |hl-StatusLine| s status line of current window |status-line|
3562 |hl-StatusLineNC| S status lines of not-current windows
3563 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3564 |hl-VertSplit| c column used to separate vertically split windows
3565 |hl-Visual| v Visual mode
3566 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3567 Selection" Only X11 Gui's |gui-x11| and
3568 |xterm-clipboard|.
3569 |hl-WarningMsg| w warning messages
3570 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3571 |hl-Folded| f line used for closed folds
3572 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003573 |hl-DiffAdd| A added line in diff mode
3574 |hl-DiffChange| C changed line in diff mode
3575 |hl-DiffDelete| D deleted line in diff mode
3576 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003578 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003579 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003580 |hl-SpellRare| R rare word |spell|
3581 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003582 |hl-Pmenu| + popup menu normal line
3583 |hl-PmenuSel| = popup menu normal line
3584 |hl-PmenuSbar| x popup menu scrollbar
3585 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586
3587 The display modes are:
3588 r reverse (termcap entry "mr" and "me")
3589 i italic (termcap entry "ZH" and "ZR")
3590 b bold (termcap entry "md" and "me")
3591 s standout (termcap entry "so" and "se")
3592 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003593 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 n no highlighting
3595 - no highlighting
3596 : use a highlight group
3597 The default is used for occasions that are not included.
3598 If you want to change what the display modes do, see |dos-colors|
3599 for an example.
3600 When using the ':' display mode, this must be followed by the name of
3601 a highlight group. A highlight group can be used to define any type
3602 of highlighting, including using color. See |:highlight| on how to
3603 define one. The default uses a different group for each occasion.
3604 See |highlight-default| for the default highlight groups.
3605
3606 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3607'hlsearch' 'hls' boolean (default off)
3608 global
3609 {not in Vi}
3610 {not available when compiled without the
3611 |+extra_search| feature}
3612 When there is a previous search pattern, highlight all its matches.
3613 The type of highlighting used can be set with the 'l' occasion in the
3614 'highlight' option. This uses the "Search" highlight group by
3615 default. Note that only the matching text is highlighted, any offsets
3616 are not applied.
3617 See also: 'incsearch' and |:match|.
3618 When you get bored looking at the highlighted matches, you can turn it
3619 off with |:nohlsearch|. As soon as you use a search command, the
3620 highlighting comes back.
3621 When the search pattern can match an end-of-line, Vim will try to
3622 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003623 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003625 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003626 NOTE: This option is reset when 'compatible' is set.
3627
3628 *'history'* *'hi'*
3629'history' 'hi' number (Vim default: 20, Vi default: 0)
3630 global
3631 {not in Vi}
3632 A history of ":" commands, and a history of previous search patterns
3633 are remembered. This option decides how many entries may be stored in
3634 each of these histories (see |cmdline-editing|).
3635 NOTE: This option is set to the Vi default value when 'compatible' is
3636 set and to the Vim default value when 'compatible' is reset.
3637
3638 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3639'hkmap' 'hk' boolean (default off)
3640 global
3641 {not in Vi}
3642 {only available when compiled with the |+rightleft|
3643 feature}
3644 When on, the keyboard is mapped for the Hebrew character set.
3645 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3646 toggle this option. See |rileft.txt|.
3647 NOTE: This option is reset when 'compatible' is set.
3648
3649 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3650'hkmapp' 'hkp' boolean (default off)
3651 global
3652 {not in Vi}
3653 {only available when compiled with the |+rightleft|
3654 feature}
3655 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3656 This is useful if you have a non-Hebrew keyboard.
3657 See |rileft.txt|.
3658 NOTE: This option is reset when 'compatible' is set.
3659
3660 *'icon'* *'noicon'*
3661'icon' boolean (default off, on when title can be restored)
3662 global
3663 {not in Vi}
3664 {not available when compiled without the |+title|
3665 feature}
3666 When on, the icon text of the window will be set to the value of
3667 'iconstring' (if it is not empty), or to the name of the file
3668 currently being edited. Only the last part of the name is used.
3669 Overridden by the 'iconstring' option.
3670 Only works if the terminal supports setting window icons (currently
3671 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3672 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3673 builtin termcap).
3674 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003675 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 X11.
3677
3678 *'iconstring'*
3679'iconstring' string (default "")
3680 global
3681 {not in Vi}
3682 {not available when compiled without the |+title|
3683 feature}
3684 When this option is not empty, it will be used for the icon text of
3685 the window. This happens only when the 'icon' option is on.
3686 Only works if the terminal supports setting window icon text
3687 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3688 Does not work for MS Windows.
3689 When Vim was compiled with HAVE_X11 defined, the original icon will be
3690 restored if possible |X11|.
3691 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003692 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 'titlestring' for example settings.
3694 {not available when compiled without the |+statusline| feature}
3695
3696 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3697'ignorecase' 'ic' boolean (default off)
3698 global
3699 Ignore case in search patterns. Also used when searching in the tags
3700 file.
3701 Also see 'smartcase'.
3702 Can be overruled by using "\c" or "\C" in the pattern, see
3703 |/ignorecase|.
3704
3705 *'imactivatekey'* *'imak'*
3706'imactivatekey' 'imak' string (default "")
3707 global
3708 {not in Vi}
3709 {only available when compiled with |+xim| and
3710 |+GUI_GTK|}
3711 Specifies the key that your Input Method in X-Windows uses for
3712 activation. When this is specified correctly, vim can fully control
3713 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3714 You can't use this option to change the activation key, the option
3715 tells Vim what the key is.
3716 Format:
3717 [MODIFIER_FLAG-]KEY_STRING
3718
3719 These characters can be used for MODIFIER_FLAG (case is ignored):
3720 S Shift key
3721 L Lock key
3722 C Control key
3723 1 Mod1 key
3724 2 Mod2 key
3725 3 Mod3 key
3726 4 Mod4 key
3727 5 Mod5 key
3728 Combinations are allowed, for example "S-C-space" or "SC-space" are
3729 both shift+ctrl+space.
3730 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3731
3732 Example: >
3733 :set imactivatekey=S-space
3734< "S-space" means shift+space. This is the activation key for kinput2 +
3735 canna (Japanese), and ami (Korean).
3736
3737 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3738'imcmdline' 'imc' boolean (default off)
3739 global
3740 {not in Vi}
3741 {only available when compiled with the |+xim|
3742 |+multi_byte_ime| or |global-ime| feature}
3743 When set the Input Method is always on when starting to edit a command
3744 line, unless entering a search pattern (see 'imsearch' for that).
3745 Setting this option is useful when your input method allows entering
3746 English characters directly, e.g., when it's used to type accented
3747 characters with dead keys.
3748
3749 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3750'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3751 global
3752 {not in Vi}
3753 {only available when compiled with the |+xim|
3754 |+multi_byte_ime| or |global-ime| feature}
3755 When set the Input Method is never used. This is useful to disable
3756 the IM when it doesn't work properly.
3757 Currently this option is on by default for SGI/IRIX machines. This
3758 may change in later releases.
3759
3760 *'iminsert'* *'imi'*
3761'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3762 local to buffer
3763 {not in Vi}
3764 Specifies whether :lmap or an Input Method (IM) is to be used in
3765 Insert mode. Valid values:
3766 0 :lmap is off and IM is off
3767 1 :lmap is ON and IM is off
3768 2 :lmap is off and IM is ON
3769 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3770 or |global-ime|.
3771 To always reset the option to zero when leaving Insert mode with <Esc>
3772 this can be used: >
3773 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3774< This makes :lmap and IM turn off automatically when leaving Insert
3775 mode.
3776 Note that this option changes when using CTRL-^ in Insert mode
3777 |i_CTRL-^|.
3778 The value is set to 1 when setting 'keymap' to a valid keymap name.
3779 It is also used for the argument of commands like "r" and "f".
3780 The value 0 may not work correctly with Athena and Motif with some XIM
3781 methods. Use 'imdisable' to disable XIM then.
3782
3783 *'imsearch'* *'ims'*
3784'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3785 local to buffer
3786 {not in Vi}
3787 Specifies whether :lmap or an Input Method (IM) is to be used when
3788 entering a search pattern. Valid values:
3789 -1 the value of 'iminsert' is used, makes it look like
3790 'iminsert' is also used when typing a search pattern
3791 0 :lmap is off and IM is off
3792 1 :lmap is ON and IM is off
3793 2 :lmap is off and IM is ON
3794 Note that this option changes when using CTRL-^ in Command-line mode
3795 |c_CTRL-^|.
3796 The value is set to 1 when it is not -1 and setting the 'keymap'
3797 option to a valid keymap name.
3798 The value 0 may not work correctly with Athena and Motif with some XIM
3799 methods. Use 'imdisable' to disable XIM then.
3800
3801 *'include'* *'inc'*
3802'include' 'inc' string (default "^\s*#\s*include")
3803 global or local to buffer |global-local|
3804 {not in Vi}
3805 {not available when compiled without the
3806 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003807 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 pattern, just like for the "/" command (See |pattern|). The default
3809 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003810 "]I", "[d", etc.
3811 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003812 comes after the matched pattern. But if "\zs" appears in the pattern
3813 then the text matched from "\zs" to the end, or until "\ze" if it
3814 appears, is used as the file name. Use this to include characters
3815 that are not in 'isfname', such as a space. You can then use
3816 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003817 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818
3819 *'includeexpr'* *'inex'*
3820'includeexpr' 'inex' string (default "")
3821 local to buffer
3822 {not in Vi}
3823 {not available when compiled without the
3824 |+find_in_path| or |+eval| feature}
3825 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003826 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 :set includeexpr=substitute(v:fname,'\\.','/','g')
3828< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003829
Bram Moolenaar071d4272004-06-13 20:20:40 +00003830 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003831 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 Also used for |<cfile>|.
3833
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003834 The expression may be evaluated in the |sandbox|, see
3835 |sandbox-option|.
3836
3837 It is not allowed to change text or jump to another window while
3838 evaluating 'includeexpr' |textlock|.
3839
Bram Moolenaar071d4272004-06-13 20:20:40 +00003840 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3841'incsearch' 'is' boolean (default off)
3842 global
3843 {not in Vi}
3844 {not available when compiled without the
3845 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003846 While typing a search command, show where the pattern, as it was typed
3847 so far, matches. The matched string is highlighted. If the pattern
3848 is invalid or not found, nothing is shown. The screen will be updated
3849 often, this is only useful on fast terminals.
3850 Note that the match will be shown, but the cursor will return to its
3851 original position when no match is found and when pressing <Esc>. You
3852 still need to finish the search command with <Enter> to move the
3853 cursor to the match.
3854 The highlighting can be set with the 'i' flag in 'highlight'.
3855 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003856 CTRL-L can be used to add one character from after the current match
3857 to the command line.
3858 CTRL-R CTRL-W can be used to add the word at the end of the current
3859 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003860 NOTE: This option is reset when 'compatible' is set.
3861
3862 *'indentexpr'* *'inde'*
3863'indentexpr' 'inde' string (default "")
3864 local to buffer
3865 {not in Vi}
3866 {not available when compiled without the |+cindent|
3867 or |+eval| features}
3868 Expression which is evaluated to obtain the proper indent for a line.
3869 It is used when a new line is created, for the |=| operator and
3870 in Insert mode as specified with the 'indentkeys' option.
3871 When this option is not empty, it overrules the 'cindent' and
3872 'smartindent' indenting.
3873 When 'paste' is set this option is not used for indenting.
3874 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003875 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003876 when the expression is evaluated (but it may be moved around).
3877 The expression must return the number of spaces worth of indent. It
3878 can return "-1" to keep the current indent (this means 'autoindent' is
3879 used for the indent).
3880 Functions useful for computing the indent are |indent()|, |cindent()|
3881 and |lispindent()|.
3882 The evaluation of the expression must not have side effects! It must
3883 not change the text, jump to another window, etc. Afterwards the
3884 cursor position is always restored, thus the cursor may be moved.
3885 Normally this option would be set to call a function: >
3886 :set indentexpr=GetMyIndent()
3887< Error messages will be suppressed, unless the 'debug' option contains
3888 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003889 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003890 NOTE: This option is made empty when 'compatible' is set.
3891
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003892 The expression may be evaluated in the |sandbox|, see
3893 |sandbox-option|.
3894
3895 It is not allowed to change text or jump to another window while
3896 evaluating 'indentexpr' |textlock|.
3897
3898
Bram Moolenaar071d4272004-06-13 20:20:40 +00003899 *'indentkeys'* *'indk'*
3900'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3901 local to buffer
3902 {not in Vi}
3903 {not available when compiled without the |+cindent|
3904 feature}
3905 A list of keys that, when typed in Insert mode, cause reindenting of
3906 the current line. Only happens if 'indentexpr' isn't empty.
3907 The format is identical to 'cinkeys', see |indentkeys-format|.
3908 See |C-indenting| and |indent-expression|.
3909
3910 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3911'infercase' 'inf' boolean (default off)
3912 local to buffer
3913 {not in Vi}
3914 When doing keyword completion in insert mode |ins-completion|, and
3915 'ignorecase' is also on, the case of the match is adjusted. If the
3916 typed text contains a lowercase letter where the match has an upper
3917 case letter, the completed part is made lowercase. If the typed text
3918 has no lowercase letters and the match has a lowercase letter where
3919 the typed text has an uppercase letter, and there is a letter before
3920 it, the completed part is made uppercase.
3921
3922 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3923'insertmode' 'im' boolean (default off)
3924 global
3925 {not in Vi}
3926 Makes Vim work in a way that Insert mode is the default mode. Useful
3927 if you want to use Vim as a modeless editor. Used for |evim|.
3928 These Insert mode commands will be useful:
3929 - Use the cursor keys to move around.
3930 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3931 this is a mapping, it is executed as if 'insertmode' was off.
3932 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003933 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003934 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3935 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936
3937 These items change when 'insertmode' is set:
3938 - when starting to edit of a file, Vim goes to Insert mode.
3939 - <Esc> in Insert mode is a no-op and beeps.
3940 - <Esc> in Normal mode makes Vim go to Insert mode.
3941 - CTRL-L in Insert mode is a command, it is not inserted.
3942 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3943 However, when <Esc> is used inside a mapping, it behaves like
3944 'insertmode' was not set. This was done to be able to use the same
3945 mappings with 'insertmode' set or not set.
3946 When executing commands with |:normal| 'insertmode' is not used.
3947
3948 NOTE: This option is reset when 'compatible' is set.
3949
3950 *'isfname'* *'isf'*
3951'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3952 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3953 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3954 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3955 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3956 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3957 global
3958 {not in Vi}
3959 The characters specified by this option are included in file names and
3960 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003961 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 Multi-byte characters 256 and above are always included, only the
3963 characters up to 255 are specified with this option.
3964 For UTF-8 the characters 0xa0 to 0xff are included as well.
3965
3966 Note that on systems using a backslash as path separator, Vim tries to
3967 do its best to make it work as you would expect. That is a bit
3968 tricky, since Vi originally used the backslash to escape special
3969 characters. Vim will not remove a backslash in front of a normal file
3970 name character on these systems, but it will on Unix and alikes. The
3971 '&' and '^' are not included by default, because these are special for
3972 cmd.exe.
3973
3974 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003975 Each part can be a single character number or a range. A range is two
3976 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 decimal number between 0 and 255 or the ASCII character itself (does
3978 not work for digits). Example:
3979 "_,-,128-140,#-43" (include '_' and '-' and the range
3980 128 to 140 and '#' to 43)
3981 If a part starts with '^', the following character number or range
3982 will be excluded from the option. The option is interpreted from left
3983 to right. Put the excluded character after the range where it is
3984 included. To include '^' itself use it as the last character of the
3985 option or the end of a range. Example:
3986 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3987 If the character is '@', all characters where isalpha() returns TRUE
3988 are included. Normally these are the characters a to z and A to Z,
3989 plus accented characters. To include '@' itself use "@-@". Examples:
3990 "@,^a-z" All alphabetic characters, excluding lower
3991 case letters.
3992 "a-z,A-Z,@-@" All letters plus the '@' character.
3993 A comma can be included by using it where a character number is
3994 expected. Example:
3995 "48-57,,,_" Digits, comma and underscore.
3996 A comma can be excluded by prepending a '^'. Example:
3997 " -~,^,,9" All characters from space to '~', excluding
3998 comma, plus <Tab>.
3999 See |option-backslash| about including spaces and backslashes.
4000
4001 *'isident'* *'isi'*
4002'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4003 "@,48-57,_,128-167,224-235"
4004 otherwise: "@,48-57,_,192-255")
4005 global
4006 {not in Vi}
4007 The characters given by this option are included in identifiers.
4008 Identifiers are used in recognizing environment variables and after a
4009 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004010 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 option.
4012 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004013 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4015
4016 *'iskeyword'* *'isk'*
4017'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4018 "@,48-57,_,128-167,224-235"
4019 otherwise: "@,48-57,_,192-255"
4020 Vi default: "@,48-57,_")
4021 local to buffer
4022 {not in Vi}
4023 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004024 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 'isfname' for a description of the format of this option. For C
4026 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4027 For a help file it is set to all non-blank printable characters except
4028 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4029 command).
4030 When the 'lisp' option is on the '-' character is always included.
4031 NOTE: This option is set to the Vi default value when 'compatible' is
4032 set and to the Vim default value when 'compatible' is reset.
4033
4034 *'isprint'* *'isp'*
4035'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4036 "@,~-255"; otherwise: "@,161-255")
4037 global
4038 {not in Vi}
4039 The characters given by this option are displayed directly on the
4040 screen. It is also used for "\p" in a |pattern|. The characters from
4041 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4042 even when they are not included in 'isprint' or excluded. See
4043 'isfname' for a description of the format of this option.
4044
4045 Non-printable characters are displayed with two characters:
4046 0 - 31 "^@" - "^_"
4047 32 - 126 always single characters
4048 127 "^?"
4049 128 - 159 "~@" - "~_"
4050 160 - 254 "| " - "|~"
4051 255 "~?"
4052 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4053 displayed as <xx>, with the hexadecimal value of the byte.
4054 When 'display' contains "uhex" all unprintable characters are
4055 displayed as <xx>.
4056 The NonText highlighting will be used for unprintable characters.
4057 |hl-NonText|
4058
4059 Multi-byte characters 256 and above are always included, only the
4060 characters up to 255 are specified with this option. When a character
4061 is printable but it is not available in the current font, a
4062 replacement character will be shown.
4063 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4064 There is no option to specify these characters.
4065
4066 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4067'joinspaces' 'js' boolean (default on)
4068 global
4069 {not in Vi}
4070 Insert two spaces after a '.', '?' and '!' with a join command.
4071 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4072 Otherwise only one space is inserted.
4073 NOTE: This option is set when 'compatible' is set.
4074
4075 *'key'*
4076'key' string (default "")
4077 local to buffer
4078 {not in Vi}
4079 The key that is used for encrypting and decrypting the current buffer.
4080 See |encryption|.
4081 Careful: Do not set the key value by hand, someone might see the typed
4082 key. Use the |:X| command. But you can make 'key' empty: >
4083 :set key=
4084< It is not possible to get the value of this option with ":set key" or
4085 "echo &key". This is to avoid showing it to someone who shouldn't
4086 know. It also means you cannot see it yourself once you have set it,
4087 be careful not to make a typing error!
4088
4089 *'keymap'* *'kmp'* *E544*
4090'keymap' 'kmp' string (default "")
4091 local to buffer
4092 {not in Vi}
4093 {only available when compiled with the |+keymap|
4094 feature}
4095 Name of a keyboard mapping. See |mbyte-keymap|.
4096 Setting this option to a valid keymap name has the side effect of
4097 setting 'iminsert' to one, so that the keymap becomes effective.
4098 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004099 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100
4101 *'keymodel'* *'km'*
4102'keymodel' 'km' string (default "")
4103 global
4104 {not in Vi}
4105 List of comma separated words, which enable special things that keys
4106 can do. These values can be used:
4107 startsel Using a shifted special key starts selection (either
4108 Select mode or Visual mode, depending on "key" being
4109 present in 'selectmode').
4110 stopsel Using a not-shifted special key stops selection.
4111 Special keys in this context are the cursor keys, <End>, <Home>,
4112 <PageUp> and <PageDown>.
4113 The 'keymodel' option is set by the |:behave| command.
4114
4115 *'keywordprg'* *'kp'*
4116'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4117 OS/2: "view /", VMS: "help")
4118 global or local to buffer |global-local|
4119 {not in Vi}
4120 Program to use for the |K| command. Environment variables are
4121 expanded |:set_env|. ":help" may be used to access the Vim internal
4122 help. (Note that previously setting the global option to the empty
4123 value did this, which is now deprecated.)
4124 When "man" is used, Vim will automatically translate a count for the
4125 "K" command to a section number. Also for "man -s", in which case the
4126 "-s" is removed when there is no count.
4127 See |option-backslash| about including spaces and backslashes.
4128 Example: >
4129 :set keywordprg=man\ -s
4130< This option cannot be set from a |modeline| or in the |sandbox|, for
4131 security reasons.
4132
4133 *'langmap'* *'lmap'* *E357* *E358*
4134'langmap' 'lmap' string (default "")
4135 global
4136 {not in Vi}
4137 {only available when compiled with the |+langmap|
4138 feature}
4139 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004140 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004141 inserted directly. When in command mode the 'langmap' option takes
4142 care of translating these special characters to the original meaning
4143 of the key. This means you don't have to change the keyboard mode to
4144 be able to execute Normal mode commands.
4145 This is the opposite of the 'keymap' option, where characters are
4146 mapped in Insert mode.
4147 This only works for 8-bit characters. The value of 'langmap' may be
4148 specified with multi-byte characters (e.g., UTF-8), but only the lower
4149 8 bits of each character will be used.
4150
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004151 Example (for Greek, in UTF-8): *greek* >
4152 :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 +00004153< Example (exchanges meaning of z and y for commands): >
4154 :set langmap=zy,yz,ZY,YZ
4155<
4156 The 'langmap' option is a list of parts, separated with commas. Each
4157 part can be in one of two forms:
4158 1. A list of pairs. Each pair is a "from" character immediately
4159 followed by the "to" character. Examples: "aA", "aAbBcC".
4160 2. A list of "from" characters, a semi-colon and a list of "to"
4161 characters. Example: "abc;ABC"
4162 Example: "aA,fgh;FGH,cCdDeE"
4163 Special characters need to be preceded with a backslash. These are
4164 ";", ',' and backslash itself.
4165
4166 This will allow you to activate vim actions without having to switch
4167 back and forth between the languages. Your language characters will
4168 be understood as normal vim English characters (according to the
4169 langmap mappings) in the following cases:
4170 o Normal/Visual mode (commands, buffer/register names, user mappings)
4171 o Insert/Replace Mode: Register names after CTRL-R
4172 o Insert/Replace Mode: Mappings
4173 Characters entered in Command-line mode will NOT be affected by
4174 this option. Note that this option can be changed at any time
4175 allowing to switch between mappings for different languages/encodings.
4176 Use a mapping to avoid having to type it each time!
4177
4178 *'langmenu'* *'lm'*
4179'langmenu' 'lm' string (default "")
4180 global
4181 {not in Vi}
4182 {only available when compiled with the |+menu| and
4183 |+multi_lang| features}
4184 Language to use for menu translation. Tells which file is loaded
4185 from the "lang" directory in 'runtimepath': >
4186 "lang/menu_" . &langmenu . ".vim"
4187< (without the spaces). For example, to always use the Dutch menus, no
4188 matter what $LANG is set to: >
4189 :set langmenu=nl_NL.ISO_8859-1
4190< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004191 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 If your $LANG is set to a non-English language but you do want to use
4193 the English menus: >
4194 :set langmenu=none
4195< This option must be set before loading menus, switching on filetype
4196 detection or syntax highlighting. Once the menus are defined setting
4197 this option has no effect. But you could do this: >
4198 :source $VIMRUNTIME/delmenu.vim
4199 :set langmenu=de_DE.ISO_8859-1
4200 :source $VIMRUNTIME/menu.vim
4201< Warning: This deletes all menus that you defined yourself!
4202
4203 *'laststatus'* *'ls'*
4204'laststatus' 'ls' number (default 1)
4205 global
4206 {not in Vi}
4207 The value of this option influences when the last window will have a
4208 status line:
4209 0: never
4210 1: only if there are at least two windows
4211 2: always
4212 The screen looks nicer with a status line if you have several
4213 windows, but it takes another screen line. |status-line|
4214
4215 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4216'lazyredraw' 'lz' boolean (default off)
4217 global
4218 {not in Vi}
4219 When this option is set, the screen will not be redrawn while
4220 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004221 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004222 update use |:redraw|.
4223
4224 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4225'linebreak' 'lbr' boolean (default off)
4226 local to window
4227 {not in Vi}
4228 {not available when compiled without the |+linebreak|
4229 feature}
4230 If on Vim will wrap long lines at a character in 'breakat' rather
4231 than at the last character that fits on the screen. Unlike
4232 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4233 it only affects the way the file is displayed, not its contents. The
4234 value of 'showbreak' is used to put in front of wrapped lines.
4235 This option is not used when the 'wrap' option is off or 'list' is on.
4236 Note that <Tab> characters after an <EOL> are mostly not displayed
4237 with the right amount of white space.
4238
4239 *'lines'* *E593*
4240'lines' number (default 24 or terminal height)
4241 global
4242 Number of lines of the Vim window.
4243 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004244 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004245 When Vim is running in the GUI or in a resizable window, setting this
4246 option will cause the window size to be changed. When you only want
4247 to use the size for the GUI, put the command in your |gvimrc| file.
4248 Vim limits the number of lines to what fits on the screen. You can
4249 use this command to get the tallest window possible: >
4250 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004251< Minimum value is 2, maximum value is 1000.
4252 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 When you set this option and Vim is unable to change the physical
4254 number of lines of the display, the display may be messed up.
4255
4256 *'linespace'* *'lsp'*
4257'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4258 global
4259 {not in Vi}
4260 {only in the GUI}
4261 Number of pixel lines inserted between characters. Useful if the font
4262 uses the full character cell height, making lines touch each other.
4263 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004264 With some fonts there can be too much room between lines (to have
4265 space for ascents and descents). Then it makes sense to set
4266 'linespace' to a negative value. This may cause display problems
4267 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268
4269 *'lisp'* *'nolisp'*
4270'lisp' boolean (default off)
4271 local to buffer
4272 {not available when compiled without the |+lispindent|
4273 feature}
4274 Lisp mode: When <Enter> is typed in insert mode set the indent for
4275 the next line to Lisp standards (well, sort of). Also happens with
4276 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4277 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4278 better. Also see 'lispwords'.
4279 The '-' character is included in keyword characters. Redefines the
4280 "=" operator to use this same indentation algorithm rather than
4281 calling an external program if 'equalprg' is empty.
4282 This option is not used when 'paste' is set.
4283 {Vi: Does it a little bit differently}
4284
4285 *'lispwords'* *'lw'*
4286'lispwords' 'lw' string (default is very long)
4287 global
4288 {not in Vi}
4289 {not available when compiled without the |+lispindent|
4290 feature}
4291 Comma separated list of words that influence the Lisp indenting.
4292 |'lisp'|
4293
4294 *'list'* *'nolist'*
4295'list' boolean (default off)
4296 local to window
4297 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4298 see the difference between tabs and spaces and for trailing blanks.
4299 Note that this will also affect formatting (set with 'textwidth' or
4300 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4301 changing the way tabs are displayed.
4302
4303 *'listchars'* *'lcs'*
4304'listchars' 'lcs' string (default "eol:$")
4305 global
4306 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004307 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 settings.
4309 eol:c Character to show at the end of each line. When
4310 omitted, there is no extra character at the end of the
4311 line.
4312 tab:xy Two characters to be used to show a Tab. The first
4313 char is used once. The second char is repeated to
4314 fill the space that the Tab normally occupies.
4315 "tab:>-" will show a Tab that takes four spaces as
4316 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004317 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004318 trailing spaces are blank.
4319 extends:c Character to show in the last column, when 'wrap' is
4320 off and the line continues beyond the right of the
4321 screen.
4322 precedes:c Character to show in the first column, when 'wrap'
4323 is off and there is text preceding the character
4324 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004325 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004326 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004327
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004328 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004330 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004331
4332 Examples: >
4333 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004334 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004335 :set lcs=extends:>,precedes:<
4336< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004337 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004338 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004339
4340 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4341'loadplugins' 'lpl' boolean (default on)
4342 global
4343 {not in Vi}
4344 When on the plugin scripts are loaded when starting up |load-plugins|.
4345 This option can be reset in your |vimrc| file to disable the loading
4346 of plugins.
4347 Note that using the "-u NONE" and "--noplugin" command line arguments
4348 reset this option. |-u| |--noplugin|
4349
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004350 *'macatsui'* *'nomacatsui'*
4351'macatsui' boolean (default on)
4352 global
4353 {only available in Mac GUI version}
4354 This is a workaround for when drawing doesn't work properly. When set
4355 and compiled with multi-byte support ATSUI text drawing is used. When
4356 not set ATSUI text drawing is not used. Switch this option off when
4357 you experience drawing problems. In a future version the problems may
4358 be solved and this option becomes obsolete. Therefore use this method
4359 to unset it: >
4360 if exists('&macatsui')
4361 set nomacatsui
4362 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004363< Another option to check if you have drawing problems is
4364 'termencoding'.
4365
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 *'magic'* *'nomagic'*
4367'magic' boolean (default on)
4368 global
4369 Changes the special characters that can be used in search patterns.
4370 See |pattern|.
4371 NOTE: To avoid portability problems with using patterns, always keep
4372 this option at the default "on". Only switch it off when working with
4373 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004374 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004375
4376 *'makeef'* *'mef'*
4377'makeef' 'mef' string (default: "")
4378 global
4379 {not in Vi}
4380 {not available when compiled without the |+quickfix|
4381 feature}
4382 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4383 and the |:grep| command.
4384 When it is empty, an internally generated temp file will be used.
4385 When "##" is included, it is replaced by a number to make the name
4386 unique. This makes sure that the ":make" command doesn't overwrite an
4387 existing file.
4388 NOT used for the ":cf" command. See 'errorfile' for that.
4389 Environment variables are expanded |:set_env|.
4390 See |option-backslash| about including spaces and backslashes.
4391 This option cannot be set from a |modeline| or in the |sandbox|, for
4392 security reasons.
4393
4394 *'makeprg'* *'mp'*
4395'makeprg' 'mp' string (default "make", VMS: "MMS")
4396 global or local to buffer |global-local|
4397 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004398 Program to use for the ":make" command. See |:make_makeprg|.
4399 This option may contain '%' and '#' characters, which are expanded to
4400 the current and alternate file name. |:_%| |:_#|
4401 Environment variables are expanded |:set_env|. See |option-backslash|
4402 about including spaces and backslashes.
4403 Note that a '|' must be escaped twice: once for ":set" and once for
4404 the interpretation of a command. When you use a filter called
4405 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 :set makeprg=gmake\ \\\|\ myfilter
4407< The placeholder "$*" can be given (even multiple times) to specify
4408 where the arguments will be included, for example: >
4409 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4410< This option cannot be set from a |modeline| or in the |sandbox|, for
4411 security reasons.
4412
4413 *'matchpairs'* *'mps'*
4414'matchpairs' 'mps' string (default "(:),{:},[:]")
4415 local to buffer
4416 {not in Vi}
4417 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004418 other. Currently only single byte character pairs are allowed, and
4419 they must be different. The characters must be separated by a colon.
4420 The pairs must be separated by a comma. Example for including '<' and
4421 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004422 :set mps+=<:>
4423
4424< A more exotic example, to jump between the '=' and ';' in an
4425 assignment, useful for languages like C and Java: >
4426 :au FileType c,cpp,java set mps+==:;
4427
4428< For a more advanced way of using "%", see the matchit.vim plugin in
4429 the $VIMRUNTIME/macros directory. |add-local-help|
4430
4431 *'matchtime'* *'mat'*
4432'matchtime' 'mat' number (default 5)
4433 global
4434 {not in Vi}{in Nvi}
4435 Tenths of a second to show the matching paren, when 'showmatch' is
4436 set. Note that this is not in milliseconds, like other options that
4437 set a time. This is to be compatible with Nvi.
4438
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004439 *'maxcombine'* *'mco'*
4440'maxcombine' 'mco' number (default 2)
4441 global
4442 {not in Vi}
4443 {only available when compiled with the |+multi_byte|
4444 feature}
4445 The maximum number of combining characters supported for displaying.
4446 Only used when 'encoding' is "utf-8".
4447 The default is OK for most languages. Hebrew may require 4.
4448 Maximum value is 6.
4449 Even when this option is set to 2 you can still edit text with more
4450 combining characters, you just can't see them. Use |g8| or |ga|.
4451 See |mbyte-combining|.
4452
Bram Moolenaar071d4272004-06-13 20:20:40 +00004453 *'maxfuncdepth'* *'mfd'*
4454'maxfuncdepth' 'mfd' number (default 100)
4455 global
4456 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004457 {not available when compiled without the +eval
4458 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 Maximum depth of function calls for user functions. This normally
4460 catches endless recursion. When using a recursive function with
4461 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4462 more memory, there is the danger of failing when memory is exhausted.
4463 See also |:function|.
4464
4465 *'maxmapdepth'* *'mmd'* *E223*
4466'maxmapdepth' 'mmd' number (default 1000)
4467 global
4468 {not in Vi}
4469 Maximum number of times a mapping is done without resulting in a
4470 character to be used. This normally catches endless mappings, like
4471 ":map x y" with ":map y x". It still does not catch ":map g wg",
4472 because the 'w' is used before the next mapping is done. See also
4473 |key-mapping|.
4474
4475 *'maxmem'* *'mm'*
4476'maxmem' 'mm' number (default between 256 to 5120 (system
4477 dependent) or half the amount of memory
4478 available)
4479 global
4480 {not in Vi}
4481 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4482 limit is reached allocating extra memory for a buffer will cause
4483 other memory to be freed. Maximum value 2000000. Use this to work
4484 without a limit. Also see 'maxmemtot'.
4485
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004486 *'maxmempattern'* *'mmp'*
4487'maxmempattern' 'mmp' number (default 1000)
4488 global
4489 {not in Vi}
4490 Maximum amount of memory (in Kbyte) to use for pattern matching.
4491 Maximum value 2000000. Use this to work without a limit.
4492 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004493 When Vim runs into the limit it gives an error message and mostly
4494 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004495 Running into the limit often means that the pattern is very
4496 inefficient or too complex. This may already happen with the pattern
4497 "\(.\)*" on a very long line. ".*" works much better.
4498 Vim may run out of memory before hitting the 'maxmempattern' limit.
4499
Bram Moolenaar071d4272004-06-13 20:20:40 +00004500 *'maxmemtot'* *'mmt'*
4501'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4502 dependent) or half the amount of memory
4503 available)
4504 global
4505 {not in Vi}
4506 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004507 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 'maxmem'.
4509
4510 *'menuitems'* *'mis'*
4511'menuitems' 'mis' number (default 25)
4512 global
4513 {not in Vi}
4514 {not available when compiled without the |+menu|
4515 feature}
4516 Maximum number of items to use in a menu. Used for menus that are
4517 generated from a list of items, e.g., the Buffers menu. Changing this
4518 option has no direct effect, the menu must be refreshed first.
4519
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004520 *'mkspellmem'* *'msm'*
4521'mkspellmem' 'msm' string (default "460000,2000,500")
4522 global
4523 {not in Vi}
4524 {not available when compiled without the |+syntax|
4525 feature}
4526 Parameters for |:mkspell|. This tunes when to start compressing the
4527 word tree. Compression can be slow when there are many words, but
4528 it's needed to avoid running out of memory. The amount of memory used
4529 per word depends very much on how similar the words are, that's why
4530 this tuning is complicated.
4531
4532 There are three numbers, separated by commas:
4533 {start},{inc},{added}
4534
4535 For most languages the uncompressed word tree fits in memory. {start}
4536 gives the amount of memory in Kbyte that can be used before any
4537 compression is done. It should be a bit smaller than the amount of
4538 memory that is available to Vim.
4539
4540 When going over the {start} limit the {inc} number specifies the
4541 amount of memory in Kbyte that can be allocated before another
4542 compression is done. A low number means compression is done after
4543 less words are added, which is slow. A high number means more memory
4544 will be allocated.
4545
4546 After doing compression, {added} times 1024 words can be added before
4547 the {inc} limit is ignored and compression is done when any extra
4548 amount of memory is needed. A low number means there is a smaller
4549 chance of hitting the {inc} limit, less memory is used but it's
4550 slower.
4551
4552 The languages for which these numbers are important are Italian and
4553 Hungarian. The default works for when you have about 512 Mbyte. If
4554 you have 1 Gbyte you could use: >
4555 :set mkspellmem=900000,3000,800
4556< If you have less than 512 Mbyte |:mkspell| may fail for some
4557 languages, no matter what you set 'mkspellmem' to.
4558
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004560'modeline' 'ml' boolean (Vim default: on (off for root),
4561 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 local to buffer
4563 *'modelines'* *'mls'*
4564'modelines' 'mls' number (default 5)
4565 global
4566 {not in Vi}
4567 If 'modeline' is on 'modelines' gives the number of lines that is
4568 checked for set commands. If 'modeline' is off or 'modelines' is zero
4569 no lines are checked. See |modeline|.
4570 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4571 set and to the Vim default value when 'compatible' is reset.
4572
4573 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4574'modifiable' 'ma' boolean (default on)
4575 local to buffer
4576 {not in Vi} *E21*
4577 When off the buffer contents cannot be changed. The 'fileformat' and
4578 'fileencoding' options also can't be changed.
4579 Can be reset with the |-M| command line argument.
4580
4581 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4582'modified' 'mod' boolean (default off)
4583 local to buffer
4584 {not in Vi}
4585 When on, the buffer is considered to be modified. This option is set
4586 when:
4587 1. A change was made to the text since it was last written. Using the
4588 |undo| command to go back to the original text will reset the
4589 option. But undoing changes that were made before writing the
4590 buffer will set the option again, since the text is different from
4591 when it was written.
4592 2. 'fileformat' or 'fileencoding' is different from its original
4593 value. The original value is set when the buffer is read or
4594 written. A ":set nomodified" command also resets the original
4595 values to the current values and the 'modified' option will be
4596 reset.
4597 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4598 will be ignored.
4599
4600 *'more'* *'nomore'*
4601'more' boolean (Vim default: on, Vi default: off)
4602 global
4603 {not in Vi}
4604 When on, listings pause when the whole screen is filled. You will get
4605 the |more-prompt|. When this option is off there are no pauses, the
4606 listing continues until finished.
4607 NOTE: This option is set to the Vi default value when 'compatible' is
4608 set and to the Vim default value when 'compatible' is reset.
4609
4610 *'mouse'* *E538*
4611'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4612 global
4613 {not in Vi}
4614 Enable the use of the mouse. Only works for certain terminals
4615 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4616 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4617 The mouse can be enabled for different modes:
4618 n Normal mode
4619 v Visual mode
4620 i Insert mode
4621 c Command-line mode
4622 h all previous modes when editing a help file
4623 a all previous modes
4624 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 Normally you would enable the mouse in all four modes with: >
4626 :set mouse=a
4627< When the mouse is not enabled, the GUI will still use the mouse for
4628 modeless selection. This doesn't move the text cursor.
4629
4630 See |mouse-using|. Also see |'clipboard'|.
4631
4632 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004633 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 the mouse buttons can still be used by keeping the shift key pressed.
4635 Also see the 'clipboard' option.
4636
4637 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4638'mousefocus' 'mousef' boolean (default off)
4639 global
4640 {not in Vi}
4641 {only works in the GUI}
4642 The window that the mouse pointer is on is automatically activated.
4643 When changing the window layout or window focus in another way, the
4644 mouse pointer is moved to the window with keyboard focus. Off is the
4645 default because it makes using the pull down menus a little goofy, as
4646 a pointer transit may activate a window unintentionally.
4647
4648 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4649'mousehide' 'mh' boolean (default on)
4650 global
4651 {not in Vi}
4652 {only works in the GUI}
4653 When on, the mouse pointer is hidden when characters are typed.
4654 The mouse pointer is restored when the mouse is moved.
4655
4656 *'mousemodel'* *'mousem'*
4657'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4658 global
4659 {not in Vi}
4660 Sets the model to use for the mouse. The name mostly specifies what
4661 the right mouse button is used for:
4662 extend Right mouse button extends a selection. This works
4663 like in an xterm.
4664 popup Right mouse button pops up a menu. The shifted left
4665 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004666 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 popup_setpos Like "popup", but the cursor will be moved to the
4668 position where the mouse was clicked, and thus the
4669 selected operation will act upon the clicked object.
4670 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004671 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004672 course, that right clicking outside a selection will
4673 end Visual mode.
4674 Overview of what button does what for each model:
4675 mouse extend popup(_setpos) ~
4676 left click place cursor place cursor
4677 left drag start selection start selection
4678 shift-left search word extend selection
4679 right click extend selection popup menu (place cursor)
4680 right drag extend selection -
4681 middle click paste paste
4682
4683 In the "popup" model the right mouse button produces a pop-up menu.
4684 You need to define this first, see |popup-menu|.
4685
4686 Note that you can further refine the meaning of buttons with mappings.
4687 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4688 selection (because that's handled in the GUI code directly).
4689
4690 The 'mousemodel' option is set by the |:behave| command.
4691
4692 *'mouseshape'* *'mouses'* *E547*
4693'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004694 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004695 global
4696 {not in Vi}
4697 {only available when compiled with the |+mouseshape|
4698 feature}
4699 This option tells Vim what the mouse pointer should look like in
4700 different modes. The option is a comma separated list of parts, much
4701 like used for 'guicursor'. Each part consist of a mode/location-list
4702 and an argument-list:
4703 mode-list:shape,mode-list:shape,..
4704 The mode-list is a dash separated list of these modes/locations:
4705 In a normal window: ~
4706 n Normal mode
4707 v Visual mode
4708 ve Visual mode with 'selection' "exclusive" (same as 'v',
4709 if not specified)
4710 o Operator-pending mode
4711 i Insert mode
4712 r Replace mode
4713
4714 Others: ~
4715 c appending to the command-line
4716 ci inserting in the command-line
4717 cr replacing in the command-line
4718 m at the 'Hit ENTER' or 'More' prompts
4719 ml idem, but cursor in the last line
4720 e any mode, pointer below last window
4721 s any mode, pointer on a status line
4722 sd any mode, while dragging a status line
4723 vs any mode, pointer on a vertical separator line
4724 vd any mode, while dragging a vertical separator line
4725 a everywhere
4726
4727 The shape is one of the following:
4728 avail name looks like ~
4729 w x arrow Normal mouse pointer
4730 w x blank no pointer at all (use with care!)
4731 w x beam I-beam
4732 w x updown up-down sizing arrows
4733 w x leftright left-right sizing arrows
4734 w x busy The system's usual busy pointer
4735 w x no The system's usual 'no input' pointer
4736 x udsizing indicates up-down resizing
4737 x lrsizing indicates left-right resizing
4738 x crosshair like a big thin +
4739 x hand1 black hand
4740 x hand2 white hand
4741 x pencil what you write with
4742 x question big ?
4743 x rightup-arrow arrow pointing right-up
4744 w x up-arrow arrow pointing up
4745 x <number> any X11 pointer number (see X11/cursorfont.h)
4746
4747 The "avail" column contains a 'w' if the shape is available for Win32,
4748 x for X11.
4749 Any modes not specified or shapes not available use the normal mouse
4750 pointer.
4751
4752 Example: >
4753 :set mouseshape=s:udsizing,m:no
4754< will make the mouse turn to a sizing arrow over the status lines and
4755 indicate no input when the hit-enter prompt is displayed (since
4756 clicking the mouse has no effect in this state.)
4757
4758 *'mousetime'* *'mouset'*
4759'mousetime' 'mouset' number (default 500)
4760 global
4761 {not in Vi}
4762 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4763 time in msec between two mouse clicks for the second click to be
4764 recognized as a multi click.
4765
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004766 *'mzquantum'* *'mzq'*
4767'mzquantum' 'mzq' number (default 100)
4768 global
4769 {not in Vi}
4770 {not available when compiled without the |+mzscheme|
4771 feature}
4772 The number of milliseconds between polls for MzScheme threads.
4773 Negative or zero value means no thread scheduling.
4774
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 *'nrformats'* *'nf'*
4776'nrformats' 'nf' string (default "octal,hex")
4777 local to buffer
4778 {not in Vi}
4779 This defines what bases Vim will consider for numbers when using the
4780 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4781 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004782 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004783 incremented or decremented. This is useful for a list with a
4784 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004785 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004787 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 considered to be hexadecimal. Example: Using CTRL-X on
4789 "0x100" results in "0x0ff".
4790 Numbers which simply begin with a digit in the range 1-9 are always
4791 considered decimal. This also happens for numbers that are not
4792 recognized as octal or hex.
4793
4794 *'number'* *'nu'* *'nonumber'* *'nonu'*
4795'number' 'nu' boolean (default off)
4796 local to window
4797 Print the line number in front of each line. When the 'n' option is
4798 excluded from 'cpoptions' a wrapped line will not use the column of
4799 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004800 The 'numberwidth' option can be used to set the room used for the line
4801 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004802 When a long, wrapped line doesn't start with the first character, '-'
4803 characters are put before the number.
4804 See |hl-LineNr| for the highlighting used for the number.
4805
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004806 *'numberwidth'* *'nuw'*
4807'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4808 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004809 {not in Vi}
4810 {only available when compiled with the |+linebreak|
4811 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004812 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004813 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004814 Since one space is always between the number and the text, there is
4815 one less character for the number itself.
4816 The value is the minimum width. A bigger width is used when needed to
4817 fit the highest line number in the buffer. Thus with the Vim default
4818 of 4 there is room for a line number up to 999. When the buffer has
4819 1000 lines five columns will be used.
4820 The minimum value is 1, the maximum value is 10.
4821 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4822
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004823 *'omnifunc'* *'ofu'*
4824'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004825 local to buffer
4826 {not in Vi}
4827 {not available when compiled without the +eval
4828 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004829 This option specifies a function to be used for Insert mode omni
4830 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004831 See |complete-functions| for an explanation of how the function is
4832 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004833 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004834 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004835
4836
Bram Moolenaar02467872007-05-06 13:22:01 +00004837 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004838'opendevice' 'odev' boolean (default off)
4839 global
4840 {not in Vi}
4841 {only for MS-DOS, MS-Windows and OS/2}
4842 Enable reading and writing from devices. This may get Vim stuck on a
4843 device that can be opened but doesn't actually do the I/O. Therefore
4844 it is off by default.
4845 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4846 result in editing a device.
4847
4848
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004849 *'operatorfunc'* *'opfunc'*
4850'operatorfunc' 'opfunc' string (default: empty)
4851 global
4852 {not in Vi}
4853 This option specifies a function to be called by the |g@| operator.
4854 See |:map-operator| for more info and an example.
4855
4856 This option cannot be set from a |modeline| or in the |sandbox|, for
4857 security reasons.
4858
4859
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 *'osfiletype'* *'oft'* *E366*
4861'osfiletype' 'oft' string (RISC-OS default: "Text",
4862 others default: "")
4863 local to buffer
4864 {not in Vi}
4865 {only available when compiled with the |+osfiletype|
4866 feature}
4867 Some operating systems store extra information about files besides
4868 name, datestamp and permissions. This option contains the extra
4869 information, the nature of which will vary between systems.
4870 The value of this option is usually set when the file is loaded, and
4871 use to set the file type when file is written.
4872 It can affect the pattern matching of the automatic commands.
4873 |autocmd-osfiletypes|
4874
4875 *'paragraphs'* *'para'*
4876'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4877 global
4878 Specifies the nroff macros that separate paragraphs. These are pairs
4879 of two letters (see |object-motions|).
4880
4881 *'paste'* *'nopaste'*
4882'paste' boolean (default off)
4883 global
4884 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004885 Put Vim in Paste mode. This is useful if you want to cut or copy
4886 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 unexpected effects.
4888 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004889 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 knows about pasting and will mostly do the right thing without 'paste'
4891 being set. The same is true for a terminal where Vim handles the
4892 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004893 This option is reset when starting the GUI. Thus if you set it in
4894 your .vimrc it will work in a terminal, but not in the GUI. Setting
4895 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4896 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 When the 'paste' option is switched on (also when it was already on):
4898 - mapping in Insert mode and Command-line mode is disabled
4899 - abbreviations are disabled
4900 - 'textwidth' is set to 0
4901 - 'wrapmargin' is set to 0
4902 - 'autoindent' is reset
4903 - 'smartindent' is reset
4904 - 'softtabstop' is set to 0
4905 - 'revins' is reset
4906 - 'ruler' is reset
4907 - 'showmatch' is reset
4908 - 'formatoptions' is used like it is empty
4909 These options keep their value, but their effect is disabled:
4910 - 'lisp'
4911 - 'indentexpr'
4912 - 'cindent'
4913 NOTE: When you start editing another file while the 'paste' option is
4914 on, settings from the modelines or autocommands may change the
4915 settings again, causing trouble when pasting text. You might want to
4916 set the 'paste' option again.
4917 When the 'paste' option is reset the mentioned options are restored to
4918 the value before the moment 'paste' was switched from off to on.
4919 Resetting 'paste' before ever setting it does not have any effect.
4920 Since mapping doesn't work while 'paste' is active, you need to use
4921 the 'pastetoggle' option to toggle the 'paste' option with some key.
4922
4923 *'pastetoggle'* *'pt'*
4924'pastetoggle' 'pt' string (default "")
4925 global
4926 {not in Vi}
4927 When non-empty, specifies the key sequence that toggles the 'paste'
4928 option. This is like specifying a mapping: >
4929 :map {keys} :set invpaste<CR>
4930< Where {keys} is the value of 'pastetoggle'.
4931 The difference is that it will work even when 'paste' is set.
4932 'pastetoggle' works in Insert mode and Normal mode, but not in
4933 Command-line mode.
4934 Mappings are checked first, thus overrule 'pastetoggle'. However,
4935 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4936 this: >
4937 :map <F10> :set paste<CR>
4938 :map <F11> :set nopaste<CR>
4939 :imap <F10> <C-O>:set paste<CR>
4940 :imap <F11> <nop>
4941 :set pastetoggle=<F11>
4942< This will make <F10> start paste mode and <F11> stop paste mode.
4943 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4944 mode everything is inserted literally, except the 'pastetoggle' key
4945 sequence.
4946
4947 *'pex'* *'patchexpr'*
4948'patchexpr' 'pex' string (default "")
4949 global
4950 {not in Vi}
4951 {not available when compiled without the |+diff|
4952 feature}
4953 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004954 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004955
4956 *'patchmode'* *'pm'* *E206*
4957'patchmode' 'pm' string (default "")
4958 global
4959 {not in Vi}
4960 When non-empty the oldest version of a file is kept. This can be used
4961 to keep the original version of a file if you are changing files in a
4962 source distribution. Only the first time that a file is written a
4963 copy of the original file will be kept. The name of the copy is the
4964 name of the original file with the string in the 'patchmode' option
4965 appended. This option should start with a dot. Use a string like
4966 ".org". 'backupdir' must not be empty for this to work (Detail: The
4967 backup file is renamed to the patchmode file after the new file has
4968 been successfully written, that's why it must be possible to write a
4969 backup file). If there was no file to be backed up, an empty file is
4970 created.
4971 When the 'backupskip' pattern matches, a patchmode file is not made.
4972 Using 'patchmode' for compressed files appends the extension at the
4973 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4974 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004975 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004976
4977 *'path'* *'pa'* *E343* *E345* *E347*
4978'path' 'pa' string (default on Unix: ".,/usr/include,,"
4979 on OS/2: ".,/emx/include,,"
4980 other systems: ".,,")
4981 global or local to buffer |global-local|
4982 {not in Vi}
4983 This is a list of directories which will be searched when using the
4984 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4985 being searched for has a relative path (not starting with '/'). The
4986 directories in the 'path' option may be relative or absolute.
4987 - Use commas to separate directory names: >
4988 :set path=.,/usr/local/include,/usr/include
4989< - Spaces can also be used to separate directory names (for backwards
4990 compatibility with version 3.0). To have a space in a directory
4991 name, precede it with an extra backslash, and escape the space: >
4992 :set path=.,/dir/with\\\ space
4993< - To include a comma in a directory name precede it with an extra
4994 backslash: >
4995 :set path=.,/dir/with\\,comma
4996< - To search relative to the directory of the current file, use: >
4997 :set path=.
4998< - To search in the current directory use an empty string between two
4999 commas: >
5000 :set path=,,
5001< - A directory name may end in a ':' or '/'.
5002 - Environment variables are expanded |:set_env|.
5003 - When using |netrw.vim| URLs can be used. For example, adding
5004 "http://www.vim.org" will make ":find index.html" work.
5005 - Search upwards and downwards in a directory tree:
5006 1) "*" matches a sequence of characters, e.g.: >
5007 :set path=/usr/include/*
5008< means all subdirectories in /usr/include (but not /usr/include
5009 itself). >
5010 :set path=/usr/*c
5011< matches /usr/doc and /usr/src.
5012 2) "**" matches a subtree, up to 100 directories deep. Example: >
5013 :set path=/home/user_x/src/**
5014< means search in the whole subtree under "/home/usr_x/src".
5015 3) If the path ends with a ';', this path is the startpoint
5016 for upward search.
5017 See |file-searching| for more info and exact syntax.
5018 {not available when compiled without the |+path_extra| feature}
5019 - Careful with '\' characters, type two to get one in the option: >
5020 :set path=.,c:\\include
5021< Or just use '/' instead: >
5022 :set path=.,c:/include
5023< Don't forget "." or files won't even be found in the same directory as
5024 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005025 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026 it is something like 256 or 1024 characters.
5027 You can check if all the include files are found, using the value of
5028 'path', see |:checkpath|.
5029 The use of |:set+=| and |:set-=| is preferred when adding or removing
5030 directories from the list. This avoids problems when a future version
5031 uses another default. To remove the current directory use: >
5032 :set path-=
5033< To add the current directory use: >
5034 :set path+=
5035< To use an environment variable, you probably need to replace the
5036 separator. Here is an example to append $INCL, in which directory
5037 names are separated with a semi-colon: >
5038 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5039< Replace the ';' with a ':' or whatever separator is used. Note that
5040 this doesn't work when $INCL contains a comma or white space.
5041
5042 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5043'preserveindent' 'pi' boolean (default off)
5044 local to buffer
5045 {not in Vi}
5046 When changing the indent of the current line, preserve as much of the
5047 indent structure as possible. Normally the indent is replaced by a
5048 series of tabs followed by spaces as required (unless |'expandtab'| is
5049 enabled, in which case only spaces are used). Enabling this option
5050 means the indent will preserve as many existing characters as possible
5051 for indenting, and only add additional tabs or spaces as required.
5052 NOTE: When using ">>" multiple times the resulting indent is a mix of
5053 tabs and spaces. You might not like this.
5054 NOTE: 'preserveindent' is reset when 'compatible' is set.
5055 Also see 'copyindent'.
5056 Use |:retab| to clean up white space.
5057
5058 *'previewheight'* *'pvh'*
5059'previewheight' 'pvh' number (default 12)
5060 global
5061 {not in Vi}
5062 {not available when compiled without the |+windows| or
5063 |+quickfix| feature}
5064 Default height for a preview window. Used for |:ptag| and associated
5065 commands. Used for |CTRL-W_}| when no count is given.
5066
5067 *'previewwindow'* *'nopreviewwindow'*
5068 *'pvw'* *'nopvw'* *E590*
5069'previewwindow' 'pvw' boolean (default off)
5070 local to window
5071 {not in Vi}
5072 {not available when compiled without the |+windows| or
5073 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005074 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005075 set. It's normally not set directly, but by using one of the commands
5076 |:ptag|, |:pedit|, etc.
5077
5078 *'printdevice'* *'pdev'*
5079'printdevice' 'pdev' string (default empty)
5080 global
5081 {not in Vi}
5082 {only available when compiled with the |+printer|
5083 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005084 The name of the printer to be used for |:hardcopy|.
5085 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005086 This option cannot be set from a |modeline| or in the |sandbox|, for
5087 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
Bram Moolenaar8299df92004-07-10 09:47:34 +00005089 *'printencoding'* *'penc'*
5090'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 global
5092 {not in Vi}
5093 {only available when compiled with the |+printer|
5094 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005095 Sets the character encoding used when printing.
5096 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005097
5098 *'printexpr'* *'pexpr'*
5099'printexpr' 'pexpr' String (default: see below)
5100 global
5101 {not in Vi}
5102 {only available when compiled with the |+printer|
5103 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005104 Expression used to print the PostScript produced with |:hardcopy|.
5105 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106
Bram Moolenaar8299df92004-07-10 09:47:34 +00005107 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108'printfont' 'pfn' string (default "courier")
5109 global
5110 {not in Vi}
5111 {only available when compiled with the |+printer|
5112 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005113 The name of the font that will be used for |:hardcopy|.
5114 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005115
5116 *'printheader'* *'pheader'*
5117'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5118 global
5119 {not in Vi}
5120 {only available when compiled with the |+printer|
5121 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005122 The format of the header produced in |:hardcopy| output.
5123 See |pheader-option|.
5124
5125 *'printmbcharset'* *'pmbcs'*
5126'printmbcharset' 'pmbcs' string (default "")
5127 global
5128 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005129 {only available when compiled with the |+printer|,
5130 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005131 The CJK character set to be used for CJK output from |:hardcopy|.
5132 See |pmbcs-option|.
5133
5134 *'printmbfont'* *'pmbfn'*
5135'printmbfont' 'pmbfn' string (default "")
5136 global
5137 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005138 {only available when compiled with the |+printer|,
5139 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005140 List of font names to be used for CJK output from |:hardcopy|.
5141 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142
5143 *'printoptions'* *'popt'*
5144'printoptions' 'popt' string (default "")
5145 global
5146 {not in Vi}
5147 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005148 List of items that control the format of the output of |:hardcopy|.
5149 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005151 *'prompt'* *'noprompt'*
5152'prompt' boolean (default on)
5153 global
5154 When on a ":" prompt is used in Ex mode.
5155
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005156 *'pumheight'* *'ph'*
5157'pumheight' 'ph' number (default 0)
5158 global
5159 {not available when compiled without the
5160 |+insert_expand| feature}
5161 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005162 Determines the maximum number of items to show in the popup menu for
5163 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005164 |ins-completion-menu|.
5165
5166
Bram Moolenaar677ee682005-01-27 14:41:15 +00005167 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005168'quoteescape' 'qe' string (default "\")
5169 local to buffer
5170 {not in Vi}
5171 The characters that are used to escape quotes in a string. Used for
5172 objects like a', a" and a` |a'|.
5173 When one of the characters in this option is found inside a string,
5174 the following character will be skipped. The default value makes the
5175 text "foo\"bar\\" considered to be one string.
5176
Bram Moolenaar071d4272004-06-13 20:20:40 +00005177 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5178'readonly' 'ro' boolean (default off)
5179 local to buffer
5180 If on, writes fail unless you use a '!'. Protects you from
5181 accidentally overwriting a file. Default on when Vim is started
5182 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005183 When using ":w!" the 'readonly' option is reset for the current
5184 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005185 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005186 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005187
5188 *'remap'* *'noremap'*
5189'remap' boolean (default on)
5190 global
5191 Allows for mappings to work recursively. If you do not want this for
5192 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005193 NOTE: To avoid portability problems with Vim scripts, always keep
5194 this option at the default "on". Only switch it off when working with
5195 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
5197 *'report'*
5198'report' number (default 2)
5199 global
5200 Threshold for reporting number of lines changed. When the number of
5201 changed lines is more than 'report' a message will be given for most
5202 ":" commands. If you want it always, set 'report' to 0.
5203 For the ":substitute" command the number of substitutions is used
5204 instead of the number of lines.
5205
5206 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5207'restorescreen' 'rs' boolean (default on)
5208 global
5209 {not in Vi} {only in Windows 95/NT console version}
5210 When set, the screen contents is restored when exiting Vim. This also
5211 happens when executing external commands.
5212
5213 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5214 options in your .vimrc. To disable restoring:
5215 set t_ti= t_te=
5216 To enable restoring (for an xterm):
5217 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5218 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5219
5220 *'revins'* *'ri'* *'norevins'* *'nori'*
5221'revins' 'ri' boolean (default off)
5222 global
5223 {not in Vi}
5224 {only available when compiled with the |+rightleft|
5225 feature}
5226 Inserting characters in Insert mode will work backwards. See "typing
5227 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5228 command in Insert mode, when 'allowrevins' is set.
5229 NOTE: This option is reset when 'compatible' or 'paste' is set.
5230
5231 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5232'rightleft' 'rl' boolean (default off)
5233 local to window
5234 {not in Vi}
5235 {only available when compiled with the |+rightleft|
5236 feature}
5237 When on, display orientation becomes right-to-left, i.e., characters
5238 that are stored in the file appear from the right to the left.
5239 Using this option, it is possible to edit files for languages that
5240 are written from the right to the left such as Hebrew and Arabic.
5241 This option is per window, so it is possible to edit mixed files
5242 simultaneously, or to view the same file in both ways (this is
5243 useful whenever you have a mixed text file with both right-to-left
5244 and left-to-right strings so that both sets are displayed properly
5245 in different windows). Also see |rileft.txt|.
5246
5247 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5248'rightleftcmd' 'rlc' string (default "search")
5249 local to window
5250 {not in Vi}
5251 {only available when compiled with the |+rightleft|
5252 feature}
5253 Each word in this option enables the command line editing to work in
5254 right-to-left mode for a group of commands:
5255
5256 search "/" and "?" commands
5257
5258 This is useful for languages such as Hebrew, Arabic and Farsi.
5259 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5260
5261 *'ruler'* *'ru'* *'noruler'* *'noru'*
5262'ruler' 'ru' boolean (default off)
5263 global
5264 {not in Vi}
5265 {not available when compiled without the
5266 |+cmdline_info| feature}
5267 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005268 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005269 text in the file is shown on the far right:
5270 Top first line is visible
5271 Bot last line is visible
5272 All first and last line are visible
5273 45% relative position in the file
5274 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005275 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005277 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005278 this option takes precedence over 'ruler' and 'rulerformat'
5279 If the number of characters displayed is different from the number of
5280 bytes in the text (e.g., for a TAB or a multi-byte character), both
5281 the text column (byte number) and the screen column are shown,
5282 separated with a dash.
5283 For an empty line "0-1" is shown.
5284 For an empty buffer the line number will also be zero: "0,0-1".
5285 This option is reset when the 'paste' option is set.
5286 If you don't want to see the ruler all the time but want to know where
5287 you are, use "g CTRL-G" |g_CTRL-G|.
5288 NOTE: This option is reset when 'compatible' is set.
5289
5290 *'rulerformat'* *'ruf'*
5291'rulerformat' 'ruf' string (default empty)
5292 global
5293 {not in Vi}
5294 {not available when compiled without the |+statusline|
5295 feature}
5296 When this option is not empty, it determines the content of the ruler
5297 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005298 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005299 The default ruler width is 17 characters. To make the ruler 15
5300 characters wide, put "%15(" at the start and "%)" at the end.
5301 Example: >
5302 :set rulerformat=%15(%c%V\ %p%%%)
5303<
5304 *'runtimepath'* *'rtp'* *vimfiles*
5305'runtimepath' 'rtp' string (default:
5306 Unix: "$HOME/.vim,
5307 $VIM/vimfiles,
5308 $VIMRUNTIME,
5309 $VIM/vimfiles/after,
5310 $HOME/.vim/after"
5311 Amiga: "home:vimfiles,
5312 $VIM/vimfiles,
5313 $VIMRUNTIME,
5314 $VIM/vimfiles/after,
5315 home:vimfiles/after"
5316 PC, OS/2: "$HOME/vimfiles,
5317 $VIM/vimfiles,
5318 $VIMRUNTIME,
5319 $VIM/vimfiles/after,
5320 $HOME/vimfiles/after"
5321 Macintosh: "$VIM:vimfiles,
5322 $VIMRUNTIME,
5323 $VIM:vimfiles:after"
5324 RISC-OS: "Choices:vimfiles,
5325 $VIMRUNTIME,
5326 Choices:vimfiles/after"
5327 VMS: "sys$login:vimfiles,
5328 $VIM/vimfiles,
5329 $VIMRUNTIME,
5330 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005331 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005332 global
5333 {not in Vi}
5334 This is a list of directories which will be searched for runtime
5335 files:
5336 filetype.vim filetypes by file name |new-filetype|
5337 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005338 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 colors/ color scheme files |:colorscheme|
5340 compiler/ compiler files |:compiler|
5341 doc/ documentation |write-local-help|
5342 ftplugin/ filetype plugins |write-filetype-plugin|
5343 indent/ indent scripts |indent-expression|
5344 keymap/ key mapping files |mbyte-keymap|
5345 lang/ menu translations |:menutrans|
5346 menu.vim GUI menus |menu.vim|
5347 plugin/ plugin scripts |write-plugin|
5348 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005349 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005350 syntax/ syntax files |mysyntaxfile|
5351 tutor/ files for vimtutor |tutor|
5352
5353 And any other file searched for with the |:runtime| command.
5354
5355 The defaults for most systems are setup to search five locations:
5356 1. In your home directory, for your personal preferences.
5357 2. In a system-wide Vim directory, for preferences from the system
5358 administrator.
5359 3. In $VIMRUNTIME, for files distributed with Vim.
5360 *after-directory*
5361 4. In the "after" directory in the system-wide Vim directory. This is
5362 for the system administrator to overrule or add to the distributed
5363 defaults (rarely needed)
5364 5. In the "after" directory in your home directory. This is for
5365 personal preferences to overrule or add to the distributed defaults
5366 or system-wide settings (rarely needed).
5367
5368 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5369 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005370 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005371 wildcards.
5372 See |:runtime|.
5373 Example: >
5374 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5375< This will use the directory "~/vimruntime" first (containing your
5376 personal Vim runtime files), then "/mygroup/vim" (shared between a
5377 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5378 files).
5379 You probably should always include $VIMRUNTIME somewhere, to use the
5380 distributed runtime files. You can put a directory before $VIMRUNTIME
5381 to find files which replace a distributed runtime files. You can put
5382 a directory after $VIMRUNTIME to find files which add to distributed
5383 runtime files.
5384 This option cannot be set from a |modeline| or in the |sandbox|, for
5385 security reasons.
5386
5387 *'scroll'* *'scr'*
5388'scroll' 'scr' number (default: half the window height)
5389 local to window
5390 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5391 set to half the number of lines in the window when the window size
5392 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005393 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5395 the number of screen lines instead of file lines, makes a difference
5396 when lines wrap}
5397
5398 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5399'scrollbind' 'scb' boolean (default off)
5400 local to window
5401 {not in Vi}
5402 {not available when compiled without the |+scrollbind|
5403 feature}
5404 See also |scroll-binding|. When this option is set, the current
5405 window scrolls as other scrollbind windows (windows that also have
5406 this option set) scroll. This option is useful for viewing the
5407 differences between two versions of a file, see 'diff'.
5408 See |'scrollopt'| for options that determine how this option should be
5409 interpreted.
5410 This option is mostly reset when splitting a window to edit another
5411 file. This means that ":split | edit file" results in two windows
5412 with scroll-binding, but ":split file" does not.
5413
5414 *'scrolljump'* *'sj'*
5415'scrolljump' 'sj' number (default 1)
5416 global
5417 {not in Vi}
5418 Minimal number of lines to scroll when the cursor gets off the
5419 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5420 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005421 When set to a negative number from -1 to -100 this is used as the
5422 percentage of the window height. Thus -50 scrolls half the window
5423 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005424 NOTE: This option is set to 1 when 'compatible' is set.
5425
5426 *'scrolloff'* *'so'*
5427'scrolloff' 'so' number (default 0)
5428 global
5429 {not in Vi}
5430 Minimal number of screen lines to keep above and below the cursor.
5431 This will make some context visible around where you are working. If
5432 you set it to a very large value (999) the cursor line will always be
5433 in the middle of the window (except at the start or end of the file or
5434 when long lines wrap).
5435 For scrolling horizontally see 'sidescrolloff'.
5436 NOTE: This option is set to 0 when 'compatible' is set.
5437
5438 *'scrollopt'* *'sbo'*
5439'scrollopt' 'sbo' string (default "ver,jump")
5440 global
5441 {not available when compiled without the |+scrollbind|
5442 feature}
5443 {not in Vi}
5444 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005445 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5446 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 The following words are available:
5448 ver Bind vertical scrolling for 'scrollbind' windows
5449 hor Bind horizontal scrolling for 'scrollbind' windows
5450 jump Applies to the offset between two windows for vertical
5451 scrolling. This offset is the difference in the first
5452 displayed line of the bound windows. When moving
5453 around in a window, another 'scrollbind' window may
5454 reach a position before the start or after the end of
5455 the buffer. The offset is not changed though, when
5456 moving back the 'scrollbind' window will try to scroll
5457 to the desired position when possible.
5458 When now making that window the current one, two
5459 things can be done with the relative offset:
5460 1. When "jump" is not included, the relative offset is
5461 adjusted for the scroll position in the new current
5462 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005463 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005464 2. When "jump" is included, the other windows are
5465 scrolled to keep the same relative offset. When
5466 going back to the other window, it still uses the
5467 same relative offset.
5468 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005469 When 'diff' mode is active there always is vertical scroll binding,
5470 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005471
5472 *'sections'* *'sect'*
5473'sections' 'sect' string (default "SHNHH HUnhsh")
5474 global
5475 Specifies the nroff macros that separate sections. These are pairs of
5476 two letters (See |object-motions|). The default makes a section start
5477 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5478
5479 *'secure'* *'nosecure'* *E523*
5480'secure' boolean (default off)
5481 global
5482 {not in Vi}
5483 When on, ":autocmd", shell and write commands are not allowed in
5484 ".vimrc" and ".exrc" in the current directory and map commands are
5485 displayed. Switch it off only if you know that you will not run into
5486 problems, or when the 'exrc' option is off. On Unix this option is
5487 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005488 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489 'secure' at the end of your ~/.vimrc then.
5490 This option cannot be set from a |modeline| or in the |sandbox|, for
5491 security reasons.
5492
5493 *'selection'* *'sel'*
5494'selection' 'sel' string (default "inclusive")
5495 global
5496 {not in Vi}
5497 This option defines the behavior of the selection. It is only used
5498 in Visual and Select mode.
5499 Possible values:
5500 value past line inclusive ~
5501 old no yes
5502 inclusive yes yes
5503 exclusive yes no
5504 "past line" means that the cursor is allowed to be positioned one
5505 character past the line.
5506 "inclusive" means that the last character of the selection is included
5507 in an operation. For example, when "x" is used to delete the
5508 selection.
5509 Note that when "exclusive" is used and selecting from the end
5510 backwards, you cannot include the last character of a line, when
5511 starting in Normal mode and 'virtualedit' empty.
5512
5513 The 'selection' option is set by the |:behave| command.
5514
5515 *'selectmode'* *'slm'*
5516'selectmode' 'slm' string (default "")
5517 global
5518 {not in Vi}
5519 This is a comma separated list of words, which specifies when to start
5520 Select mode instead of Visual mode, when a selection is started.
5521 Possible values:
5522 mouse when using the mouse
5523 key when using shifted special keys
5524 cmd when using "v", "V" or CTRL-V
5525 See |Select-mode|.
5526 The 'selectmode' option is set by the |:behave| command.
5527
5528 *'sessionoptions'* *'ssop'*
5529'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005530 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 global
5532 {not in Vi}
5533 {not available when compiled without the +mksession
5534 feature}
5535 Changes the effect of the |:mksession| command. It is a comma
5536 separated list of words. Each word enables saving and restoring
5537 something:
5538 word save and restore ~
5539 blank empty windows
5540 buffers hidden and unloaded buffers, not just those in windows
5541 curdir the current directory
5542 folds manually created folds, opened/closed folds and local
5543 fold options
5544 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005545 and contain at least one lowercase letter. Only
5546 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005547 help the help window
5548 localoptions options and mappings local to a window or buffer (not
5549 global values for local options)
5550 options all options and mappings (also global values for local
5551 options)
5552 resize size of the Vim window: 'lines' and 'columns'
5553 sesdir the directory in which the session file is located
5554 will become the current directory (useful with
5555 projects accessed over a network from different
5556 systems)
5557 slash backslashes in file names replaced with forward
5558 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005559 tabpages all tab pages; without this only the current tab page
5560 is restored, so that you can make a session for each
5561 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005562 unix with Unix end-of-line format (single <NL>), even when
5563 on Windows or DOS
5564 winpos position of the whole Vim window
5565 winsize window sizes
5566
5567 Don't include both "curdir" and "sesdir".
5568 When "curdir" nor "sesdir" is included, file names are stored with
5569 absolute paths.
5570 "slash" and "unix" are useful on Windows when sharing session files
5571 with Unix. The Unix version of Vim cannot source dos format scripts,
5572 but the Windows version of Vim can source unix format scripts.
5573
5574 *'shell'* *'sh'* *E91*
5575'shell' 'sh' string (default $SHELL or "sh",
5576 MS-DOS and Win32: "command.com" or
5577 "cmd.exe", OS/2: "cmd")
5578 global
5579 Name of the shell to use for ! and :! commands. When changing the
5580 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5581 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005582 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 See |option-backslash| about including spaces and backslashes.
5584 Environment variables are expanded |:set_env|.
5585 If the name of the shell contains a space, you might need to enclose
5586 it in quotes. Example: >
5587 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5588< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005589 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590 "-f" is not inside the quotes, because it is not part of the command
5591 name. And Vim automagically recognizes the backslashes that are path
5592 separators.
5593 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5594 variable to change the way external commands are executed. See the
5595 libc.inf file of DJGPP.
5596 Under MS-Windows, when the executable ends in ".com" it must be
5597 included. Thus setting the shell to "command.com" or "4dos.com"
5598 works, but "command" and "4dos" do not work for all commands (e.g.,
5599 filtering).
5600 For unknown reasons, when using "4dos.com" the current directory is
5601 changed to "C:\". To avoid this set 'shell' like this: >
5602 :set shell=command.com\ /c\ 4dos
5603< This option cannot be set from a |modeline| or in the |sandbox|, for
5604 security reasons.
5605
5606 *'shellcmdflag'* *'shcf'*
5607'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5608 does not contain "sh" somewhere: "/c")
5609 global
5610 {not in Vi}
5611 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5612 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5613 systems, the default is set according to the value of 'shell', to
5614 reduce the need to set this option by the user. It's not used for
5615 OS/2 (EMX figures this out itself). See |option-backslash| about
5616 including spaces and backslashes. See |dos-shell|.
5617 This option cannot be set from a |modeline| or in the |sandbox|, for
5618 security reasons.
5619
5620 *'shellpipe'* *'sp'*
5621'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5622 global
5623 {not in Vi}
5624 {not available when compiled without the |+quickfix|
5625 feature}
5626 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005627 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 including spaces and backslashes.
5629 The name of the temporary file can be represented by "%s" if necessary
5630 (the file name is appended automatically if no %s appears in the value
5631 of this option).
5632 For the Amiga and MS-DOS the default is ">". The output is directly
5633 saved in a file and not echoed to the screen.
5634 For Unix the default it "| tee". The stdout of the compiler is saved
5635 in a file and echoed to the screen. If the 'shell' option is "csh" or
5636 "tcsh" after initializations, the default becomes "|& tee". If the
5637 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5638 "2>&1| tee". This means that stderr is also included.
5639 The initialization of this option is done after reading the ".vimrc"
5640 and the other initializations, so that when the 'shell' option is set
5641 there, the 'shellpipe' option changes automatically, unless it was
5642 explicitly set before.
5643 When 'shellpipe' is set to an empty string, no redirection of the
5644 ":make" output will be done. This is useful if you use a 'makeprg'
5645 that writes to 'makeef' by itself. If you want no piping, but do
5646 want to include the 'makeef', set 'shellpipe' to a single space.
5647 Don't forget to precede the space with a backslash: ":set sp=\ ".
5648 In the future pipes may be used for filtering and this option will
5649 become obsolete (at least for Unix).
5650 This option cannot be set from a |modeline| or in the |sandbox|, for
5651 security reasons.
5652
5653 *'shellquote'* *'shq'*
5654'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5655 contains "sh" somewhere: "\"")
5656 global
5657 {not in Vi}
5658 Quoting character(s), put around the command passed to the shell, for
5659 the "!" and ":!" commands. The redirection is kept outside of the
5660 quoting. See 'shellxquote' to include the redirection. It's
5661 probably not useful to set both options.
5662 This is an empty string by default. Only known to be useful for
5663 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5664 or bash, where it should be "\"". The default is adjusted according
5665 the value of 'shell', to reduce the need to set this option by the
5666 user. See |dos-shell|.
5667 This option cannot be set from a |modeline| or in the |sandbox|, for
5668 security reasons.
5669
5670 *'shellredir'* *'srr'*
5671'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5672 global
5673 {not in Vi}
5674 String to be used to put the output of a filter command in a temporary
5675 file. See also |:!|. See |option-backslash| about including spaces
5676 and backslashes.
5677 The name of the temporary file can be represented by "%s" if necessary
5678 (the file name is appended automatically if no %s appears in the value
5679 of this option).
5680 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5681 or "zsh" during initializations, the default becomes ">&". If the
5682 'shell' option is "sh", "ksh" or "bash" the default becomes
5683 ">%s 2>&1". This means that stderr is also included.
5684 For Win32, the Unix checks are done and additionally "cmd" is checked
5685 for, which makes the default ">%s 2>&1". Also, the same names with
5686 ".exe" appended are checked for.
5687 The initialization of this option is done after reading the ".vimrc"
5688 and the other initializations, so that when the 'shell' option is set
5689 there, the 'shellredir' option changes automatically unless it was
5690 explicitly set before.
5691 In the future pipes may be used for filtering and this option will
5692 become obsolete (at least for Unix).
5693 This option cannot be set from a |modeline| or in the |sandbox|, for
5694 security reasons.
5695
5696 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5697'shellslash' 'ssl' boolean (default off)
5698 global
5699 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5700 When set, a forward slash is used when expanding file names. This is
5701 useful when a Unix-like shell is used instead of command.com or
5702 cmd.exe. Backward slashes can still be typed, but they are changed to
5703 forward slashes by Vim.
5704 Note that setting or resetting this option has no effect for some
5705 existing file names, thus this option needs to be set before opening
5706 any file for best results. This might change in the future.
5707 'shellslash' only works when a backslash can be used as a path
5708 separator. To test if this is so use: >
5709 if exists('+shellslash')
5710<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005711 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5712'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5713 global
5714 {not in Vi}
5715 When on, use temp files for shell commands. When off use a pipe.
5716 When using a pipe is not possible temp files are used anyway.
5717 Currently a pipe is only supported on Unix. You can check it with: >
5718 :if has("filterpipe")
5719< The advantage of using a pipe is that nobody can read the temp file
5720 and the 'shell' command does not need to support redirection.
5721 The advantage of using a temp file is that the file type and encoding
5722 can be detected.
5723 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5724 |FilterWritePost| autocommands event are not triggered when
5725 'shelltemp' is off.
5726
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 *'shelltype'* *'st'*
5728'shelltype' 'st' number (default 0)
5729 global
5730 {not in Vi} {only for the Amiga}
5731 On the Amiga this option influences the way how the commands work
5732 which use a shell.
5733 0 and 1: always use the shell
5734 2 and 3: use the shell only to filter lines
5735 4 and 5: use shell only for ':sh' command
5736 When not using the shell, the command is executed directly.
5737
5738 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5739 1 and 3: use "shell cmd" to start external commands
5740
5741 *'shellxquote'* *'sxq'*
5742'shellxquote' 'sxq' string (default: "";
5743 for Win32, when 'shell' contains "sh"
5744 somewhere: "\""
5745 for Unix, when using system(): "\"")
5746 global
5747 {not in Vi}
5748 Quoting character(s), put around the command passed to the shell, for
5749 the "!" and ":!" commands. Includes the redirection. See
5750 'shellquote' to exclude the redirection. It's probably not useful
5751 to set both options.
5752 This is an empty string by default. Known to be useful for
5753 third-party shells when using the Win32 version, such as the MKS Korn
5754 Shell or bash, where it should be "\"". The default is adjusted
5755 according the value of 'shell', to reduce the need to set this option
5756 by the user. See |dos-shell|.
5757 This option cannot be set from a |modeline| or in the |sandbox|, for
5758 security reasons.
5759
5760 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5761'shiftround' 'sr' boolean (default off)
5762 global
5763 {not in Vi}
5764 Round indent to multiple of 'shiftwidth'. Applies to > and <
5765 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5766 a multiple of 'shiftwidth' (this is Vi compatible).
5767 NOTE: This option is reset when 'compatible' is set.
5768
5769 *'shiftwidth'* *'sw'*
5770'shiftwidth' 'sw' number (default 8)
5771 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005772 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005773 |'cindent'|, |>>|, |<<|, etc.
5774
5775 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005776'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5777 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005778 global
5779 {not in Vi}
5780 This option helps to avoid all the |hit-enter| prompts caused by file
5781 messages, for example with CTRL-G, and to avoid some other messages.
5782 It is a list of flags:
5783 flag meaning when present ~
5784 f use "(3 of 5)" instead of "(file 3 of 5)"
5785 i use "[noeol]" instead of "[Incomplete last line]"
5786 l use "999L, 888C" instead of "999 lines, 888 characters"
5787 m use "[+]" instead of "[Modified]"
5788 n use "[New]" instead of "[New File]"
5789 r use "[RO]" instead of "[readonly]"
5790 w use "[w]" instead of "written" for file write message
5791 and "[a]" instead of "appended" for ':w >> file' command
5792 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5793 "[unix format]" and "[mac]" instead of "[mac format]".
5794 a all of the above abbreviations
5795
5796 o overwrite message for writing a file with subsequent message
5797 for reading a file (useful for ":wn" or when 'autowrite' on)
5798 O message for reading a file overwrites any previous message.
5799 Also for quickfix message (e.g., ":cn").
5800 s don't give "search hit BOTTOM, continuing at TOP" or "search
5801 hit TOP, continuing at BOTTOM" messages
5802 t truncate file message at the start if it is too long to fit
5803 on the command-line, "<" will appear in the left most column.
5804 Ignored in Ex mode.
5805 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005806 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005807 Ignored in Ex mode.
5808 W don't give "written" or "[w]" when writing a file
5809 A don't give the "ATTENTION" message when an existing swap file
5810 is found.
5811 I don't give the intro message when starting Vim |:intro|.
5812
5813 This gives you the opportunity to avoid that a change between buffers
5814 requires you to hit <Enter>, but still gives as useful a message as
5815 possible for the space available. To get the whole message that you
5816 would have got with 'shm' empty, use ":file!"
5817 Useful values:
5818 shm= No abbreviation of message.
5819 shm=a Abbreviation, but no loss of information.
5820 shm=at Abbreviation, and truncate message when necessary.
5821
5822 NOTE: This option is set to the Vi default value when 'compatible' is
5823 set and to the Vim default value when 'compatible' is reset.
5824
5825 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5826'shortname' 'sn' boolean (default off)
5827 local to buffer
5828 {not in Vi, not in MS-DOS versions}
5829 Filenames are assumed to be 8 characters plus one extension of 3
5830 characters. Multiple dots in file names are not allowed. When this
5831 option is on, dots in file names are replaced with underscores when
5832 adding an extension (".~" or ".swp"). This option is not available
5833 for MS-DOS, because then it would always be on. This option is useful
5834 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5835 or crossdos. When running the Win32 GUI version under Win32s, this
5836 option is always on by default.
5837
5838 *'showbreak'* *'sbr'* *E595*
5839'showbreak' 'sbr' string (default "")
5840 global
5841 {not in Vi}
5842 {not available when compiled without the |+linebreak|
5843 feature}
5844 String to put at the start of lines that have been wrapped. Useful
5845 values are "> " or "+++ ".
5846 Only printable single-cell characters are allowed, excluding <Tab> and
5847 comma (in a future version the comma might be used to separate the
5848 part that is shown at the end and at the start of a line).
5849 The characters are highlighted according to the '@' flag in
5850 'highlight'.
5851 Note that tabs after the showbreak will be displayed differently.
5852 If you want the 'showbreak' to appear in between line numbers, add the
5853 "n" flag to 'cpoptions'.
5854
5855 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5856'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5857 off)
5858 global
5859 {not in Vi}
5860 {not available when compiled without the
5861 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005862 Show (partial) command in the last line of the screen. Set this
5863 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005864 In Visual mode the size of the selected area is shown:
5865 - When selecting characters within a line, the number of characters.
5866 - When selecting more than one line, the number of lines.
5867 - When selecting a block, the size in screen characters: linesxcolumns.
5868 NOTE: This option is set to the Vi default value when 'compatible' is
5869 set and to the Vim default value when 'compatible' is reset.
5870
5871 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5872'showfulltag' 'sft' boolean (default off)
5873 global
5874 {not in Vi}
5875 When completing a word in insert mode (see |ins-completion|) from the
5876 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005877 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005878 matched a C function, you can see a template for what arguments are
5879 required (coding style permitting).
5880
5881 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5882'showmatch' 'sm' boolean (default off)
5883 global
5884 When a bracket is inserted, briefly jump to the matching one. The
5885 jump is only done if the match can be seen on the screen. The time to
5886 show the match can be set with 'matchtime'.
5887 A Beep is given if there is no match (no matter if the match can be
5888 seen or not). This option is reset when the 'paste' option is set.
5889 When the 'm' flag is not included in 'cpoptions', typing a character
5890 will immediately move the cursor back to where it belongs.
5891 See the "sm" field in 'guicursor' for setting the cursor shape and
5892 blinking when showing the match.
5893 The 'matchpairs' option can be used to specify the characters to show
5894 matches for. 'rightleft' and 'revins' are used to look for opposite
5895 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005896 Also see the matchparen plugin for highlighting the match when moving
5897 around |pi_paren.txt|.
5898 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005899
5900 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5901'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5902 global
5903 If in Insert, Replace or Visual mode put a message on the last line.
5904 Use the 'M' flag in 'highlight' to set the type of highlighting for
5905 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005906 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005907 doesn't mean XIM is really active, especially when 'imactivatekey' is
5908 not set.
5909 NOTE: This option is set to the Vi default value when 'compatible' is
5910 set and to the Vim default value when 'compatible' is reset.
5911
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005912 *'showtabline'* *'stal'*
5913'showtabline' 'stal' number (default 1)
5914 global
5915 {not in Vi}
5916 {not available when compiled without the +windows
5917 feature}
5918 The value of this option specifies when the line with tab page labels
5919 will be displayed:
5920 0: never
5921 1: only if there are at least two tab pages
5922 2: always
5923 This is both for the GUI and non-GUI implementation of the tab pages
5924 line.
5925 See |tab-page| for more information about tab pages.
5926
Bram Moolenaar071d4272004-06-13 20:20:40 +00005927 *'sidescroll'* *'ss'*
5928'sidescroll' 'ss' number (default 0)
5929 global
5930 {not in Vi}
5931 The minimal number of columns to scroll horizontally. Used only when
5932 the 'wrap' option is off and the cursor is moved off of the screen.
5933 When it is zero the cursor will be put in the middle of the screen.
5934 When using a slow terminal set it to a large number or 0. When using
5935 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5936 commands.
5937
5938 *'sidescrolloff'* *'siso'*
5939'sidescrolloff' 'siso' number (default 0)
5940 global
5941 {not in Vi}
5942 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005943 right of the cursor if 'nowrap' is set. Setting this option to a
5944 value greater than 0 while having |'sidescroll'| also at a non-zero
5945 value makes some context visible in the line you are scrolling in
5946 horizontally (except at beginning of the line). Setting this option
5947 to a large value (like 999) has the effect of keeping the cursor
5948 horizontally centered in the window, as long as one does not come too
5949 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005950 NOTE: This option is set to 0 when 'compatible' is set.
5951
5952 Example: Try this together with 'sidescroll' and 'listchars' as
5953 in the following example to never allow the cursor to move
5954 onto the "extends" character:
5955
5956 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5957 :set sidescrolloff=1
5958
5959
5960 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5961'smartcase' 'scs' boolean (default off)
5962 global
5963 {not in Vi}
5964 Override the 'ignorecase' option if the search pattern contains upper
5965 case characters. Only used when the search pattern is typed and
5966 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005967 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005968 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5969 recalling the search pattern from history and hitting <Enter>.
5970 NOTE: This option is reset when 'compatible' is set.
5971
5972 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5973'smartindent' 'si' boolean (default off)
5974 local to buffer
5975 {not in Vi}
5976 {not available when compiled without the
5977 |+smartindent| feature}
5978 Do smart autoindenting when starting a new line. Works for C-like
5979 programs, but can also be used for other languages. 'cindent' does
5980 something like this, works better in most cases, but is more strict,
5981 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5982 'indentexpr' is a more advanced alternative.
5983 Normally 'autoindent' should also be on when using 'smartindent'.
5984 An indent is automatically inserted:
5985 - After a line ending in '{'.
5986 - After a line starting with a keyword from 'cinwords'.
5987 - Before a line starting with '}' (only with the "O" command).
5988 When typing '}' as the first character in a new line, that line is
5989 given the same indent as the matching '{'.
5990 When typing '#' as the first character in a new line, the indent for
5991 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005992 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005993 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5994 When using the ">>" command, lines starting with '#' are not shifted
5995 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005996 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005997 is set smart indenting is disabled.
5998
5999 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6000'smarttab' 'sta' boolean (default off)
6001 global
6002 {not in Vi}
6003 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006004 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6005 <BS> will delete a 'shiftwidth' worth of space at the start of the
6006 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006007 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006008 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6009 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006010 What gets inserted (a Tab or spaces) depends on the 'expandtab'
6011 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006012 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 NOTE: This option is reset when 'compatible' is set.
6014
6015 *'softtabstop'* *'sts'*
6016'softtabstop' 'sts' number (default 0)
6017 local to buffer
6018 {not in Vi}
6019 Number of spaces that a <Tab> counts for while performing editing
6020 operations, like inserting a <Tab> or using <BS>. It "feels" like
6021 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6022 used. This is useful to keep the 'ts' setting at its standard value
6023 of 8, while being able to edit like it is set to 'sts'. However,
6024 commands like "x" still work on the actual characters.
6025 When 'sts' is zero, this feature is off.
6026 'softtabstop' is set to 0 when the 'paste' option is set.
6027 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6028 spaces is minimized by using <Tab>s.
6029 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6030 set.
6031 NOTE: This option is set to 0 when 'compatible' is set.
6032
Bram Moolenaar217ad922005-03-20 22:37:15 +00006033 *'spell'* *'nospell'*
6034'spell' boolean (default off)
6035 local to window
6036 {not in Vi}
6037 {not available when compiled without the |+syntax|
6038 feature}
6039 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006040 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006041
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006042 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006043'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006044 local to buffer
6045 {not in Vi}
6046 {not available when compiled without the |+syntax|
6047 feature}
6048 Pattern to locate the end of a sentence. The following word will be
6049 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006050 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006051 When this check is not wanted make this option empty.
6052 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006053 Be careful with special characters, see |option-backslash| about
6054 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006055 To set this option automatically depending on the language, see
6056 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006057
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006058 *'spellfile'* *'spf'*
6059'spellfile' 'spf' string (default empty)
6060 local to buffer
6061 {not in Vi}
6062 {not available when compiled without the |+syntax|
6063 feature}
6064 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006065 commands. It must end in ".{encoding}.add". You need to include the
6066 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006067 *E765*
6068 It may also be a comma separated list of names. A count before the
6069 |zg| and |zw| commands can be used to access each. This allows using
6070 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006071 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006072 you: Using the first directory in 'runtimepath' that is writable. If
6073 there is no "spell" directory yet it will be created. For the file
6074 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006075 ignoring the region.
6076 The resulting ".spl" file will be used for spell checking, it does not
6077 have to appear in 'spelllang'.
6078 Normally one file is used for all regions, but you can add the region
6079 name if you want to. However, it will then only be used when
6080 'spellfile' is set to it, for entries in 'spelllang' only files
6081 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006082 This option cannot be set from a |modeline| or in the |sandbox|, for
6083 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006084
Bram Moolenaar217ad922005-03-20 22:37:15 +00006085 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006086'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006087 local to buffer
6088 {not in Vi}
6089 {not available when compiled without the |+syntax|
6090 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006091 A comma separated list of word list names. When the 'spell' option is
6092 on spellchecking will be done for these languages. Example: >
6093 set spelllang=en_us,nl,medical
6094< This means US English, Dutch and medical words are recognized. Words
6095 that are not recognized will be highlighted.
6096 The word list name must not include a comma or dot. Using a dash is
6097 recommended to separate the two letter language name from a
6098 specification. Thus "en-rare" is used for rare English words.
6099 A region name must come last and have the form "_xx", where "xx" is
6100 the two-letter, lower case region name. You can use more than one
6101 region by listing them: "en_us,en_ca" supports both US and Canadian
6102 English, but not words specific for Australia, New Zealand or Great
6103 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006104 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006105 As a special case the name of a .spl file can be given as-is. The
6106 first "_xx" in the name is removed and used as the region name
6107 (_xx is an underscore, two letters and followed by a non-letter).
6108 This is mainly for testing purposes. You must make sure the correct
6109 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006110 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006111 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6112 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006113 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006114
Bram Moolenaar98692072006-02-04 00:57:42 +00006115 If the |spellfile.vim| plugin is active and you use a language name
6116 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6117 will ask you if you want to download the file.
6118
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006119 After this option has been set successfully, Vim will source the files
6120 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006121 up to the first comma, dot or underscore.
6122 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006123
6124
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006125 *'spellsuggest'* *'sps'*
6126'spellsuggest' 'sps' string (default "best")
6127 global
6128 {not in Vi}
6129 {not available when compiled without the |+syntax|
6130 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006131 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006132 the |spellsuggest()| function. This is a comma-separated list of
6133 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006134
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006135 best Internal method that works best for English. Finds
6136 changes like "fast" and uses a bit of sound-a-like
6137 scoring to improve the ordering.
6138
6139 double Internal method that uses two methods and mixes the
6140 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006141 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006142 word. That only works when the language specifies
6143 sound folding. Can be slow and doesn't always give
6144 better results.
6145
6146 fast Internal method that only checks for simple changes:
6147 character inserts/deletes/swaps. Works well for
6148 simple typing mistakes.
6149
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006150 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006151 Not used for |spellsuggest()|. The number of
6152 suggestions is never more than the value of 'lines'
6153 minus two.
6154
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006155 file:{filename} Read file {filename}, which must have two columns,
6156 separated by a slash. The first column contains the
6157 bad word, the second column the suggested good word.
6158 Example:
6159 theribal/terrible ~
6160 Use this for common mistakes that do not appear at the
6161 top of the suggestion list with the internal methods.
6162 Lines without a slash are ignored, use this for
6163 comments.
6164 The file is used for all languages.
6165
6166 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6167 trouble with spaces. |v:val| holds the badly spelled
6168 word. The expression must evaluate to a List of
6169 Lists, each with a suggestion and a score.
6170 Example:
6171 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006172 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006173 internal methods use. A lower score is better.
6174 This may invoke |spellsuggest()| if you temporarily
6175 set 'spellsuggest' to exclude the "expr:" part.
6176 Errors are silently ignored, unless you set the
6177 'verbose' option to a non-zero value.
6178
6179 Only one of "best", "double" or "fast" may be used. The others may
6180 appear several times in any order. Example: >
6181 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6182<
6183 This option cannot be set from a |modeline| or in the |sandbox|, for
6184 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006185
6186
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6188'splitbelow' 'sb' boolean (default off)
6189 global
6190 {not in Vi}
6191 {not available when compiled without the +windows
6192 feature}
6193 When on, splitting a window will put the new window below the current
6194 one. |:split|
6195
6196 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6197'splitright' 'spr' boolean (default off)
6198 global
6199 {not in Vi}
6200 {not available when compiled without the +vertsplit
6201 feature}
6202 When on, splitting a window will put the new window right of the
6203 current one. |:vsplit|
6204
6205 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6206'startofline' 'sol' boolean (default on)
6207 global
6208 {not in Vi}
6209 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006210 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006211 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006212 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 with a linewise operator, with "%" with a count and to buffer changing
6214 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6215 only has a line number, e.g., ":25" or ":+".
6216 In case of buffer changing commands the cursor is placed at the column
6217 where it was the last time the buffer was edited.
6218 NOTE: This option is set when 'compatible' is set.
6219
6220 *'statusline'* *'stl'* *E540* *E541* *E542*
6221'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006222 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 {not in Vi}
6224 {not available when compiled without the |+statusline|
6225 feature}
6226 When nonempty, this option determines the content of the status line.
6227 Also see |status-line|.
6228
6229 The option consists of printf style '%' items interspersed with
6230 normal text. Each status line item is of the form:
6231 %-0{minwid}.{maxwid}{item}
6232 All fields except the {item} is optional. A single percent sign can
6233 be given as "%%". Up to 80 items can be specified.
6234
Bram Moolenaar238a5642006-02-21 22:12:05 +00006235 When the option starts with "%!" then it is used as an expression,
6236 evaluated and the result is used as the option value. Example: >
6237 :set statusline=%!MyStatusLine()
6238< The result can contain %{} items that will be evaluated too.
6239
6240 When there is error while evaluating the option then it will be made
6241 empty to avoid further errors. Otherwise screen updating would loop.
6242
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243 Note that the only effect of 'ruler' when this option is set (and
6244 'laststatus' is 2) is controlling the output of |CTRL-G|.
6245
6246 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006247 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006249 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006250 minwid Minimum width of the item, padding as set by '-' & '0'.
6251 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006252 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006253 on the left for text items. Numeric items will be
6254 shifted down to maxwid-2 digits followed by '>'number
6255 where number is the amount of missing digits, much like
6256 an exponential notation.
6257 item A one letter code as described below.
6258
6259 Following is a description of the possible statusline items. The
6260 second character in "item" is the type:
6261 N for number
6262 S for string
6263 F for flags as described below
6264 - not applicable
6265
6266 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006267 f S Path to the file in the buffer, as typed or relative to current
6268 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 F S Full path to the file in the buffer.
6270 t S File name (tail) of file in the buffer.
6271 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6272 M F Modified flag, text is ",+" or ",-".
6273 r F Readonly flag, text is " [RO]".
6274 R F Readonly flag, text is ",RO".
6275 h F Help buffer flag, text is " [help]".
6276 H F Help buffer flag, text is ",HLP".
6277 w F Preview window flag, text is " [Preview]".
6278 W F Preview window flag, text is ",PRV".
6279 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6280 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6281 {not available when compiled without |+autocmd| feature}
6282 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6283 being used: "<keymap>"
6284 n N Buffer number.
6285 b N Value of byte under cursor.
6286 B N As above, in hexadecimal.
6287 o N Byte number in file of byte under cursor, first byte is 1.
6288 Mnemonic: Offset from start of file (with one added)
6289 {not available when compiled without |+byte_offset| feature}
6290 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006291 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006292 l N Line number.
6293 L N Number of lines in buffer.
6294 c N Column number.
6295 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006296 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 p N Percentage through file in lines as in |CTRL-G|.
6298 P S Percentage through file of displayed window. This is like the
6299 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006300 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006302 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006303 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006304 ( - Start of item group. Can be used for setting the width and
6305 alignment of a section. Must be followed by %) somewhere.
6306 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006307 T N For 'tabline': start of tab page N label. Use %T after the last
6308 label. This information is used for mouse clicks.
6309 X N For 'tabline': start of close tab N label. Use %X after the
6310 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6311 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 < - Where to truncate line if too long. Default is at the start.
6313 No width fields allowed.
6314 = - Separation point between left and right aligned items.
6315 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006316 # - Set highlight group. The name must follow and then a # again.
6317 Thus use %#HLname# for highlight group HLname. The same
6318 highlighting is used, also for the statusline of non-current
6319 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006321 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 The difference between User{N} and StatusLine will be applied
6323 to StatusLineNC for the statusline of non-current windows.
6324 The number N must be between 1 and 9. See |hl-User1..9|
6325
6326 Display of flags are controlled by the following heuristic:
6327 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006328 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 with a space it is assumed that it wants to separate itself from
6330 anything but other flags. That is: A leading comma is removed if the
6331 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006332 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 make a nice display when flags are used like in the examples below.
6334
Bram Moolenaar582fd852005-03-28 20:58:01 +00006335 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 not set) and a minwid is not set for the group, the whole group will
6337 become empty. This will make a group like the following disappear
6338 completely from the statusline when none of the flags are set. >
6339 :set statusline=...%(\ [%M%R%H]%)...
6340<
6341 Beware that an expression is evaluated each and every time the status
6342 line is displayed. The current buffer and current window will be set
6343 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006344 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006345 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006346 real current buffer.
6347
6348 The 'statusline' option may be evaluated in the |sandbox|, see
6349 |sandbox-option|.
6350
6351 It is not allowed to change text or jump to another window while
6352 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353
6354 If the statusline is not updated when you want it (e.g., after setting
6355 a variable that's used in an expression), you can force an update by
6356 setting an option without changing its value. Example: >
6357 :let &ro = &ro
6358
6359< A result of all digits is regarded a number for display purposes.
6360 Otherwise the result is taken as flag text and applied to the rules
6361 described above.
6362
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006363 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006364 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6365 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6366
6367 Examples:
6368 Emulate standard status line with 'ruler' set >
6369 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6370< Similar, but add ASCII value of char under the cursor (like "ga") >
6371 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6372< Display byte count and byte value, modified flag in red. >
6373 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6374 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6375< Display a ,GZ flag if a compressed file is loaded >
6376 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6377< In the |:autocmd|'s: >
6378 :let b:gzflag = 1
6379< And: >
6380 :unlet b:gzflag
6381< And define this function: >
6382 :function VarExists(var, val)
6383 : if exists(a:var) | return a:val | else | return '' | endif
6384 :endfunction
6385<
6386 *'suffixes'* *'su'*
6387'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6388 global
6389 {not in Vi}
6390 Files with these suffixes get a lower priority when multiple files
6391 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006392 suffixes. Spaces after the comma are ignored. A dot is also seen as
6393 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006394 separator, precede it with a backslash (see |option-backslash| about
6395 including spaces and backslashes).
6396 See 'wildignore' for completely ignoring files.
6397 The use of |:set+=| and |:set-=| is preferred when adding or removing
6398 suffixes from the list. This avoids problems when a future version
6399 uses another default.
6400
6401 *'suffixesadd'* *'sua'*
6402'suffixesadd' 'sua' string (default "")
6403 local to buffer
6404 {not in Vi}
6405 {not available when compiled without the
6406 |+file_in_path| feature}
6407 Comma separated list of suffixes, which are used when searching for a
6408 file for the "gf", "[I", etc. commands. Example: >
6409 :set suffixesadd=.java
6410<
6411 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6412'swapfile' 'swf' boolean (default on)
6413 local to buffer
6414 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006415 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 swapfile is not wanted for a specific buffer. For example, with
6417 confidential information that even root must not be able to access.
6418 Careful: All text will be in memory:
6419 - Don't use this for big files.
6420 - Recovery will be impossible!
6421 A swapfile will only be present when |'updatecount'| is non-zero and
6422 'swapfile' is set.
6423 When 'swapfile' is reset, the swap file for the current buffer is
6424 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6425 non-zero, a swap file is immediately created.
6426 Also see |swap-file| and |'swapsync'|.
6427
6428 This option is used together with 'bufhidden' and 'buftype' to
6429 specify special kinds of buffers. See |special-buffers|.
6430
6431 *'swapsync'* *'sws'*
6432'swapsync' 'sws' string (default "fsync")
6433 global
6434 {not in Vi}
6435 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006436 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 When this option is empty parts of the swap file may be in memory and
6438 not written to disk. When the system crashes you may lose more work.
6439 On Unix the system does a sync now and then without Vim asking for it,
6440 so the disadvantage of setting this option off is small. On some
6441 systems the swap file will not be written at all. For a unix system
6442 setting it to "sync" will use the sync() call instead of the default
6443 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006444 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445
6446 *'switchbuf'* *'swb'*
6447'switchbuf' 'swb' string (default "")
6448 global
6449 {not in Vi}
6450 This option controls the behavior when switching between buffers.
6451 Possible values (comma separated list):
6452 useopen If included, jump to the first open window that
6453 contains the specified buffer (if there is one).
6454 Otherwise: Do not examine other windows.
6455 This setting is checked with |quickfix| commands, when
6456 jumping to errors (":cc", ":cn", "cp", etc.). It is
6457 also used in all buffer related split commands, for
6458 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006459 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006460 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006462 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006463 Supported in |quickfix| commands that display errors.
6464
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006465 *'synmaxcol'* *'smc'*
6466'synmaxcol' 'smc' number (default 3000)
6467 local to buffer
6468 {not in Vi}
6469 {not available when compiled without the |+syntax|
6470 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006471 Maximum column in which to search for syntax items. In long lines the
6472 text after this column is not highlighted and following lines may not
6473 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006474 This helps to avoid very slow redrawing for an XML file that is one
6475 long line.
6476 Set to zero to remove the limit.
6477
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 *'syntax'* *'syn'*
6479'syntax' 'syn' string (default empty)
6480 local to buffer
6481 {not in Vi}
6482 {not available when compiled without the |+syntax|
6483 feature}
6484 When this option is set, the syntax with this name is loaded, unless
6485 syntax highlighting has been switched off with ":syntax off".
6486 Otherwise this option does not always reflect the current syntax (the
6487 b:current_syntax variable does).
6488 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006489 not automatically recognized. Example, in an IDL file:
6490 /* vim: set syntax=idl : */ ~
6491 When a dot appears in the value then this separates two filetype
6492 names. Example:
6493 /* vim: set syntax=c.doxygen : */ ~
6494 This will use the "c" syntax first, then the "doxygen" syntax.
6495 Note that the second one must be prepared to be loaded as an addition,
6496 otherwise it will be skipped. More than one dot may appear.
6497 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 :set syntax=OFF
6499< To switch syntax highlighting on according to the current value of the
6500 'filetype' option: >
6501 :set syntax=ON
6502< What actually happens when setting the 'syntax' option is that the
6503 Syntax autocommand event is triggered with the value as argument.
6504 This option is not copied to another buffer, independent of the 's' or
6505 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006506 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006507
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006508 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006509'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006510 global
6511 {not in Vi}
6512 {not available when compiled without the +windows
6513 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006514 When nonempty, this option determines the content of the tab pages
6515 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006516 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006517
6518 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006519 option and only when there is no GUI tab line. When 'e' is in
6520 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6521 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006522
6523 The value is evaluated like with 'statusline'. You can use
6524 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006525 the text to be displayed. Use "%1T" for the first label, "%2T" for
6526 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006527
6528 Keep in mind that only one of the tab pages is the current one, others
6529 are invisible and you can't jump to their windows.
6530
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006531
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006532 *'tabpagemax'* *'tpm'*
6533'tabpagemax' 'tpm' number (default 10)
6534 global
6535 {not in Vi}
6536 {not available when compiled without the +windows
6537 feature}
6538 Maximum number of tab pages to be opened by the |-p| command line
6539 argument or the ":tab all" command. |tabpage|
6540
6541
6542 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006543'tabstop' 'ts' number (default 8)
6544 local to buffer
6545 Number of spaces that a <Tab> in the file counts for. Also see
6546 |:retab| command, and 'softtabstop' option.
6547
6548 Note: Setting 'tabstop' to any other value than 8 can make your file
6549 appear wrong in many places (e.g., when printing it).
6550
6551 There are four main ways to use tabs in Vim:
6552 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6553 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6554 will use a mix of tabs and spaces, but typing Tab and BS will
6555 behave like a tab appears every 4 (or 3) characters.
6556 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6557 'expandtab'. This way you will always insert spaces. The
6558 formatting will never be messed up when 'tabstop' is changed.
6559 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006560 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 works when using Vim to edit the file.
6562 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6563 'noexpandtab'. This should then work (for initial indents only)
6564 for any tabstop setting that people use. It might be nice to have
6565 tabs after the first non-blank inserted as spaces if you do this
6566 though. Otherwise aligned comments will be wrong when 'tabstop' is
6567 changed.
6568
6569 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6570'tagbsearch' 'tbs' boolean (default on)
6571 global
6572 {not in Vi}
6573 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006574 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 searching makes searching for a tag a LOT faster, but a linear search
6576 will find more tags if the tags file wasn't properly sorted.
6577 Vim normally assumes that your tags files are sorted, or indicate that
6578 they are not sorted. Only when this is not the case does the
6579 'tagbsearch' option need to be switched off.
6580
6581 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006582 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 certain files, or retry all files with a linear search. When
6584 'tagbsearch' is off, only a linear search is done.
6585
6586 Linear searching is done anyway, for one file, when Vim finds a line
6587 at the start of the file indicating that it's not sorted: >
6588 !_TAG_FILE_SORTED 0 /some command/
6589< [The whitespace before and after the '0' must be a single <Tab>]
6590
6591 When a binary search was done and no match was found in any of the
6592 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6593 instead of a normal tag name, a retry is done with a linear search.
6594 Tags in unsorted tags files, and matches with different case will only
6595 be found in the retry.
6596
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006597 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598 linear search can be avoided for the 'ignorecase' case. Use a value
6599 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6600 case-fold sorted with the -f switch to "sort" in most unices, as in
6601 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6602 5.3 or higher the -f or --fold-case-sort switch can be used for this
6603 as well. Note that case must be folded to uppercase for this to work.
6604
6605 When 'tagbsearch' is off, tags searching is slower when a full match
6606 exists, but faster when no full match exists. Tags in unsorted tags
6607 files may only be found with 'tagbsearch' off.
6608 When the tags file is not sorted, or sorted in a wrong way (not on
6609 ASCII byte value), 'tagbsearch' should be off, or the line given above
6610 must be included in the tags file.
6611 This option doesn't affect commands that find all matching tags (e.g.,
6612 command-line completion and ":help").
6613 {Vi: always uses binary search in some versions}
6614
6615 *'taglength'* *'tl'*
6616'taglength' 'tl' number (default 0)
6617 global
6618 If non-zero, tags are significant up to this number of characters.
6619
6620 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6621'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6622 global
6623 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006624 If on and using a tags file in another directory, file names in that
6625 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 NOTE: This option is set to the Vi default value when 'compatible' is
6627 set and to the Vim default value when 'compatible' is reset.
6628
6629 *'tags'* *'tag'* *E433*
6630'tags' 'tag' string (default "./tags,tags", when compiled with
6631 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6632 global or local to buffer |global-local|
6633 Filenames for the tag command, separated by spaces or commas. To
6634 include a space or comma in a file name, precede it with a backslash
6635 (see |option-backslash| about including spaces and backslashes).
6636 When a file name starts with "./", the '.' is replaced with the path
6637 of the current file. But only when the 'd' flag is not included in
6638 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6639 |tags-option|.
6640 "*", "**" and other wildcards can be used to search for tags files in
6641 a directory tree. See |file-searching|. {not available when compiled
6642 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006643 The |tagfiles()| function can be used to get a list of the file names
6644 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6646 files are also supported. They are automatically recognized. The
6647 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6648 differences are ignored (MS-Windows). |emacs-tags|
6649 The use of |:set+=| and |:set-=| is preferred when adding or removing
6650 file names from the list. This avoids problems when a future version
6651 uses another default.
6652 {Vi: default is "tags /usr/lib/tags"}
6653
6654 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6655'tagstack' 'tgst' boolean (default on)
6656 global
6657 {not in all versions of Vi}
6658 When on, the |tagstack| is used normally. When off, a ":tag" or
6659 ":tselect" command with an argument will not push the tag onto the
6660 tagstack. A following ":tag" without an argument, a ":pop" command or
6661 any other command that uses the tagstack will use the unmodified
6662 tagstack, but does change the pointer to the active entry.
6663 Resetting this option is useful when using a ":tag" command in a
6664 mapping which should not change the tagstack.
6665
6666 *'term'* *E529* *E530* *E531*
6667'term' string (default is $TERM, if that fails:
6668 in the GUI: "builtin_gui"
6669 on Amiga: "amiga"
6670 on BeOS: "beos-ansi"
6671 on Mac: "mac-ansi"
6672 on MiNT: "vt52"
6673 on MS-DOS: "pcterm"
6674 on OS/2: "os2ansi"
6675 on Unix: "ansi"
6676 on VMS: "ansi"
6677 on Win 32: "win32")
6678 global
6679 Name of the terminal. Used for choosing the terminal control
6680 characters. Environment variables are expanded |:set_env|.
6681 For example: >
6682 :set term=$TERM
6683< See |termcap|.
6684
6685 *'termbidi'* *'tbidi'*
6686 *'notermbidi'* *'notbidi'*
6687'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6688 global
6689 {not in Vi}
6690 {only available when compiled with the |+arabic|
6691 feature}
6692 The terminal is in charge of Bi-directionality of text (as specified
6693 by Unicode). The terminal is also expected to do the required shaping
6694 that some languages (such as Arabic) require.
6695 Setting this option implies that 'rightleft' will not be set when
6696 'arabic' is set and the value of 'arabicshape' will be ignored.
6697 Note that setting 'termbidi' has the immediate effect that
6698 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6699 This option is reset when the GUI is started.
6700 For further details see |arabic.txt|.
6701
6702 *'termencoding'* *'tenc'*
6703'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6704 Macintosh GUI: "macroman")
6705 global
6706 {only available when compiled with the |+multi_byte|
6707 feature}
6708 {not in Vi}
6709 Encoding used for the terminal. This specifies what character
6710 encoding the keyboard produces and the display will understand. For
6711 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006712 display). Except for the Mac when 'macatsui' is off, then
6713 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 In the Win32 console version the default value is the console codepage
6715 when it differs from the ANSI codepage.
6716 *E617*
6717 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6718 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6719 Any attempts to set a different value will be rejected, and an error
6720 message is shown.
6721 For the Win32 GUI 'termencoding' is not used for typed characters,
6722 because the Win32 system always passes Unicode characters.
6723 When empty, the same encoding is used as for the 'encoding' option.
6724 This is the normal value.
6725 Not all combinations for 'termencoding' and 'encoding' are valid. See
6726 |encoding-table|.
6727 The value for this option must be supported by internal conversions or
6728 iconv(). When this is not possible no conversion will be done and you
6729 will probably experience problems with non-ASCII characters.
6730 Example: You are working with the locale set to euc-jp (Japanese) and
6731 want to edit a UTF-8 file: >
6732 :let &termencoding = &encoding
6733 :set encoding=utf-8
6734< You need to do this when your system has no locale support for UTF-8.
6735
6736 *'terse'* *'noterse'*
6737'terse' boolean (default off)
6738 global
6739 When set: Add 's' flag to 'shortmess' option (this makes the message
6740 for a search that hits the start or end of the file not being
6741 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6742 shortens a lot of messages}
6743
6744 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6745'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6746 global
6747 {not in Vi}
6748 This option is obsolete. Use 'fileformats'.
6749 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6750 set to the default value for the current system. When 'textauto' is
6751 reset, 'fileformats' is made empty.
6752 NOTE: This option is set to the Vi default value when 'compatible' is
6753 set and to the Vim default value when 'compatible' is reset.
6754
6755 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6756'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6757 others: default off)
6758 local to buffer
6759 {not in Vi}
6760 This option is obsolete. Use 'fileformat'.
6761 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6762 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6763 "unix".
6764
6765 *'textwidth'* *'tw'*
6766'textwidth' 'tw' number (default 0)
6767 local to buffer
6768 {not in Vi}
6769 Maximum width of text that is being inserted. A longer line will be
6770 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006771 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6772 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006774 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006775 NOTE: This option is set to 0 when 'compatible' is set.
6776
6777 *'thesaurus'* *'tsr'*
6778'thesaurus' 'tsr' string (default "")
6779 global or local to buffer |global-local|
6780 {not in Vi}
6781 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006782 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 the file should contain words with similar meaning, separated by
6784 non-keyword characters (white space is preferred). Maximum line
6785 length is 510 bytes.
6786 To obtain a file to be used here, check out the wordlist FAQ at
6787 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 after a comma are ignored, otherwise spaces are included in the file
6790 name. See |option-backslash| about using backslashes.
6791 The use of |:set+=| and |:set-=| is preferred when adding or removing
6792 directories from the list. This avoids problems when a future version
6793 uses another default.
6794 Backticks cannot be used in this option for security reasons.
6795
6796 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6797'tildeop' 'top' boolean (default off)
6798 global
6799 {not in Vi}
6800 When on: The tilde command "~" behaves like an operator.
6801 NOTE: This option is reset when 'compatible' is set.
6802
6803 *'timeout'* *'to'* *'notimeout'* *'noto'*
6804'timeout' 'to' boolean (default on)
6805 global
6806 *'ttimeout'* *'nottimeout'*
6807'ttimeout' boolean (default off)
6808 global
6809 {not in Vi}
6810 These two options together determine the behavior when part of a
6811 mapped key sequence or keyboard code has been received:
6812
6813 'timeout' 'ttimeout' action ~
6814 off off do not time out
6815 on on or off time out on :mappings and key codes
6816 off on time out on key codes
6817
6818 If both options are off, Vim will wait until either the complete
6819 mapping or key sequence has been received, or it is clear that there
6820 is no mapping or key sequence for the received characters. For
6821 example: if you have mapped "vl" and Vim has received 'v', the next
6822 character is needed to see if the 'v' is followed by an 'l'.
6823 When one of the options is on, Vim will wait for about 1 second for
6824 the next character to arrive. After that the already received
6825 characters are interpreted as single characters. The waiting time can
6826 be changed with the 'timeoutlen' option.
6827 On slow terminals or very busy systems timing out may cause
6828 malfunctioning cursor keys. If both options are off, Vim waits
6829 forever after an entered <Esc> if there are key codes that start
6830 with <Esc>. You will have to type <Esc> twice. If you do not have
6831 problems with key codes, but would like to have :mapped key
6832 sequences not timing out in 1 second, set the 'ttimeout' option and
6833 reset the 'timeout' option.
6834
6835 NOTE: 'ttimeout' is reset when 'compatible' is set.
6836
6837 *'timeoutlen'* *'tm'*
6838'timeoutlen' 'tm' number (default 1000)
6839 global
6840 {not in all versions of Vi}
6841 *'ttimeoutlen'* *'ttm'*
6842'ttimeoutlen' 'ttm' number (default -1)
6843 global
6844 {not in Vi}
6845 The time in milliseconds that is waited for a key code or mapped key
6846 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6847 when part of a command has been typed.
6848 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6849 different timeout value for key codes is desired set 'ttimeoutlen' to
6850 a non-negative number.
6851
6852 ttimeoutlen mapping delay key code delay ~
6853 < 0 'timeoutlen' 'timeoutlen'
6854 >= 0 'timeoutlen' 'ttimeoutlen'
6855
6856 The timeout only happens when the 'timeout' and 'ttimeout' options
6857 tell so. A useful setting would be >
6858 :set timeout timeoutlen=3000 ttimeoutlen=100
6859< (time out on mapping after three seconds, time out on key codes after
6860 a tenth of a second).
6861
6862 *'title'* *'notitle'*
6863'title' boolean (default off, on when title can be restored)
6864 global
6865 {not in Vi}
6866 {not available when compiled without the |+title|
6867 feature}
6868 When on, the title of the window will be set to the value of
6869 'titlestring' (if it is not empty), or to:
6870 filename [+=-] (path) - VIM
6871 Where:
6872 filename the name of the file being edited
6873 - indicates the file cannot be modified, 'ma' off
6874 + indicates the file was modified
6875 = indicates the file is read-only
6876 =+ indicates the file is read-only and modified
6877 (path) is the path of the file being edited
6878 - VIM the server name |v:servername| or "VIM"
6879 Only works if the terminal supports setting window titles
6880 (currently Amiga console, Win32 console, all GUI versions and
6881 terminals with a non- empty 't_ts' option - these are Unix xterm and
6882 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6883 *X11*
6884 When Vim was compiled with HAVE_X11 defined, the original title will
6885 be restored if possible. The output of ":version" will include "+X11"
6886 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6887 works for the icon name |'icon'|.
6888 But: When Vim was started with the |-X| argument, restoring the title
6889 will not work (except in the GUI).
6890 If the title cannot be restored, it is set to the value of 'titleold'.
6891 You might want to restore the title outside of Vim then.
6892 When using an xterm from a remote machine you can use this command:
6893 rsh machine_name xterm -display $DISPLAY &
6894 then the WINDOWID environment variable should be inherited and the
6895 title of the window should change back to what it should be after
6896 exiting Vim.
6897
6898 *'titlelen'*
6899'titlelen' number (default 85)
6900 global
6901 {not in Vi}
6902 {not available when compiled without the |+title|
6903 feature}
6904 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006905 title. When the title is longer, only the end of the path name is
6906 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 Using a percentage makes this adapt to the width of the window. But
6908 it won't work perfectly, because the actual number of characters
6909 available also depends on the font used and other things in the title
6910 bar. When 'titlelen' is zero the full path is used. Otherwise,
6911 values from 1 to 30000 percent can be used.
6912 'titlelen' is also used for the 'titlestring' option.
6913
6914 *'titleold'*
6915'titleold' string (default "Thanks for flying Vim")
6916 global
6917 {not in Vi}
6918 {only available when compiled with the |+title|
6919 feature}
6920 This option will be used for the window title when exiting Vim if the
6921 original title cannot be restored. Only happens if 'title' is on or
6922 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006923 This option cannot be set from a |modeline| or in the |sandbox|, for
6924 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 *'titlestring'*
6926'titlestring' string (default "")
6927 global
6928 {not in Vi}
6929 {not available when compiled without the |+title|
6930 feature}
6931 When this option is not empty, it will be used for the title of the
6932 window. This happens only when the 'title' option is on.
6933 Only works if the terminal supports setting window titles (currently
6934 Amiga console, Win32 console, all GUI versions and terminals with a
6935 non-empty 't_ts' option).
6936 When Vim was compiled with HAVE_X11 defined, the original title will
6937 be restored if possible |X11|.
6938 When this option contains printf-style '%' items, they will be
6939 expanded according to the rules used for 'statusline'.
6940 Example: >
6941 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6942 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6943< The value of 'titlelen' is used to align items in the middle or right
6944 of the available space.
6945 Some people prefer to have the file name first: >
6946 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6947< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006948 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006949 separating space only when needed.
6950 NOTE: Use of special characters in 'titlestring' may cause the display
6951 to be garbled (e.g., when it contains a CR or NL character).
6952 {not available when compiled without the |+statusline| feature}
6953
6954 *'toolbar'* *'tb'*
6955'toolbar' 'tb' string (default "icons,tooltips")
6956 global
6957 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6958 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006959 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006960 possible values are:
6961 icons Toolbar buttons are shown with icons.
6962 text Toolbar buttons shown with text.
6963 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006964 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006965 tooltips Tooltips are active for toolbar buttons.
6966 Tooltips refer to the popup help text which appears after the mouse
6967 cursor is placed over a toolbar button for a brief moment.
6968
6969 If you want the toolbar to be shown with icons as well as text, do the
6970 following: >
6971 :set tb=icons,text
6972< Motif and Athena cannot display icons and text at the same time. They
6973 will show icons if both are requested.
6974
6975 If none of the strings specified in 'toolbar' are valid or if
6976 'toolbar' is empty, this option is ignored. If you want to disable
6977 the toolbar, you need to set the 'guioptions' option. For example: >
6978 :set guioptions-=T
6979< Also see |gui-toolbar|.
6980
6981 *'toolbariconsize'* *'tbis'*
6982'toolbariconsize' 'tbis' string (default "small")
6983 global
6984 {not in Vi}
6985 {only in the GTK+ 2 GUI}
6986 Controls the size of toolbar icons. The possible values are:
6987 tiny Use tiny toolbar icons.
6988 small Use small toolbar icons (default).
6989 medium Use medium-sized toolbar icons.
6990 large Use large toolbar icons.
6991 The exact dimensions in pixels of the various icon sizes depend on
6992 the current theme. Common dimensions are large=32x32, medium=24x24,
6993 small=20x20 and tiny=16x16.
6994
6995 If 'toolbariconsize' is empty, the global default size as determined
6996 by user preferences or the current theme is used.
6997
6998 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6999'ttybuiltin' 'tbi' boolean (default on)
7000 global
7001 {not in Vi}
7002 When on, the builtin termcaps are searched before the external ones.
7003 When off the builtin termcaps are searched after the external ones.
7004 When this option is changed, you should set the 'term' option next for
7005 the change to take effect, for example: >
7006 :set notbi term=$TERM
7007< See also |termcap|.
7008 Rationale: The default for this option is "on", because the builtin
7009 termcap entries are generally better (many systems contain faulty
7010 xterm entries...).
7011
7012 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7013'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7014 sun-cmd, screen, rxvt, dtterm or
7015 iris-ansi; also on when running Vim in
7016 a DOS console)
7017 global
7018 {not in Vi}
7019 Indicates a fast terminal connection. More characters will be sent to
7020 the screen for redrawing, instead of using insert/delete line
7021 commands. Improves smoothness of redrawing when there are multiple
7022 windows and the terminal does not support a scrolling region.
7023 Also enables the extra writing of characters at the end of each screen
7024 line for lines that wrap. This helps when using copy/paste with the
7025 mouse in an xterm and other terminals.
7026
7027 *'ttymouse'* *'ttym'*
7028'ttymouse' 'ttym' string (default depends on 'term')
7029 global
7030 {not in Vi}
7031 {only in Unix and VMS, doesn't work in the GUI; not
7032 available when compiled without |+mouse|}
7033 Name of the terminal type for which mouse codes are to be recognized.
7034 Currently these three strings are valid:
7035 *xterm-mouse*
7036 xterm xterm-like mouse handling. The mouse generates
7037 "<Esc>[Mscr", where "scr" is three bytes:
7038 "s" = button state
7039 "c" = column plus 33
7040 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007041 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007042 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 xterm2 Works like "xterm", but with the xterm reporting the
7044 mouse position while the mouse is dragged. This works
7045 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007046 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007047 work. See below for how Vim detects this
7048 automatically.
7049 *netterm-mouse*
7050 netterm NetTerm mouse handling. The mouse generates
7051 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7052 for the row and column.
7053 *dec-mouse*
7054 dec DEC terminal mouse handling. The mouse generates a
7055 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007056 This is also available for an Xterm, if it was
7057 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007058 *jsbterm-mouse*
7059 jsbterm JSB term mouse handling.
7060 *pterm-mouse*
7061 pterm QNX pterm mouse handling.
7062
7063 The mouse handling must be enabled at compile time |+mouse_xterm|
7064 |+mouse_dec| |+mouse_netterm|.
7065 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7066 recognized, if enabled at compile time. DEC terminal mouse codes
7067 are recognized if enabled at compile time, and 'ttymouse' is not
7068 "xterm" (because the xterm and dec mouse codes conflict).
7069 This option is automatically set to "xterm", when the 'term' option is
7070 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7071 or "xterm2" already. The main use of this option is to set it to
7072 "xterm", when the terminal name doesn't start with "xterm", but it can
7073 handle xterm mouse codes.
7074 The "xterm2" value will be set if the xterm version is reported to be
7075 95 of higher. This only works when compiled with the |+termresponse|
7076 feature and if |t_RV| is set to the escape sequence to request the
7077 xterm version number. Otherwise "xterm2" must be set explicitly.
7078 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7079 t_RV to an empty string: >
7080 :set t_RV=
7081<
7082 *'ttyscroll'* *'tsl'*
7083'ttyscroll' 'tsl' number (default 999)
7084 global
7085 Maximum number of lines to scroll the screen. If there are more lines
7086 to scroll the window is redrawn. For terminals where scrolling is
7087 very slow and redrawing is not slow this can be set to a small number,
7088 e.g., 3, to speed up displaying.
7089
7090 *'ttytype'* *'tty'*
7091'ttytype' 'tty' string (default from $TERM)
7092 global
7093 Alias for 'term', see above.
7094
7095 *'undolevels'* *'ul'*
7096'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7097 Win32 and OS/2)
7098 global
7099 {not in Vi}
7100 Maximum number of changes that can be undone. Since undo information
7101 is kept in memory, higher numbers will cause more memory to be used
7102 (nevertheless, a single change can use an unlimited amount of memory).
7103 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7104 itself: >
7105 set ul=0
7106< But you can also get Vi compatibility by including the 'u' flag in
7107 'cpoptions', and still be able to use CTRL-R to repeat undo.
7108 Set to a negative number for no undo at all: >
7109 set ul=-1
7110< This helps when you run out of memory for a single change.
7111 Also see |undo-two-ways|.
7112
7113 *'updatecount'* *'uc'*
7114'updatecount' 'uc' number (default: 200)
7115 global
7116 {not in Vi}
7117 After typing this many characters the swap file will be written to
7118 disk. When zero, no swap file will be created at all (see chapter on
7119 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7120 Vim with the "-n" option, see |startup|. When editing in readonly
7121 mode this option will be initialized to 10000.
7122 The swapfile can be disabled per buffer with |'swapfile'|.
7123 When 'updatecount' is set from zero to non-zero, swap files are
7124 created for all buffers that have 'swapfile' set. When 'updatecount'
7125 is set to zero, existing swap files are not deleted.
7126 Also see |'swapsync'|.
7127 This option has no meaning in buffers where |'buftype'| is "nofile"
7128 or "nowrite".
7129
7130 *'updatetime'* *'ut'*
7131'updatetime' 'ut' number (default 4000)
7132 global
7133 {not in Vi}
7134 If this many milliseconds nothing is typed the swap file will be
7135 written to disk (see |crash-recovery|). Also used for the
7136 |CursorHold| autocommand event.
7137
7138 *'verbose'* *'vbs'*
7139'verbose' 'vbs' number (default 0)
7140 global
7141 {not in Vi, although some versions have a boolean
7142 verbose option}
7143 When bigger than zero, Vim will give messages about what it is doing.
7144 Currently, these messages are given:
7145 >= 1 When the viminfo file is read or written.
7146 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007147 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 >= 8 Files for which a group of autocommands is executed.
7149 >= 9 Every executed autocommand.
7150 >= 12 Every executed function.
7151 >= 13 When an exception is thrown, caught, finished, or discarded.
7152 >= 14 Anything pending in a ":finally" clause.
7153 >= 15 Every executed Ex command (truncated at 200 characters).
7154
7155 This option can also be set with the "-V" argument. See |-V|.
7156 This option is also set by the |:verbose| command.
7157
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007158 When the 'verbosefile' option is set then the verbose messages are not
7159 displayed.
7160
7161 *'verbosefile'* *'vfile'*
7162'verbosefile' 'vfile' string (default empty)
7163 global
7164 {not in Vi}
7165 When not empty all messages are written in a file with this name.
7166 When the file exists messages are appended.
7167 Writing to the file ends when Vim exits or when 'verbosefile' is made
7168 empty.
7169 Setting 'verbosefile' to a new value is like making it empty first.
7170 The difference with |:redir| is that verbose messages are not
7171 displayed when 'verbosefile' is set.
7172
Bram Moolenaar071d4272004-06-13 20:20:40 +00007173 *'viewdir'* *'vdir'*
7174'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7175 "$VIM/vimfiles/view",
7176 for Unix: "~/.vim/view",
7177 for Macintosh: "$VIM:vimfiles:view"
7178 for VMS: "sys$login:vimfiles/view"
7179 for RiscOS: "Choices:vimfiles/view")
7180 global
7181 {not in Vi}
7182 {not available when compiled without the +mksession
7183 feature}
7184 Name of the directory where to store files for |:mkview|.
7185 This option cannot be set from a |modeline| or in the |sandbox|, for
7186 security reasons.
7187
7188 *'viewoptions'* *'vop'*
7189'viewoptions' 'vop' string (default: "folds,options,cursor")
7190 global
7191 {not in Vi}
7192 {not available when compiled without the +mksession
7193 feature}
7194 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007195 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 word save and restore ~
7197 cursor cursor position in file and in window
7198 folds manually created folds, opened/closed folds and local
7199 fold options
7200 options options and mappings local to a window or buffer (not
7201 global values for local options)
7202 slash backslashes in file names replaced with forward
7203 slashes
7204 unix with Unix end-of-line format (single <NL>), even when
7205 on Windows or DOS
7206
7207 "slash" and "unix" are useful on Windows when sharing view files
7208 with Unix. The Unix version of Vim cannot source dos format scripts,
7209 but the Windows version of Vim can source unix format scripts.
7210
7211 *'viminfo'* *'vi'* *E526* *E527* *E528*
7212'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7213 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7214 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7215 for others: '20,<50,s10,h)
7216 global
7217 {not in Vi}
7218 {not available when compiled without the |+viminfo|
7219 feature}
7220 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007221 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 separated list of parameters, each consisting of a single character
7223 identifying the particular parameter, followed by a number or string
7224 which specifies the value of that parameter. If a particular
7225 character is left out, then the default value is used for that
7226 parameter. The following is a list of the identifying characters and
7227 the effect of their value.
7228 CHAR VALUE ~
7229 ! When included, save and restore global variables that start
7230 with an uppercase letter, and don't contain a lowercase
7231 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007232 and "_K_L_M" are not. Only String and Number types are
7233 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 " Maximum number of lines saved for each register. Old name of
7235 the '<' item, with the disadvantage that you need to put a
7236 backslash before the ", otherwise it will be recognized as the
7237 start of a comment!
7238 % When included, save and restore the buffer list. If Vim is
7239 started with a file name argument, the buffer list is not
7240 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007241 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 without a file name and buffers for help files are not written
7243 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007244 When followed by a number, the number specifies the maximum
7245 number of buffers that are stored. Without a number all
7246 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 ' Maximum number of previously edited files for which the marks
7248 are remembered. This parameter must always be included when
7249 'viminfo' is non-empty.
7250 Including this item also means that the |jumplist| and the
7251 |changelist| are stored in the viminfo file.
7252 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007253 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 patterns are also saved. When not included, the value of
7255 'history' is used.
7256 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007257 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007258 < Maximum number of lines saved for each register. If zero then
7259 registers are not saved. When not included, all lines are
7260 saved. '"' is the old name for this item.
7261 Also see the 's' item below: limit specified in Kbyte.
7262 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007263 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007264 c When included, convert the text in the viminfo file from the
7265 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007266 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 f Whether file marks need to be stored. If zero, file marks ('0
7268 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007269 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270 cursor position (when exiting or when doing ":wviminfo").
7271 h Disable the effect of 'hlsearch' when loading the viminfo
7272 file. When not included, it depends on whether ":nohlsearch"
7273 has been used since the last search command.
7274 n Name of the viminfo file. The name must immediately follow
7275 the 'n'. Must be the last one! If the "-i" argument was
7276 given when starting Vim, that file name overrides the one
7277 given here with 'viminfo'. Environment variables are expanded
7278 when opening the file, not when setting the option.
7279 r Removable media. The argument is a string (up to the next
7280 ','). This parameter can be given several times. Each
7281 specifies the start of a path for which no marks will be
7282 stored. This is to avoid removable media. For MS-DOS you
7283 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7284 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7285 ignored. Maximum length of each 'r' argument is 50
7286 characters.
7287 s Maximum size of an item in Kbyte. If zero then registers are
7288 not saved. Currently only applies to registers. The default
7289 "s10" will exclude registers with more than 10 Kbyte of text.
7290 Also see the '<' item above: line count limit.
7291
7292 Example: >
7293 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7294<
7295 '50 Marks will be remembered for the last 50 files you
7296 edited.
7297 <1000 Contents of registers (up to 1000 lines each) will be
7298 remembered.
7299 s100 Registers with more than 100 Kbyte text are skipped.
7300 :0 Command-line history will not be saved.
7301 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7302 no / Since '/' is not specified, the default will be used,
7303 that is, save all of the search history, and also the
7304 previous search and substitute patterns.
7305 no % The buffer list will not be saved nor read back.
7306 no h 'hlsearch' highlighting will be restored.
7307
7308 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7309 load the contents of the file, this is not done automatically.
7310
7311 This option cannot be set from a |modeline| or in the |sandbox|, for
7312 security reasons.
7313
7314 *'virtualedit'* *'ve'*
7315'virtualedit' 've' string (default "")
7316 global
7317 {not in Vi}
7318 {not available when compiled without the
7319 |+virtualedit| feature}
7320 A comma separated list of these words:
7321 block Allow virtual editing in Visual block mode.
7322 insert Allow virtual editing in Insert mode.
7323 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007324 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007325
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 Virtual editing means that the cursor can be positioned where there is
7327 no actual character. This can be halfway into a Tab or beyond the end
7328 of the line. Useful for selecting a rectangle in Visual mode and
7329 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007330 "onemore" is not the same, it will only allow moving the cursor just
7331 after the last character of the line. This makes some commands more
7332 consistent. Previously the cursor was always past the end of the line
7333 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007334 break some plugins or Vim scripts. For example because |l| can move
7335 the cursor after the last character. Use with care!
7336 Using the |$| command will move to the last character in the line, not
7337 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007338 It doesn't make sense to combine "all" with "onemore", but you will
7339 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340
7341 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7342'visualbell' 'vb' boolean (default off)
7343 global
7344 {not in Vi}
7345 Use visual bell instead of beeping. The terminal code to display the
7346 visual bell is given with 't_vb'. When no beep or flash is wanted,
7347 use ":set vb t_vb=".
7348 Note: When the GUI starts, 't_vb' is reset to its default value. You
7349 might want to set it again in your |gvimrc|.
7350 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7351 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7352 where 40 is the time in msec.
7353 Does not work on the Amiga, you always get a screen flash.
7354 Also see 'errorbells'.
7355
7356 *'warn'* *'nowarn'*
7357'warn' boolean (default on)
7358 global
7359 Give a warning message when a shell command is used while the buffer
7360 has been changed.
7361
7362 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7363'weirdinvert' 'wiv' boolean (default off)
7364 global
7365 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007366 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007367 It is provided for backwards compatibility with version 4.x.
7368 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7369 vice versa. Has no effect when the GUI is running.
7370
7371 *'whichwrap'* *'ww'*
7372'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7373 global
7374 {not in Vi}
7375 Allow specified keys that move the cursor left/right to move to the
7376 previous/next line when the cursor is on the first/last character in
7377 the line. Concatenate characters to allow this for these keys:
7378 char key mode ~
7379 b <BS> Normal and Visual
7380 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007381 h "h" Normal and Visual (not recommended)
7382 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007383 < <Left> Normal and Visual
7384 > <Right> Normal and Visual
7385 ~ "~" Normal
7386 [ <Left> Insert and Replace
7387 ] <Right> Insert and Replace
7388 For example: >
7389 :set ww=<,>,[,]
7390< allows wrap only when cursor keys are used.
7391 When the movement keys are used in combination with a delete or change
7392 operator, the <EOL> also counts for a character. This makes "3h"
7393 different from "3dh" when the cursor crosses the end of a line. This
7394 is also true for "x" and "X", because they do the same as "dl" and
7395 "dh". If you use this, you may also want to use the mapping
7396 ":map <BS> X" to make backspace delete the character in front of the
7397 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007398 When 'l' is included and it is used after an operator at the end of a
7399 line then it will not move to the next line. This makes "dl", "cl",
7400 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 NOTE: This option is set to the Vi default value when 'compatible' is
7402 set and to the Vim default value when 'compatible' is reset.
7403
7404 *'wildchar'* *'wc'*
7405'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7406 global
7407 {not in Vi}
7408 Character you have to type to start wildcard expansion in the
7409 command-line, as specified with 'wildmode'.
7410 The character is not recognized when used inside a macro. See
7411 'wildcharm' for that.
7412 Although 'wc' is a number option, you can set it to a special key: >
7413 :set wc=<Esc>
7414< NOTE: This option is set to the Vi default value when 'compatible' is
7415 set and to the Vim default value when 'compatible' is reset.
7416
7417 *'wildcharm'* *'wcm'*
7418'wildcharm' 'wcm' number (default: none (0))
7419 global
7420 {not in Vi}
7421 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007422 recognized when used inside a macro. You can find "spare" command-line
7423 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007424 you'll never actually type 'wildcharm', just use it in mappings that
7425 automatically invoke completion mode, e.g.: >
7426 :set wcm=<C-Z>
7427 :cmap ss so $vim/sessions/*.vim<C-Z>
7428< Then after typing :ss you can use CTRL-P & CTRL-N.
7429
7430 *'wildignore'* *'wig'*
7431'wildignore' 'wig' string (default "")
7432 global
7433 {not in Vi}
7434 {not available when compiled without the |+wildignore|
7435 feature}
7436 A list of file patterns. A file that matches with one of these
7437 patterns is ignored when completing file or directory names.
7438 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7439 Also see 'suffixes'.
7440 Example: >
7441 :set wildignore=*.o,*.obj
7442< The use of |:set+=| and |:set-=| is preferred when adding or removing
7443 a pattern from the list. This avoids problems when a future version
7444 uses another default.
7445
7446 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7447'wildmenu' 'wmnu' boolean (default off)
7448 global
7449 {not in Vi}
7450 {not available if compiled without the |+wildmenu|
7451 feature}
7452 When 'wildmenu' is on, command-line completion operates in an enhanced
7453 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7454 the possible matches are shown just above the command line, with the
7455 first match highlighted (overwriting the status line, if there is
7456 one). Keys that show the previous/next match, such as <Tab> or
7457 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7458 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7459 specified. "longest" and "list" do not start "wildmenu" mode.
7460 If there are more matches than can fit in the line, a ">" is shown on
7461 the right and/or a "<" is shown on the left. The status line scrolls
7462 as needed.
7463 The "wildmenu" mode is abandoned when a key is hit that is not used
7464 for selecting a completion.
7465 While the "wildmenu" is active the following keys have special
7466 meanings:
7467
7468 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7469 <Down> - in filename/menu name completion: move into a
7470 subdirectory or submenu.
7471 <CR> - in menu completion, when the cursor is just after a
7472 dot: move into a submenu.
7473 <Up> - in filename/menu name completion: move up into
7474 parent directory or parent menu.
7475
7476 This makes the menus accessible from the console |console-menus|.
7477
7478 If you prefer the <Left> and <Right> keys to move the cursor instead
7479 of selecting a different match, use this: >
7480 :cnoremap <Left> <Space><BS><Left>
7481 :cnoremap <Right> <Space><BS><Right>
7482<
7483 The "WildMenu" highlighting is used for displaying the current match
7484 |hl-WildMenu|.
7485
7486 *'wildmode'* *'wim'*
7487'wildmode' 'wim' string (Vim default: "full")
7488 global
7489 {not in Vi}
7490 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007491 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007492 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493 first part specifies the behavior for the first use of 'wildchar',
7494 The second part for the second use, etc.
7495 These are the possible values for each part:
7496 "" Complete only the first match.
7497 "full" Complete the next full match. After the last match,
7498 the original string is used and then the first match
7499 again.
7500 "longest" Complete till longest common string. If this doesn't
7501 result in a longer string, use the next part.
7502 "longest:full" Like "longest", but also start 'wildmenu' if it is
7503 enabled.
7504 "list" When more than one match, list all matches.
7505 "list:full" When more than one match, list all matches and
7506 complete first match.
7507 "list:longest" When more than one match, list all matches and
7508 complete till longest common string.
7509 When there is only a single match, it is fully completed in all cases.
7510
7511 Examples: >
7512 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007513< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514 :set wildmode=longest,full
7515< Complete longest common string, then each full match >
7516 :set wildmode=list:full
7517< List all matches and complete each full match >
7518 :set wildmode=list,full
7519< List all matches without completing, then each full match >
7520 :set wildmode=longest,list
7521< Complete longest common string, then list alternatives.
7522
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007523 *'wildoptions'* *'wop'*
7524'wildoptions' 'wop' string (default "")
7525 global
7526 {not in Vi}
7527 {not available when compiled without the |+wildignore|
7528 feature}
7529 A list of words that change how command line completion is done.
7530 Currently only one word is allowed:
7531 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007532 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007533 is displayed per line. Often used tag kinds are:
7534 d #define
7535 f function
7536 Also see |cmdline-completion|.
7537
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 *'winaltkeys'* *'wak'*
7539'winaltkeys' 'wak' string (default "menu")
7540 global
7541 {not in Vi}
7542 {only used in Win32, Motif, GTK and Photon GUI}
7543 Some GUI versions allow the access to menu entries by using the ALT
7544 key in combination with a character that appears underlined in the
7545 menu. This conflicts with the use of the ALT key for mappings and
7546 entering special characters. This option tells what to do:
7547 no Don't use ALT keys for menus. ALT key combinations can be
7548 mapped, but there is no automatic handling. This can then be
7549 done with the |:simalt| command.
7550 yes ALT key handling is done by the windowing system. ALT key
7551 combinations cannot be mapped.
7552 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007553 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007554 keys can be mapped.
7555 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7556 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007557 This option is not used for <F10>; on Win32 and with GTK <F10> will
7558 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007560 *'window'* *'wi'*
7561'window' 'wi' number (default screen height - 1)
7562 global
7563 Window height. Do not confuse this with the height of the Vim window,
7564 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007565 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7566 value is smaller than 'lines' minus one. The screen will scroll
7567 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007568 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7569 in a much smarter way, taking care of wrapping lines.
7570 When resizing the Vim window, the value is smaller than 1 or more than
7571 or equal to 'lines' it will be set to 'lines' minus 1.
7572 {Vi also uses the option to specify the number of displayed lines}
7573
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 *'winheight'* *'wh'* *E591*
7575'winheight' 'wh' number (default 1)
7576 global
7577 {not in Vi}
7578 {not available when compiled without the +windows
7579 feature}
7580 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007581 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 current window is smaller, its size is increased, at the cost of the
7583 height of other windows. Set it to 999 to make the current window
7584 always fill the screen (although this has the drawback that ":all"
7585 will create only two windows). Set it to a small number for normal
7586 editing.
7587 Minimum value is 1.
7588 The height is not adjusted after one of the commands to change the
7589 height of the current window.
7590 'winheight' applies to the current window. Use 'winminheight' to set
7591 the minimal height for other windows.
7592
7593 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7594'winfixheight' 'wfh' boolean (default off)
7595 local to window
7596 {not in Vi}
7597 {not available when compiled without the +windows
7598 feature}
7599 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007600 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7601 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 The height may be changed anyway when running out of room.
7603
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007604 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7605'winfixwidth' 'wfw' boolean (default off)
7606 local to window
7607 {not in Vi}
7608 {not available when compiled without the +windows
7609 feature}
7610 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007611 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007612 The width may be changed anyway when running out of room.
7613
Bram Moolenaar071d4272004-06-13 20:20:40 +00007614 *'winminheight'* *'wmh'*
7615'winminheight' 'wmh' number (default 1)
7616 global
7617 {not in Vi}
7618 {not available when compiled without the +windows
7619 feature}
7620 The minimal height of a window, when it's not the current window.
7621 This is a hard minimum, windows will never become smaller.
7622 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7623 status bar) if necessary. They will return to at least one line when
7624 they become active (since the cursor has to have somewhere to go.)
7625 Use 'winheight' to set the minimal height of the current window.
7626 This option is only checked when making a window smaller. Don't use a
7627 large number, it will cause errors when opening more than a few
7628 windows. A value of 0 to 3 is reasonable.
7629
7630 *'winminwidth'* *'wmw'*
7631'winminwidth' 'wmw' number (default 1)
7632 global
7633 {not in Vi}
7634 {not available when compiled without the +vertsplit
7635 feature}
7636 The minimal width of a window, when it's not the current window.
7637 This is a hard minimum, windows will never become smaller.
7638 When set to zero, windows may be "squashed" to zero columns (i.e. just
7639 a vertical separator) if necessary. They will return to at least one
7640 line when they become active (since the cursor has to have somewhere
7641 to go.)
7642 Use 'winwidth' to set the minimal width of the current window.
7643 This option is only checked when making a window smaller. Don't use a
7644 large number, it will cause errors when opening more than a few
7645 windows. A value of 0 to 12 is reasonable.
7646
7647 *'winwidth'* *'wiw'* *E592*
7648'winwidth' 'wiw' number (default 20)
7649 global
7650 {not in Vi}
7651 {not available when compiled without the +vertsplit
7652 feature}
7653 Minimal number of columns for the current window. This is not a hard
7654 minimum, Vim will use fewer columns if there is not enough room. If
7655 the current window is smaller, its size is increased, at the cost of
7656 the width of other windows. Set it to 999 to make the current window
7657 always fill the screen. Set it to a small number for normal editing.
7658 The width is not adjusted after one of the commands to change the
7659 width of the current window.
7660 'winwidth' applies to the current window. Use 'winminwidth' to set
7661 the minimal width for other windows.
7662
7663 *'wrap'* *'nowrap'*
7664'wrap' boolean (default on)
7665 local to window
7666 {not in Vi}
7667 This option changes how text is displayed. It doesn't change the text
7668 in the buffer, see 'textwidth' for that.
7669 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007670 displaying continues on the next line. When off lines will not wrap
7671 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007672 moved to a part that is not shown, the screen will scroll
7673 horizontally.
7674 The line will be broken in the middle of a word if necessary. See
7675 'linebreak' to get the break at a word boundary.
7676 To make scrolling horizontally a bit more useful, try this: >
7677 :set sidescroll=5
7678 :set listchars+=precedes:<,extends:>
7679< See 'sidescroll', 'listchars' and |wrap-off|.
7680
7681 *'wrapmargin'* *'wm'*
7682'wrapmargin' 'wm' number (default 0)
7683 local to buffer
7684 Number of characters from the right window border where wrapping
7685 starts. When typing text beyond this limit, an <EOL> will be inserted
7686 and inserting continues on the next line.
7687 Options that add a margin, such as 'number' and 'foldcolumn', cause
7688 the text width to be further reduced. This is Vi compatible.
7689 When 'textwidth' is non-zero, this option is not used.
7690 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7691 and less usefully}
7692
7693 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7694'wrapscan' 'ws' boolean (default on) *E384* *E385*
7695 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007696 Searches wrap around the end of the file. Also applies to |]s| and
7697 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698
7699 *'write'* *'nowrite'*
7700'write' boolean (default on)
7701 global
7702 {not in Vi}
7703 Allows writing files. When not set, writing a file is not allowed.
7704 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007705 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007706 argument. Filtering text is still possible, even though this requires
7707 writing a temporary file.
7708
7709 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7710'writeany' 'wa' boolean (default off)
7711 global
7712 Allows writing to any file with no need for "!" override.
7713
7714 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7715'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7716 otherwise)
7717 global
7718 {not in Vi}
7719 Make a backup before overwriting a file. The backup is removed after
7720 the file was successfully written, unless the 'backup' option is
7721 also on. Reset this option if your file system is almost full. See
7722 |backup-table| for another explanation.
7723 When the 'backupskip' pattern matches, a backup is not made anyway.
7724 NOTE: This option is set to the default value when 'compatible' is
7725 set.
7726
7727 *'writedelay'* *'wd'*
7728'writedelay' 'wd' number (default 0)
7729 global
7730 {not in Vi}
7731 The number of microseconds to wait for each character sent to the
7732 screen. When non-zero, characters are sent to the terminal one by
7733 one. For MS-DOS pcterm this does not work. For debugging purposes.
7734
7735 vim:tw=78:ts=8:ft=help:norl: