blob: 2ff749b4ac86b199d1aa6c837f5d1b2d1c1d47d3 [file] [log] [blame]
Bram Moolenaar8243a792007-05-01 17:05:03 +00001*options.txt* For Vim version 7.0. Last change: 2007 May 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
13For an overview of options see help.txt |option-list|.
14
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
43:se[t] {option}! or
44:se[t] inv{option} Toggle option: Invert value. {not in Vi}
45
46 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
47:se[t] {option}& Reset option to its default value. May depend on the
48 current value of 'compatible'. {not in Vi}
49:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
50:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
51
52:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000053 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000054 'columns' are not changed. {not in Vi}
55
56 *:set-args* *E487* *E521*
57:se[t] {option}={value} or
58:se[t] {option}:{value}
59 Set string or number option to {value}.
60 For numeric options the value can be given in decimal,
61 hex (preceded with 0x) or octal (preceded with '0')
62 (hex and octal are only available for machines which
63 have the strtol() function).
64 The old value can be inserted by typing 'wildchar' (by
65 default this is a <Tab> or CTRL-E if 'compatible' is
66 set). See |cmdline-completion|.
67 White space between {option} and '=' is allowed and
68 will be ignored. White space between '=' and {value}
69 is not allowed.
70 See |option-backslash| for using white space and
71 backslashes in {value}.
72
73:se[t] {option}+={value} *:set+=*
74 Add the {value} to a number option, or append the
75 {value} to a string option. When the option is a
76 comma separated list, a comma is added, unless the
77 value was empty.
78 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000079 are removed. When adding a flag that was already
80 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000081 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000082 {not in Vi}
83
84:se[t] {option}^={value} *:set^=*
85 Multiply the {value} to a number option, or prepend
86 the {value} to a string option. When the option is a
87 comma separated list, a comma is added, unless the
88 value was empty.
89 Also see |:set-args| above.
90 {not in Vi}
91
92:se[t] {option}-={value} *:set-=*
93 Subtract the {value} from a number option, or remove
94 the {value} from a string option, if it is there.
95 If the {value} is not found in a string option, there
96 is no error or warning. When the option is a comma
97 separated list, a comma is deleted, unless the option
98 becomes empty.
99 When the option is a list of flags, {value} must be
100 exactly as they appear in the option. Remove flags
101 one by one to avoid problems.
102 Also see |:set-args| above.
103 {not in Vi}
104
105The {option} arguments to ":set" may be repeated. For example: >
106 :set ai nosi sw=3 ts=3
107If you make an error in one of the arguments, an error message will be given
108and the following arguments will be ignored.
109
110 *:set-verbose*
111When 'verbose' is non-zero, displaying an option value will also tell where it
112was last set. Example: >
113 :verbose set shiftwidth cindent?
114 shiftwidth=4
115 Last set from modeline
116 cindent
117 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim
118This is only done when specific option values are requested, not for ":set
119all" or ":set" without an argument.
120When the option was set by hand there is no "Last set" message. There is only
121one value for all local options with the same name. Thus the message applies
122to the option name, not necessarily its value.
123When the option was set while executing a function, user command or
124autocommand, the script in which it was defined is reported.
125Note that an option may also have been set as a side effect of setting
126'compatible'.
127{not available when compiled without the +eval feature}
128
129 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000130For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000131override the value from the termcap. You can then use it in a mapping. If
132the "xx" part contains special characters, use the <t_xx> form: >
133 :set <t_#4>=^[Ot
134This can also be used to translate a special code for a normal key. For
135example, if Alt-b produces <Esc>b, use this: >
136 :set <M-b>=^[b
137(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
138The advantage over a mapping is that it works in all situations.
139
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000140The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
141security reasons.
142
Bram Moolenaar071d4272004-06-13 20:20:40 +0000143The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000144at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145"set all" probably does not fit on the screen, causing Vim to give the
146|more-prompt|.
147
148 *option-backslash*
149To include white space in a string option value it has to be preceded with a
150backslash. To include a backslash you have to use two. Effectively this
151means that the number of backslashes in an option value is halved (rounded
152down).
153A few examples: >
154 :set tags=tags\ /usr/tags results in "tags /usr/tags"
155 :set tags=tags\\,file results in "tags\,file"
156 :set tags=tags\\\ file results in "tags\ file"
157
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000158The "|" character separates a ":set" command from a following command. To
159include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000160'titlestring' option to "hi|there": >
161 :set titlestring=hi\|there
162This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
163 :set titlestring=hi|set iconstring=there
164
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000165Similarly, the double quote character starts a comment. To include the '"' in
166the option value, use '\"' instead. This example sets the 'titlestring'
167option to 'hi "there"': >
168 :set titlestring=hi\ \"there\"
169
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000170For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000171precise: For options that expect a file name (those where environment
172variables are expanded) a backslash before a normal file name character is not
173removed. But a backslash before a special character (space, backslash, comma,
174etc.) is used like explained above.
175There is one special situation, when the value starts with "\\": >
176 :set dir=\\machine\path results in "\\machine\path"
177 :set dir=\\\\machine\\path results in "\\machine\path"
178 :set dir=\\path\\file results in "\\path\file" (wrong!)
179For the first one the start is kept, but for the second one the backslashes
180are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000181halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000182result which is probably not what you want. Avoid it.
183
184 *add-option-flags* *remove-option-flags*
185 *E539* *E550* *E551* *E552*
186Some options are a list of flags. When you want to add a flag to such an
187option, without changing the existing ones, you can do it like this: >
188 :set guioptions+=a
189Remove a flag from an option like this: >
190 :set guioptions-=a
191This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000192Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000193the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
194doesn't appear.
195
196 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000197Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000198environment variable exists the '$' and the following environment variable
199name is replaced with its value. If it does not exist the '$' and the name
200are not modified. Any non-id character (not a letter, digit or '_') may
201follow the environment variable name. That character and what follows is
202appended to the value of the environment variable. Examples: >
203 :set term=$TERM.new
204 :set path=/usr/$INCLUDE,$HOME/include,.
205When adding or removing a string from an option with ":set opt-=val" or ":set
206opt+=val" the expansion is done before the adding or removing.
207
208
209Handling of local options *local-options*
210
211Some of the options only apply to a window or buffer. Each window or buffer
212has its own copy of this option, thus can each have their own value. This
213allows you to set 'list' in one window but not in another. And set
214'shiftwidth' to 3 in one buffer and 4 in another.
215
216The following explains what happens to these local options in specific
217situations. You don't really need to know all of this, since Vim mostly uses
218the option values you would expect. Unfortunately, doing what the user
219expects is a bit complicated...
220
221When splitting a window, the local options are copied to the new window. Thus
222right after the split the contents of the two windows look the same.
223
224When editing a new buffer, its local option values must be initialized. Since
225the local options of the current buffer might be specifically for that buffer,
226these are not used. Instead, for each buffer-local option there also is a
227global value, which is used for new buffers. With ":set" both the local and
228global value is changed. With "setlocal" only the local value is changed,
229thus this value is not used when editing a new buffer.
230
231When editing a buffer that has been edited before, the last used window
232options are used again. If this buffer has been edited in this window, the
233values from back then are used. Otherwise the values from the window where
234the buffer was edited last are used.
235
236It's possible to set a local window option specifically for a type of buffer.
237When you edit another buffer in the same window, you don't want to keep
238using these local window options. Therefore Vim keeps a global value of the
239local window options, which is used when editing another buffer. Each window
240has its own copy of these values. Thus these are local to the window, but
241global to all buffers in the window. With this you can do: >
242 :e one
243 :set list
244 :e two
245Now the 'list' option will also be set in "two", since with the ":set list"
246command you have also set the global value. >
247 :set nolist
248 :e one
249 :setlocal list
250 :e two
251Now the 'list' option is not set, because ":set nolist" resets the global
252value, ":setlocal list" only changes the local value and ":e two" gets the
253global value. Note that if you do this next: >
254 :e one
255You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000256"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000257
258 *:setl* *:setlocal*
259:setl[ocal] ... Like ":set" but set only the value local to the
260 current buffer or window. Not all options have a
261 local value. If the option does not have a local
262 value the global value is set.
263 With the "all" argument: display all local option's
264 local values.
265 Without argument: Display all local option's local
266 values which are different from the default.
267 When displaying a specific local option, show the
268 local value. For a global option the global value is
269 shown (but that might change in the future).
270 {not in Vi}
271
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000272:setl[ocal] {option}< Set the local value of {option} to its global value by
273 copying the value.
274 {not in Vi}
275
276:se[t] {option}< Set the local value of {option} to its global value by
277 making it empty. Only makes sense for |global-local|
278 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000279 {not in Vi}
280
281 *:setg* *:setglobal*
282:setg[lobal] ... Like ":set" but set only the global value for a local
283 option without changing the local value.
284 When displaying an option, the global value is shown.
285 With the "all" argument: display all local option's
286 global values.
287 Without argument: display all local option's global
288 values which are different from the default.
289 {not in Vi}
290
291For buffer-local and window-local options:
292 Command global value local value ~
293 :set option=value set set
294 :setlocal option=value - set
295:setglobal option=value set -
296 :set option? - display
297 :setlocal option? - display
298:setglobal option? display -
299
300
301Global options with a local value *global-local*
302
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000303Options are global when you mostly use one value for all buffers and windows.
304For some global options it's useful to sometimes have a different local value.
305You can set the local value with ":setlocal". That buffer or window will then
306use the local value, while other buffers and windows continue using the global
307value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000308
309For example, you have two windows, both on C source code. They use the global
310'makeprg' option. If you do this in one of the two windows: >
311 :set makeprg=gmake
312then the other window will switch to the same value. There is no need to set
313the 'makeprg' option in the other C source window too.
314However, if you start editing a Perl file in a new window, you want to use
315another 'makeprog' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000316files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000317 :setlocal makeprg=perlmake
318You can switch back to using the global value by making the local value empty: >
319 :setlocal makeprg=
320This only works for a string option. For a boolean option you need to use the
321"<" flag, like this: >
322 :setlocal autoread<
323Note that for non-boolean options using "<" copies the global value to the
324local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000325when the global value changes later). You can also use: >
326 :set path<
327This will make the local value of 'path' empty, so that the global value is
328used. Thus it does the same as: >
329 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000330Note: In the future more global options can be made global-local. Using
331":setlocal" on a global option might work differently then.
332
333
334Setting the filetype
335
336:setf[iletype] {filetype} *:setf* *:setfiletype*
337 Set the 'filetype' option to {filetype}, but only if
338 not done yet in a sequence of (nested) autocommands.
339 This is short for: >
340 :if !did_filetype()
341 : setlocal filetype={filetype}
342 :endif
343< This command is used in a filetype.vim file to avoid
344 setting the 'filetype' option twice, causing different
345 settings and syntax files to be loaded.
346 {not in Vi}
347
348:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
349:opt[ions] Open a window for viewing and setting all options.
350 Options are grouped by function.
351 Offers short help for each option. Hit <CR> on the
352 short help to open a help window with more help for
353 the option.
354 Modify the value of the option and hit <CR> on the
355 "set" line to set the new value. For window and
356 buffer specific options, the last accessed window is
357 used to set the option value in, unless this is a help
358 window, in which case the window below help window is
359 used (skipping the option-window).
360 {not available when compiled without the |+eval| or
361 |+autocmd| features}
362
363 *$HOME*
364Using "~" is like using "$HOME", but it is only recognized at the start of an
365option and after a space or comma.
366
367On Unix systems "~user" can be used too. It is replaced by the home directory
368of user "user". Example: >
369 :set path=~mool/include,/usr/include,.
370
371On Unix systems the form "${HOME}" can be used too. The name between {} can
372contain non-id characters then. Note that if you want to use this for the
373"gf" command, you need to add the '{' and '}' characters to 'isfname'.
374
375NOTE: expanding environment variables and "~/" is only done with the ":set"
376command, not when assigning a value to an option with ":let".
377
378
379Note the maximum length of an expanded option is limited. How much depends on
380the system, mostly it is something like 256 or 1024 characters.
381
382 *:fix* *:fixdel*
383:fix[del] Set the value of 't_kD':
384 't_kb' is 't_kD' becomes ~
385 CTRL-? CTRL-H
386 not CTRL-? CTRL-?
387
388 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
389
390 If your delete key terminal code is wrong, but the
391 code for backspace is alright, you can put this in
392 your .vimrc: >
393 :fixdel
394< This works no matter what the actual code for
395 backspace is.
396
397 If the backspace key terminal code is wrong you can
398 use this: >
399 :if &term == "termname"
400 : set t_kb=^V<BS>
401 : fixdel
402 :endif
403< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000404 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000405 with your terminal name.
406
407 If your <Delete> key sends a strange key sequence (not
408 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
409 :if &term == "termname"
410 : set t_kD=^V<Delete>
411 :endif
412< Where "^V" is CTRL-V and "<Delete>" is the delete key
413 (don't type eight characters!). Replace "termname"
414 with your terminal name.
415
416 *Linux-backspace*
417 Note about Linux: By default the backspace key
418 produces CTRL-?, which is wrong. You can fix it by
419 putting this line in your rc.local: >
420 echo "keycode 14 = BackSpace" | loadkeys
421<
422 *NetBSD-backspace*
423 Note about NetBSD: If your backspace doesn't produce
424 the right code, try this: >
425 xmodmap -e "keycode 22 = BackSpace"
426< If this works, add this in your .Xmodmap file: >
427 keysym 22 = BackSpace
428< You need to restart for this to take effect.
429
430==============================================================================
4312. Automatically setting options *auto-setting*
432
433Besides changing options with the ":set" command, there are three alternatives
434to set options automatically for one or more files:
435
4361. When starting Vim initializations are read from various places. See
437 |initialization|. Most of them are performed for all editing sessions,
438 and some of them depend on the directory where Vim is started.
439 You can create an initialization file with |:mkvimrc|, |:mkview| and
440 |:mksession|.
4412. If you start editing a new file, the automatic commands are executed.
442 This can be used to set options for files matching a particular pattern and
443 many other things. See |autocommand|.
4443. If you start editing a new file, and the 'modeline' option is on, a
445 number of lines at the beginning and end of the file are checked for
446 modelines. This is explained here.
447
448 *modeline* *vim:* *vi:* *ex:* *E520*
449There are two forms of modelines. The first form:
450 [text]{white}{vi:|vim:|ex:}[white]{options}
451
452[text] any text or empty
453{white} at least one blank character (<Space> or <Tab>)
454{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
455[white] optional white space
456{options} a list of option settings, separated with white space or ':',
457 where each part between ':' is the argument for a ":set"
458 command
459
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000460Example:
461 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000462
463The second form (this is compatible with some versions of Vi):
464
465 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
466
467[text] any text or empty
468{white} at least one blank character (<Space> or <Tab>)
469{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
470[white] optional white space
471se[t] the string "set " or "se " (note the space)
472{options} a list of options, separated with white space, which is the
473 argument for a ":set" command
474: a colon
475[text] any text or empty
476
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000477Example:
478 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000479
480The white space before {vi:|vim:|ex:} is required. This minimizes the chance
481that a normal word like "lex:" is caught. There is one exception: "vi:" and
482"vim:" can also be at the start of the line (for compatibility with version
4833.0). Using "ex:" at the start of the line will be ignored (this could be
484short for "example:").
485
486 *modeline-local*
487The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000488buffer and window that contain the file. Although it's possible to set global
489options from a modeline, this is unusual. If you have two windows open and
490the files in it set the same global option to a different value, the result
491depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000492
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000493When editing a file that was already loaded, only the window-local options
494from the modeline are used. Thus if you manually changed a buffer-local
495option after opening the file, it won't be changed if you edit the same buffer
496in another window. But window-local options will be set.
497
Bram Moolenaar071d4272004-06-13 20:20:40 +0000498 *modeline-version*
499If the modeline is only to be used for some versions of Vim, the version
500number can be specified where "vim:" is used:
501 vim{vers}: version {vers} or later
502 vim<{vers}: version before {vers}
503 vim={vers}: version {vers}
504 vim>{vers}: version after {vers}
505{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000506For example, to use a modeline only for Vim 6.0 and later:
507 /* vim600: set foldmethod=marker: */ ~
508To use a modeline for Vim before version 5.7:
509 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000510There can be no blanks between "vim" and the ":".
511
512
513The number of lines that are checked can be set with the 'modelines' option.
514If 'modeline' is off or 'modelines' is 0 no lines are checked.
515
516Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000517like:
518 /* vi:ts=4: */ ~
519will give an error message for the trailing "*/". This line is OK:
520 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000521
522If an error is detected the rest of the line is skipped.
523
524If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000525backslash in front of the ':' will be removed. Example:
526 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527This sets the 'dir' option to "c:\tmp". Only a single backslash before the
528':' is removed. Thus to include "\:" you have to specify "\\:".
529
530No other commands than "set" are supported, for security reasons (somebody
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
533|sandbox| is effective. Still, there is always a small risc that a modeline
534causes 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 Moolenaarf4b8e572004-06-24 15:53:16 +0000742 <Esc> or <CR>, the indent is deleted again. Moving the cursor to
743 another line has the same effect, unless the 'I' flag is included in
744 'cpoptions'.
745 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
904 and the file is not a link) that is used. When problems are expected,
905 a copy will be made.
906
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 Moolenaara5792f52005-11-23 21:25:05 +00001008 Note that the default also makes sure that "crontab -e" works (when a
1009 backup would be made by renaming the original file crontab won't see
1010 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011
1012 *'balloondelay'* *'bdlay'*
1013'balloondelay' 'bdlay' number (default: 600)
1014 global
1015 {not in Vi}
1016 {only available when compiled with the |+balloon_eval|
1017 feature}
1018 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1019
1020 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1021'ballooneval' 'beval' boolean (default off)
1022 global
1023 {not in Vi}
1024 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001025 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001026 Switch on the |balloon-eval| functionality.
1027
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001028 *'balloonexpr'* *'bexpr'*
1029'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001030 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001031 {not in Vi}
1032 {only available when compiled with the |+balloon_eval|
1033 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001034 Expression for text to show in evaluation balloon. It is only used
1035 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001036
1037 v:beval_bufnr number of the buffer in which balloon is going to show
1038 v:beval_winnr number of the window
1039 v:beval_lnum line number
1040 v:beval_col column number (byte index)
1041 v:beval_text word under or after the mouse pointer
1042
1043 The evaluation of the expression must not have side effects!
1044 Example: >
1045 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001046 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 \', column ' . v:beval_col .
1048 \ ' of file ' . bufname(v:beval_bufnr) .
1049 \ ' on word "' . v:beval_text . '"'
1050 endfunction
1051 set bexpr=MyBalloonExpr()
1052 set ballooneval
1053<
1054 NOTE: The balloon is displayed only if the cursor is on a text
1055 character. If the result of evaluating 'balloonexpr' is not empty,
1056 Vim does not try to send a message to an external debugger (Netbeans
1057 or Sun Workshop).
1058
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001059 The expression may be evaluated in the |sandbox|, see
1060 |sandbox-option|.
1061
1062 It is not allowed to change text or jump to another window while
1063 evaluating 'balloonexpr' |textlock|.
1064
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001065 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001066 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001067< When they are supported "\n" characters will start a new line. If the
1068 expression evaluates to a |List| this is equal to using each List item
1069 as a string and putting "\n" in between them.
1070
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1072'binary' 'bin' boolean (default off)
1073 local to buffer
1074 {not in Vi}
1075 This option should be set before editing a binary file. You can also
1076 use the |-b| Vim argument. When this option is switched on a few
1077 options will be changed (also when it already was on):
1078 'textwidth' will be set to 0
1079 'wrapmargin' will be set to 0
1080 'modeline' will be off
1081 'expandtab' will be off
1082 Also, 'fileformat' and 'fileformats' options will not be used, the
1083 file is read and written like 'fileformat' was "unix" (a single <NL>
1084 separates lines).
1085 The 'fileencoding' and 'fileencodings' options will not be used, the
1086 file is read without conversion.
1087 NOTE: When you start editing a(nother) file while the 'bin' option is
1088 on, settings from autocommands may change the settings again (e.g.,
1089 'textwidth'), causing trouble when editing. You might want to set
1090 'bin' again when the file has been loaded.
1091 The previous values of these options are remembered and restored when
1092 'bin' is switched from on to off. Each buffer has its own set of
1093 saved option values.
1094 To edit a file with 'binary' set you can use the |++bin| argument.
1095 This avoids you have to do ":set bin", which would have effect for all
1096 files you edit.
1097 When writing a file the <EOL> for the last line is only written if
1098 there was one in the original file (normally Vim appends an <EOL> to
1099 the last line if there is none; this would make the file longer). See
1100 the 'endofline' option.
1101
1102 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1103'bioskey' 'biosk' boolean (default on)
1104 global
1105 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001106 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001107 better to detect CTRL-C, but only works for the console. When using a
1108 terminal over a serial port reset this option.
1109 Also see |'conskey'|.
1110
1111 *'bomb'* *'nobomb'*
1112'bomb' boolean (default off)
1113 local to buffer
1114 {not in Vi}
1115 {only available when compiled with the |+multi_byte|
1116 feature}
1117 When writing a file and the following conditions are met, a BOM (Byte
1118 Order Mark) is prepended to the file:
1119 - this option is on
1120 - the 'binary' option is off
1121 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1122 endian variants.
1123 Some applications use the BOM to recognize the encoding of the file.
1124 Often used for UCS-2 files on MS-Windows. For other applications it
1125 causes trouble, for example: "cat file1 file2" makes the BOM of file2
1126 appear halfway the resulting file.
1127 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1128 check for the presence of the BOM is done and 'bomb' set accordingly.
1129 Unless 'binary' is set, it is removed from the first line, so that you
1130 don't see it when editing. When you don't change the options, the BOM
1131 will be restored when writing the file.
1132
1133 *'breakat'* *'brk'*
1134'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1135 global
1136 {not in Vi}
1137 {not available when compiled without the |+linebreak|
1138 feature}
1139 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001140 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1141 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001142
1143 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001144'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001145 global
1146 {not in Vi} {only for Motif and Win32 GUI}
1147 Which directory to use for the file browser:
1148 last Use same directory as with last file browser.
1149 buffer Use the directory of the related buffer.
1150 current Use the current directory.
1151 {path} Use the specified directory
1152
1153 *'bufhidden'* *'bh'*
1154'bufhidden' 'bh' string (default: "")
1155 local to buffer
1156 {not in Vi}
1157 {not available when compiled without the |+quickfix|
1158 feature}
1159 This option specifies what happens when a buffer is no longer
1160 displayed in a window:
1161 <empty> follow the global 'hidden' option
1162 hide hide the buffer (don't unload it), also when 'hidden'
1163 is not set
1164 unload unload the buffer, also when 'hidden' is set or using
1165 |:hide|
1166 delete delete the buffer from the buffer list, also when
1167 'hidden' is set or using |:hide|, like using
1168 |:bdelete|
1169 wipe wipe out the buffer from the buffer list, also when
1170 'hidden' is set or using |:hide|, like using
1171 |:bwipeout|
1172
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001173 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1174 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001175 This option is used together with 'buftype' and 'swapfile' to specify
1176 special kinds of buffers. See |special-buffers|.
1177
1178 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1179'buflisted' 'bl' boolean (default: on)
1180 local to buffer
1181 {not in Vi}
1182 When this option is set, the buffer shows up in the buffer list. If
1183 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1184 This option is reset by Vim for buffers that are only used to remember
1185 a file name or marks. Vim sets it when starting to edit a buffer.
1186 But not when moving to a buffer with ":buffer".
1187
1188 *'buftype'* *'bt'* *E382*
1189'buftype' 'bt' string (default: "")
1190 local to buffer
1191 {not in Vi}
1192 {not available when compiled without the |+quickfix|
1193 feature}
1194 The value of this option specifies the type of a buffer:
1195 <empty> normal buffer
1196 nofile buffer which is not related to a file and will not be
1197 written
1198 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001199 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001200 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001201 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001203 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001204 help help buffer (you are not supposed to set this
1205 manually)
1206
1207 This option is used together with 'bufhidden' and 'swapfile' to
1208 specify special kinds of buffers. See |special-buffers|.
1209
1210 Be careful with changing this option, it can have many side effects!
1211
Bram Moolenaar280f1262006-01-30 00:14:18 +00001212 A "quickfix" buffer is only used for the error list and the location
1213 list. This value is set by the |:cwindow| and |:lwindow| commands and
1214 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215
1216 "nofile" and "nowrite" buffers are similar:
1217 both: The buffer is not to be written to disk, ":w" doesn't
1218 work (":w filename" does work though).
1219 both: The buffer is never considered to be |'modified'|.
1220 There is no warning when the changes will be lost, for
1221 example when you quit Vim.
1222 both: A swap file is only created when using too much memory
1223 (when 'swapfile' has been reset there is never a swap
1224 file).
1225 nofile only: The buffer name is fixed, it is not handled like a
1226 file name. It is not modified in response to a |:cd|
1227 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001228 *E676*
1229 "acwrite" implies that the buffer name is not related to a file, like
1230 "nofile", but it will be written. Thus, in contrast to "nofile" and
1231 "nowrite", ":w" does work and a modified buffer can't be abandoned
1232 without saving. For writing there must be matching |BufWriteCmd|,
1233 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001234
1235 *'casemap'* *'cmp'*
1236'casemap' 'cmp' string (default: "internal,keepascii")
1237 global
1238 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001239 {only available when compiled with the |+multi_byte|
1240 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001241 Specifies details about changing the case of letters. It may contain
1242 these words, separated by a comma:
1243 internal Use internal case mapping functions, the current
1244 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001245 matters when 'encoding' is a Unicode encoding,
1246 "latin1" or "iso-8859-15". When "internal" is
1247 omitted, the towupper() and towlower() system library
1248 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001249 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1250 case mapping, the current locale is not effective.
1251 This probably only matters for Turkish.
1252
1253 *'cdpath'* *'cd'* *E344* *E346*
1254'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1255 global
1256 {not in Vi}
1257 {not available when compiled without the
1258 |+file_in_path| feature}
1259 This is a list of directories which will be searched when using the
1260 |:cd| and |:lcd| commands, provided that the directory being searched
1261 for has a relative path (not starting with "/", "./" or "../").
1262 The 'cdpath' option's value has the same form and semantics as
1263 |'path'|. Also see |file-searching|.
1264 The default value is taken from $CDPATH, with a "," prepended to look
1265 in the current directory first.
1266 If the default value taken from $CDPATH is not what you want, include
1267 a modified version of the following command in your vimrc file to
1268 override it: >
1269 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1270< This option cannot be set from a |modeline| or in the |sandbox|, for
1271 security reasons.
1272 (parts of 'cdpath' can be passed to the shell to expand file names).
1273
1274 *'cedit'*
1275'cedit' string (Vi default: "", Vim default: CTRL-F)
1276 global
1277 {not in Vi}
1278 {not available when compiled without the |+vertsplit|
1279 feature}
1280 The key used in Command-line Mode to open the command-line window.
1281 The default is CTRL-F when 'compatible' is off.
1282 Only non-printable keys are allowed.
1283 The key can be specified as a single character, but it is difficult to
1284 type. The preferred way is to use the <> notation. Examples: >
1285 :set cedit=<C-Y>
1286 :set cedit=<Esc>
1287< |Nvi| also has this option, but it only uses the first character.
1288 See |cmdwin|.
1289
1290 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1291'charconvert' 'ccv' string (default "")
1292 global
1293 {only available when compiled with the |+multi_byte|
1294 feature and the |+eval| feature}
1295 {not in Vi}
1296 An expression that is used for character encoding conversion. It is
1297 evaluated when a file that is to be read or has been written has a
1298 different encoding from what is desired.
1299 'charconvert' is not used when the internal iconv() function is
1300 supported and is able to do the conversion. Using iconv() is
1301 preferred, because it is much faster.
1302 'charconvert' is not used when reading stdin |--|, because there is no
1303 file to convert from. You will have to save the text in a file first.
1304 The expression must return zero or an empty string for success,
1305 non-zero for failure.
1306 The possible encoding names encountered are in 'encoding'.
1307 Additionally, names given in 'fileencodings' and 'fileencoding' are
1308 used.
1309 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1310 is done internally by Vim, 'charconvert' is not used for this.
1311 'charconvert' is also used to convert the viminfo file, if the 'c'
1312 flag is present in 'viminfo'. Also used for Unicode conversion.
1313 Example: >
1314 set charconvert=CharConvert()
1315 fun CharConvert()
1316 system("recode "
1317 \ . v:charconvert_from . ".." . v:charconvert_to
1318 \ . " <" . v:fname_in . " >" v:fname_out)
1319 return v:shell_error
1320 endfun
1321< The related Vim variables are:
1322 v:charconvert_from name of the current encoding
1323 v:charconvert_to name of the desired encoding
1324 v:fname_in name of the input file
1325 v:fname_out name of the output file
1326 Note that v:fname_in and v:fname_out will never be the same.
1327 Note that v:charconvert_from and v:charconvert_to may be different
1328 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1329 Encryption is not done by Vim when using 'charconvert'. If you want
1330 to encrypt the file after conversion, 'charconvert' should take care
1331 of this.
1332 This option cannot be set from a |modeline| or in the |sandbox|, for
1333 security reasons.
1334
1335 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1336'cindent' 'cin' boolean (default off)
1337 local to buffer
1338 {not in Vi}
1339 {not available when compiled without the |+cindent|
1340 feature}
1341 Enables automatic C program indenting See 'cinkeys' to set the keys
1342 that trigger reindenting in insert mode and 'cinoptions' to set your
1343 preferred indent style.
1344 If 'indentexpr' is not empty, it overrules 'cindent'.
1345 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1346 the "=" operator indents using this algorithm rather than calling an
1347 external program.
1348 See |C-indenting|.
1349 When you don't like the way 'cindent' works, try the 'smartindent'
1350 option or 'indentexpr'.
1351 This option is not used when 'paste' is set.
1352 NOTE: This option is reset when 'compatible' is set.
1353
1354 *'cinkeys'* *'cink'*
1355'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1356 local to buffer
1357 {not in Vi}
1358 {not available when compiled without the |+cindent|
1359 feature}
1360 A list of keys that, when typed in Insert mode, cause reindenting of
1361 the current line. Only used if 'cindent' is on and 'indentexpr' is
1362 empty.
1363 For the format of this option see |cinkeys-format|.
1364 See |C-indenting|.
1365
1366 *'cinoptions'* *'cino'*
1367'cinoptions' 'cino' string (default "")
1368 local to buffer
1369 {not in Vi}
1370 {not available when compiled without the |+cindent|
1371 feature}
1372 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1373 program. See |cinoptions-values| for the values of this option, and
1374 |C-indenting| for info on C indenting in general.
1375
1376
1377 *'cinwords'* *'cinw'*
1378'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1379 local to buffer
1380 {not in Vi}
1381 {not available when compiled without both the
1382 |+cindent| and the |+smartindent| features}
1383 These keywords start an extra indent in the next line when
1384 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1385 an appropriate place (inside {}).
1386 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1387 matter, include the keyword both the uppercase and lowercase:
1388 "if,If,IF".
1389
1390 *'clipboard'* *'cb'*
1391'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1392 for X-windows, "" otherwise)
1393 global
1394 {not in Vi}
1395 {only in GUI versions or when the |+xterm_clipboard|
1396 feature is included}
1397 This option is a list of comma separated names.
1398 These names are recognized:
1399
1400 unnamed When included, Vim will use the clipboard register '*'
1401 for all yank, delete, change and put operations which
1402 would normally go to the unnamed register. When a
1403 register is explicitly specified, it will always be
1404 used regardless of whether "unnamed" is in 'clipboard'
1405 or not. The clipboard register can always be
1406 explicitly accessed using the "* notation. Also see
1407 |gui-clipboard|.
1408
1409 autoselect Works like the 'a' flag in 'guioptions': If present,
1410 then whenever Visual mode is started, or the Visual
1411 area extended, Vim tries to become the owner of the
1412 windowing system's global selection or put the
1413 selected text on the clipboard used by the selection
1414 register "*. See |guioptions_a| and |quotestar| for
1415 details. When the GUI is active, the 'a' flag in
1416 'guioptions' is used, when the GUI is not active, this
1417 "autoselect" flag is used.
1418 Also applies to the modeless selection.
1419
1420 autoselectml Like "autoselect", but for the modeless selection
1421 only. Compare to the 'A' flag in 'guioptions'.
1422
1423 exclude:{pattern}
1424 Defines a pattern that is matched against the name of
1425 the terminal 'term'. If there is a match, no
1426 connection will be made to the X server. This is
1427 useful in this situation:
1428 - Running Vim in a console.
1429 - $DISPLAY is set to start applications on another
1430 display.
1431 - You do not want to connect to the X server in the
1432 console, but do want this in a terminal emulator.
1433 To never connect to the X server use: >
1434 exclude:.*
1435< This has the same effect as using the |-X| argument.
1436 Note that when there is no connection to the X server
1437 the window title won't be restored and the clipboard
1438 cannot be accessed.
1439 The value of 'magic' is ignored, {pattern} is
1440 interpreted as if 'magic' was on.
1441 The rest of the option value will be used for
1442 {pattern}, this must be the last entry.
1443
1444 *'cmdheight'* *'ch'*
1445'cmdheight' 'ch' number (default 1)
1446 global
1447 {not in Vi}
1448 Number of screen lines to use for the command-line. Helps avoiding
1449 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001450 The value of this option is stored with the tab page, so that each tab
1451 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452
1453 *'cmdwinheight'* *'cwh'*
1454'cmdwinheight' 'cwh' number (default 7)
1455 global
1456 {not in Vi}
1457 {not available when compiled without the |+vertsplit|
1458 feature}
1459 Number of screen lines to use for the command-line window. |cmdwin|
1460
1461 *'columns'* *'co'* *E594*
1462'columns' 'co' number (default 80 or terminal width)
1463 global
1464 {not in Vi}
1465 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001466 initialization and does not have to be set by hand. Also see
1467 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001468 When Vim is running in the GUI or in a resizable window, setting this
1469 option will cause the window size to be changed. When you only want
1470 to use the size for the GUI, put the command in your |gvimrc| file.
1471 When you set this option and Vim is unable to change the physical
1472 number of columns of the display, the display may be messed up.
Bram Moolenaar551dbcc2006-04-25 22:13:59 +00001473 Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001474
1475 *'comments'* *'com'* *E524* *E525*
1476'comments' 'com' string (default
1477 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1478 local to buffer
1479 {not in Vi}
1480 {not available when compiled without the |+comments|
1481 feature}
1482 A comma separated list of strings that can start a comment line. See
1483 |format-comments|. See |option-backslash| about using backslashes to
1484 insert a space.
1485
1486 *'commentstring'* *'cms'* *E537*
1487'commentstring' 'cms' string (default "/*%s*/")
1488 local to buffer
1489 {not in Vi}
1490 {not available when compiled without the |+folding|
1491 feature}
1492 A template for a comment. The "%s" in the value is replaced with the
1493 comment text. Currently only used to add markers for folding, see
1494 |fold-marker|.
1495
1496 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001497'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1498 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499 global
1500 {not in Vi}
1501 This option has the effect of making Vim either more Vi-compatible, or
1502 make Vim behave in a more useful way.
1503 This is a special kind of option, because when it's set or reset,
1504 other options are also changed as a side effect. CAREFUL: Setting or
1505 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001506 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 set this option in your vimrc file, you should probably put it at the
1508 very start.
1509 By default this option is on and the Vi defaults are used for the
1510 options. This default was chosen for those people who want to use Vim
1511 just like Vi, and don't even (want to) know about the 'compatible'
1512 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001513 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001514 this option is switched off, and all options that have not been
1515 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001516 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001517 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
1518 happen for the system-wide vimrc or gvimrc file). Also see
1519 |compatible-default| and |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 You can also set this option with the "-C" argument, and reset it with
1521 "-N". See |-C| and |-N|.
1522 Switching this option off makes the Vim defaults be used for options
1523 that have a different Vi and Vim default value. See the options
1524 marked with a '+' below. Other options are not modified.
1525 At the moment this option is set, several other options will be set
1526 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001527 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001528 editing.
1529 See also 'cpoptions'.
1530
1531 option + set value effect ~
1532
1533 'allowrevins' off no CTRL-_ command
1534 'backupcopy' Unix: "yes" backup file is a copy
1535 others: "auto" copy or rename backup file
1536 'backspace' "" normal backspace
1537 'backup' off no backup file
1538 'cindent' off no C code indentation
1539 'cedit' + "" no key to open the |cmdwin|
1540 'cpoptions' + (all flags) Vi-compatible flags
1541 'cscopetag' off don't use cscope for ":tag"
1542 'cscopetagorder' 0 see |cscopetagorder|
1543 'cscopeverbose' off see |cscopeverbose|
1544 'digraph' off no digraphs
1545 'esckeys' + off no <Esc>-keys in Insert mode
1546 'expandtab' off tabs not expanded to spaces
1547 'fileformats' + "" no automatic file format detection,
1548 "dos,unix" except for DOS, Windows and OS/2
1549 'formatoptions' + "vt" Vi compatible formatting
1550 'gdefault' off no default 'g' flag for ":s"
1551 'history' + 0 no commandline history
1552 'hkmap' off no Hebrew keyboard mapping
1553 'hkmapp' off no phonetic Hebrew keyboard mapping
1554 'hlsearch' off no highlighting of search matches
1555 'incsearch' off no incremental searching
1556 'indentexpr' "" no indenting by expression
1557 'insertmode' off do not start in Insert mode
1558 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1559 characters and '_'
1560 'joinspaces' on insert 2 spaces after period
1561 'modeline' + off no modelines
1562 'more' + off no pauses in listings
1563 'revins' off no reverse insert
1564 'ruler' off no ruler
1565 'scrolljump' 1 no jump scroll
1566 'scrolloff' 0 no scroll offset
1567 'shiftround' off indent not rounded to shiftwidth
1568 'shortmess' + "" no shortening of messages
1569 'showcmd' + off command characters not shown
1570 'showmode' + off current mode not shown
1571 'smartcase' off no automatic ignore case switch
1572 'smartindent' off no smart indentation
1573 'smarttab' off no smart tab size
1574 'softtabstop' 0 tabs are always 'tabstop' positions
1575 'startofline' on goto startofline with some commands
1576 'tagrelative' + off tag file names are not relative
1577 'textauto' + off no automatic textmode detection
1578 'textwidth' 0 no automatic line wrap
1579 'tildeop' off tilde is not an operator
1580 'ttimeout' off no terminal timeout
1581 'whichwrap' + "" left-right movements don't wrap
1582 'wildchar' + CTRL-E only when the current value is <Tab>
1583 use CTRL-E for cmdline completion
1584 'writebackup' on or off depends on +writebackup feature
1585
1586 *'complete'* *'cpt'* *E535*
1587'complete' 'cpt' string (default: ".,w,b,u,t,i")
1588 local to buffer
1589 {not in Vi}
1590 This option specifies how keyword completion |ins-completion| works
1591 when CTRL-P or CTRL-N are used. It is also used for whole-line
1592 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1593 and the places to scan. It is a comma separated list of flags:
1594 . scan the current buffer ('wrapscan' is ignored)
1595 w scan buffers from other windows
1596 b scan other loaded buffers that are in the buffer list
1597 u scan the unloaded buffers that are in the buffer list
1598 U scan the buffers that are not in the buffer list
1599 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001600 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 k{dict} scan the file {dict}. Several "k" flags can be given,
1602 patterns are valid too. For example: >
1603 :set cpt=k/usr/dict/*,k~/spanish
1604< s scan the files given with the 'thesaurus' option
1605 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1606 are valid too.
1607 i scan current and included files
1608 d scan current and included files for defined name or macro
1609 |i_CTRL-X_CTRL-D|
1610 ] tag completion
1611 t same as "]"
1612
1613 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1614 not executed, this may lead to unexpected completions from some files
1615 (gzipped files for example). Unloaded buffers are not scanned for
1616 whole-line completion.
1617
1618 The default is ".,w,b,u,t,i", which means to scan:
1619 1. the current buffer
1620 2. buffers in other windows
1621 3. other loaded buffers
1622 4. unloaded buffers
1623 5. tags
1624 6. included files
1625
1626 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001627 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1628 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001629
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001630 *'completefunc'* *'cfu'*
1631'completefunc' 'cfu' string (default: empty)
1632 local to buffer
1633 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001634 {not available when compiled without the +eval
1635 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001636 This option specifies a function to be used for Insert mode completion
1637 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001638 See |complete-functions| for an explanation of how the function is
1639 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001640
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001641
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001642 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001643'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001644 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001645 {not available when compiled without the
1646 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001647 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001648 A comma separated list of options for Insert mode completion
1649 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001650
1651 menu Use a popup menu to show the possible completions. The
1652 menu is only shown when there is more than one match and
1653 sufficient colors are available. |ins-completion-menu|
1654
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001655 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001656 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001657 match, e.g., what file it comes from.
1658
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001659 longest Only insert the longest common text of the matches. If
1660 the menu is displayed you can use CTRL-L to add more
1661 characters. Whether case is ignored depends on the kind
1662 of completion. For buffer text the 'ignorecase' option is
1663 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001664
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001665 preview Show extra information about the currently selected
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001666 completion in the preview window.
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001667
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1669'confirm' 'cf' boolean (default off)
1670 global
1671 {not in Vi}
1672 When 'confirm' is on, certain operations that would normally
1673 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1674 instead raise a |dialog| asking if you wish to save the current
1675 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1676 If 'confirm' is off you can still activate confirmation for one
1677 command only (this is most useful in mappings) with the |:confirm|
1678 command.
1679 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1680
1681 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1682'conskey' 'consk' boolean (default off)
1683 global
1684 {not in Vi} {only for MS-DOS}
1685 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001686 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001687 three methods of console input are available:
1688 'conskey' 'bioskey' action ~
1689 on on or off direct console input
1690 off on BIOS
1691 off off STDIN
1692
1693 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1694'copyindent' 'ci' boolean (default off)
1695 local to buffer
1696 {not in Vi}
1697 Copy the structure of the existing lines indent when autoindenting a
1698 new line. Normally the new indent is reconstructed by a series of
1699 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1700 in which case only spaces are used). Enabling this option makes the
1701 new line copy whatever characters were used for indenting on the
1702 existing line. If the new indent is greater than on the existing
1703 line, the remaining space is filled in the normal manner.
1704 NOTE: 'copyindent' is reset when 'compatible' is set.
1705 Also see 'preserveindent'.
1706
1707 *'cpoptions'* *'cpo'*
1708'cpoptions' 'cpo' string (Vim default: "aABceFs",
1709 Vi default: all flags)
1710 global
1711 {not in Vi}
1712 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001713 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001714 not being vi-compatible is mostly or sometimes preferred.
1715 'cpoptions' stands for "compatible-options".
1716 Commas can be added for readability.
1717 To avoid problems with flags that are added in the future, use the
1718 "+=" and "-=" feature of ":set" |add-option-flags|.
1719 NOTE: This option is set to the Vi default value when 'compatible' is
1720 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001721 NOTE: This option is set to the POSIX default value at startup when
1722 the Vi default value would be used and the $VIM_POSIX environment
1723 variable exists |posix|. This means tries to behave like the POSIX
1724 specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001725
1726 contains behavior ~
1727 *cpo-a*
1728 a When included, a ":read" command with a file name
1729 argument will set the alternate file name for the
1730 current window.
1731 *cpo-A*
1732 A When included, a ":write" command with a file name
1733 argument will set the alternate file name for the
1734 current window.
1735 *cpo-b*
1736 b "\|" in a ":map" command is recognized as the end of
1737 the map command. The '\' is included in the mapping,
1738 the text after the '|' is interpreted as the next
1739 command. Use a CTRL-V instead of a backslash to
1740 include the '|' in the mapping. Applies to all
1741 mapping, abbreviation, menu and autocmd commands.
1742 See also |map_bar|.
1743 *cpo-B*
1744 B A backslash has no special meaning in mappings,
1745 abbreviations and the "to" part of the menu commands.
1746 Remove this flag to be able to use a backslash like a
1747 CTRL-V. For example, the command ":map X \<Esc>"
1748 results in X being mapped to:
1749 'B' included: "\^[" (^[ is a real <Esc>)
1750 'B' excluded: "<Esc>" (5 characters)
1751 ('<' excluded in both cases)
1752 *cpo-c*
1753 c Searching continues at the end of any match at the
1754 cursor position, but not further than the start of the
1755 next line. When not present searching continues
1756 one character from the cursor position. With 'c'
1757 "abababababab" only gets three matches when repeating
1758 "/abab", without 'c' there are five matches.
1759 *cpo-C*
1760 C Do not concatenate sourced lines that start with a
1761 backslash. See |line-continuation|.
1762 *cpo-d*
1763 d Using "./" in the 'tags' option doesn't mean to use
1764 the tags file relative to the current file, but the
1765 tags file in the current directory.
1766 *cpo-D*
1767 D Can't use CTRL-K to enter a digraph after Normal mode
1768 commands with a character argument, like |r|, |f| and
1769 |t|.
1770 *cpo-e*
1771 e When executing a register with ":@r", always add a
1772 <CR> to the last line, also when the register is not
1773 linewise. If this flag is not present, the register
1774 is not linewise and the last line does not end in a
1775 <CR>, then the last line is put on the command-line
1776 and can be edited before hitting <CR>.
1777 *cpo-E*
1778 E It is an error when using "y", "d", "c", "g~", "gu" or
1779 "gU" on an Empty region. The operators only work when
1780 at least one character is to be operate on. Example:
1781 This makes "y0" fail in the first column.
1782 *cpo-f*
1783 f When included, a ":read" command with a file name
1784 argument will set the file name for the current buffer,
1785 if the current buffer doesn't have a file name yet.
1786 *cpo-F*
1787 F When included, a ":write" command with a file name
1788 argument will set the file name for the current
1789 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001790 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 *cpo-g*
1792 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001793 *cpo-H*
1794 H When using "I" on a line with only blanks, insert
1795 before the last blank. Without this flag insert after
1796 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001797 *cpo-i*
1798 i When included, interrupting the reading of a file will
1799 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001800 *cpo-I*
1801 I When moving the cursor up or down just after inserting
1802 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001803 *cpo-j*
1804 j When joining lines, only add two spaces after a '.',
1805 not after '!' or '?'. Also see 'joinspaces'.
1806 *cpo-J*
1807 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001808 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001809 white space.
1810 *cpo-k*
1811 k Disable the recognition of raw key codes in
1812 mappings, abbreviations, and the "to" part of menu
1813 commands. For example, if <Key> sends ^[OA (where ^[
1814 is <Esc>), the command ":map X ^[OA" results in X
1815 being mapped to:
1816 'k' included: "^[OA" (3 characters)
1817 'k' excluded: "<Key>" (one key code)
1818 Also see the '<' flag below.
1819 *cpo-K*
1820 K Don't wait for a key code to complete when it is
1821 halfway a mapping. This breaks mapping <F1><F1> when
1822 only part of the second <F1> has been read. It
1823 enables cancelling the mapping by typing <F1><Esc>.
1824 *cpo-l*
1825 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001826 literally, only "\]", "\^", "\-" and "\\" are special.
1827 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1829 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001830 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 *cpo-L*
1832 L When the 'list' option is set, 'wrapmargin',
1833 'textwidth', 'softtabstop' and Virtual Replace mode
1834 (see |gR|) count a <Tab> as two characters, instead of
1835 the normal behavior of a <Tab>.
1836 *cpo-m*
1837 m When included, a showmatch will always wait half a
1838 second. When not included, a showmatch will wait half
1839 a second or until a character is typed. |'showmatch'|
1840 *cpo-M*
1841 M When excluded, "%" matching will take backslashes into
1842 account. Thus in "( \( )" and "\( ( \)" the outer
1843 parenthesis match. When included "%" ignores
1844 backslashes, which is Vi compatible.
1845 *cpo-n*
1846 n When included, the column used for 'number' will also
1847 be used for text of wrapped lines.
1848 *cpo-o*
1849 o Line offset to search command is not remembered for
1850 next search.
1851 *cpo-O*
1852 O Don't complain if a file is being overwritten, even
1853 when it didn't exist when editing it. This is a
1854 protection against a file unexpectedly created by
1855 someone else. Vi didn't complain about this.
1856 *cpo-p*
1857 p Vi compatible Lisp indenting. When not present, a
1858 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001859 *cpo-P*
1860 P When included, a ":write" command that appends to a
1861 file will set the file name for the current buffer, if
1862 the current buffer doesn't have a file name yet and
1863 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001864 *cpo-q*
1865 q When joining multiple lines leave the cursor at the
1866 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001867 *cpo-r*
1868 r Redo ("." command) uses "/" to repeat a search
1869 command, instead of the actually used search string.
1870 *cpo-R*
1871 R Remove marks from filtered lines. Without this flag
1872 marks are kept like |:keepmarks| was used.
1873 *cpo-s*
1874 s Set buffer options when entering the buffer for the
1875 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001876 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001877 set when the buffer is created.
1878 *cpo-S*
1879 S Set buffer options always when entering a buffer
1880 (except 'readonly', 'fileformat', 'filetype' and
1881 'syntax'). This is the (most) Vi compatible setting.
1882 The options are set to the values in the current
1883 buffer. When you change an option and go to another
1884 buffer, the value is copied. Effectively makes the
1885 buffer options global to all buffers.
1886
1887 's' 'S' copy buffer options
1888 no no when buffer created
1889 yes no when buffer first entered (default)
1890 X yes each time when buffer entered (vi comp.)
1891 *cpo-t*
1892 t Search pattern for the tag command is remembered for
1893 "n" command. Otherwise Vim only puts the pattern in
1894 the history for search pattern, but doesn't change the
1895 last used search pattern.
1896 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001897 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001898 *cpo-v*
1899 v Backspaced characters remain visible on the screen in
1900 Insert mode. Without this flag the characters are
1901 erased from the screen right away. With this flag the
1902 screen newly typed text overwrites backspaced
1903 characters.
1904 *cpo-w*
1905 w When using "cw" on a blank character, only change one
1906 character and not all blanks until the start of the
1907 next word.
1908 *cpo-W*
1909 W Don't overwrite a readonly file. When omitted, ":w!"
1910 overwrites a readonly file, if possible.
1911 *cpo-x*
1912 x <Esc> on the command-line executes the command-line.
1913 The default in Vim is to abandon the command-line,
1914 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001915 *cpo-X*
1916 X When using a count with "R" the replaced text is
1917 deleted only once. Also when repeating "R" with "."
1918 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 *cpo-y*
1920 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001921 *cpo-Z*
1922 Z When using "w!" while the 'readonly' option is set,
1923 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 *cpo-!*
1925 ! When redoing a filter command, use the last used
1926 external command, whatever it was. Otherwise the last
1927 used -filter- command is used.
1928 *cpo-$*
1929 $ When making a change to one line, don't redisplay the
1930 line, but put a '$' at the end of the changed text.
1931 The changed text will be overwritten when you type the
1932 new text. The line is redisplayed if you type any
1933 command that moves the cursor from the insertion
1934 point.
1935 *cpo-%*
1936 % Vi-compatible matching is done for the "%" command.
1937 Does not recognize "#if", "#endif", etc.
1938 Does not recognize "/*" and "*/".
1939 Parens inside single and double quotes are also
1940 counted, causing a string that contains a paren to
1941 disturb the matching. For example, in a line like
1942 "if (strcmp("foo(", s))" the first paren does not
1943 match the last one. When this flag is not included,
1944 parens inside single and double quotes are treated
1945 specially. When matching a paren outside of quotes,
1946 everything inside quotes is ignored. When matching a
1947 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001948 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001949 This flag is also used for other features, such as
1950 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001951 *cpo--*
1952 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001953 it would go above the first line or below the last
1954 line. Without it the cursor moves to the first or
1955 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001956 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001957 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00001958 *cpo-+*
1959 + When included, a ":write file" command will reset the
1960 'modified' flag of the buffer, even though the buffer
1961 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001962 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 * Use ":*" in the same way as ":@". When not included,
1964 ":*" is an alias for ":'<,'>", select the Visual area.
1965 *cpo-<*
1966 < Disable the recognition of special key codes in |<>|
1967 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001968 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00001969 ":map X <Tab>" results in X being mapped to:
1970 '<' included: "<Tab>" (5 characters)
1971 '<' excluded: "^I" (^I is a real <Tab>)
1972 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001973 *cpo->*
1974 > When appending to a register, put a line break before
1975 the appended text.
1976
1977 POSIX flags. These are not included in the Vi default value, except
1978 when $VIM_POSIX was set on startup. |posix|
1979
1980 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001981 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001982 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001983 *cpo-&*
1984 & When ":preserve" was used keep the swap file when
1985 exiting normally while this buffer is still loaded.
1986 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001987 *cpo-\*
1988 \ Backslash in a [] range in a search pattern is taken
1989 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00001990 '\' included: "/[ \-]" finds <Space>, '\' and '-'
1991 '\' excluded: "/[ \-]" finds <Space> and '-'
1992 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001993 *cpo-/*
1994 / When "%" is used as the replacement string in a |:s|
1995 command, use the previous replacement string. |:s%|
1996 *cpo-{*
1997 { The |{| and |}| commands also stop at a "{" character
1998 at the start of a line.
1999 *cpo-.*
2000 . The ":chdir" and ":cd" commands fail if the current
2001 buffer is modified, unless ! is used. Vim doesn't
2002 need this, since it remembers the full path of an
2003 opened file.
2004 *cpo-bar*
2005 | The value of the $LINES and $COLUMNS environment
2006 variables overrule the terminal size values obtained
2007 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002008
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009
2010 *'cscopepathcomp'* *'cspc'*
2011'cscopepathcomp' 'cspc' number (default 0)
2012 global
2013 {not available when compiled without the |+cscope|
2014 feature}
2015 {not in Vi}
2016 Determines how many components of the path to show in a list of tags.
2017 See |cscopepathcomp|.
2018
2019 *'cscopeprg'* *'csprg'*
2020'cscopeprg' 'csprg' string (default "cscope")
2021 global
2022 {not available when compiled without the |+cscope|
2023 feature}
2024 {not in Vi}
2025 Specifies the command to execute cscope. See |cscopeprg|.
2026 This option cannot be set from a |modeline| or in the |sandbox|, for
2027 security reasons.
2028
2029 *'cscopequickfix'* *'csqf'*
2030'cscopequickfix' 'csqf' string (default "")
2031 global
2032 {not available when compiled without the |+cscope|
2033 or |+quickfix| features}
2034 {not in Vi}
2035 Specifies whether to use quickfix window to show cscope results.
2036 See |cscopequickfix|.
2037
2038 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2039'cscopetag' 'cst' boolean (default off)
2040 global
2041 {not available when compiled without the |+cscope|
2042 feature}
2043 {not in Vi}
2044 Use cscope for tag commands. See |cscope-options|.
2045 NOTE: This option is reset when 'compatible' is set.
2046
2047 *'cscopetagorder'* *'csto'*
2048'cscopetagorder' 'csto' number (default 0)
2049 global
2050 {not available when compiled without the |+cscope|
2051 feature}
2052 {not in Vi}
2053 Determines the order in which ":cstag" performs a search. See
2054 |cscopetagorder|.
2055 NOTE: This option is set to 0 when 'compatible' is set.
2056
2057 *'cscopeverbose'* *'csverb'*
2058 *'nocscopeverbose'* *'nocsverb'*
2059'cscopeverbose' 'csverb' boolean (default off)
2060 global
2061 {not available when compiled without the |+cscope|
2062 feature}
2063 {not in Vi}
2064 Give messages when adding a cscope database. See |cscopeverbose|.
2065 NOTE: This option is reset when 'compatible' is set.
2066
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002067
2068 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2069'cursorcolumn' 'cuc' boolean (default off)
2070 local to window
2071 {not in Vi}
2072 {not available when compiled without the |+syntax|
2073 feature}
2074 Highlight the screen column of the cursor with CursorColumn
2075 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2076 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002077 If you only want the highlighting in the current window you can use
2078 these autocommands: >
2079 au WinLeave * set nocursorline nocursorcolumn
2080 au WinEnter * set cursorline cursorcolumn
2081<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002082
2083 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2084'cursorline' 'cul' boolean (default off)
2085 local to window
2086 {not in Vi}
2087 {not available when compiled without the |+syntax|
2088 feature}
2089 Highlight the screen line of the cursor with CursorLine
2090 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2091 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002092 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002093 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002094
2095
Bram Moolenaar071d4272004-06-13 20:20:40 +00002096 *'debug'*
2097'debug' string (default "")
2098 global
2099 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002100 These values can be used:
2101 msg Error messages that would otherwise be omitted will be given
2102 anyway.
2103 throw Error messages that would otherwise be omitted will be given
2104 anyway and also throw an exception and set |v:errmsg|.
2105 beep A message will be given when otherwise only a beep would be
2106 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002107 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002108 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2109 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110
2111 *'define'* *'def'*
2112'define' 'def' string (default "^\s*#\s*define")
2113 global or local to buffer |global-local|
2114 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002115 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 pattern, just like for the "/" command. This option is used for the
2117 commands like "[i" and "[d" |include-search|. The 'isident' option is
2118 used to recognize the defined name after the match:
2119 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2120 See |option-backslash| about inserting backslashes to include a space
2121 or backslash.
2122 The default value is for C programs. For C++ this value would be
2123 useful, to include const type declarations: >
2124 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2125< When using the ":set" command, you need to double the backslashes!
2126
2127 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2128'delcombine' 'deco' boolean (default off)
2129 global
2130 {not in Vi}
2131 {only available when compiled with the |+multi_byte|
2132 feature}
2133 If editing Unicode and this option is set, backspace and Normal mode
2134 "x" delete each combining character on its own. When it is off (the
2135 default) the character along with its combining characters are
2136 deleted.
2137 Note: When 'delcombine' is set "xx" may work different from "2x"!
2138
2139 This is useful for Arabic, Hebrew and many other languages where one
2140 may have combining characters overtop of base characters, and want
2141 to remove only the combining ones.
2142
2143 *'dictionary'* *'dict'*
2144'dictionary' 'dict' string (default "")
2145 global or local to buffer |global-local|
2146 {not in Vi}
2147 List of file names, separated by commas, that are used to lookup words
2148 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2149 contain a list of words. This can be one word per line, or several
2150 words per line, separated by non-keyword characters (white space is
2151 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002152 When this option is empty, or an entry "spell" is present, spell
2153 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002154 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 after a comma are ignored, otherwise spaces are included in the file
2156 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002157 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 Where to find a list of words?
2159 - On FreeBSD, there is the file "/usr/share/dict/words".
2160 - In the Simtel archive, look in the "msdos/linguist" directory.
2161 - In "miscfiles" of the GNU collection.
2162 The use of |:set+=| and |:set-=| is preferred when adding or removing
2163 directories from the list. This avoids problems when a future version
2164 uses another default.
2165 Backticks cannot be used in this option for security reasons.
2166
2167 *'diff'* *'nodiff'*
2168'diff' boolean (default off)
2169 local to window
2170 {not in Vi}
2171 {not available when compiled without the |+diff|
2172 feature}
2173 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002174 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002175
2176 *'dex'* *'diffexpr'*
2177'diffexpr' 'dex' string (default "")
2178 global
2179 {not in Vi}
2180 {not available when compiled without the |+diff|
2181 feature}
2182 Expression which is evaluated to obtain an ed-style diff file from two
2183 versions of a file. See |diff-diffexpr|.
2184 This option cannot be set from a |modeline| or in the |sandbox|, for
2185 security reasons.
2186
2187 *'dip'* *'diffopt'*
2188'diffopt' 'dip' string (default "filler")
2189 global
2190 {not in Vi}
2191 {not available when compiled without the |+diff|
2192 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002193 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002194 All are optional. Items must be separated by a comma.
2195
2196 filler Show filler lines, to keep the text
2197 synchronized with a window that has inserted
2198 lines at the same position. Mostly useful
2199 when windows are side-by-side and 'scrollbind'
2200 is set.
2201
2202 context:{n} Use a context of {n} lines between a change
2203 and a fold that contains unchanged lines.
2204 When omitted a context of six lines is used.
2205 See |fold-diff|.
2206
2207 icase Ignore changes in case of text. "a" and "A"
2208 are considered the same. Adds the "-i" flag
2209 to the "diff" command if 'diffexpr' is empty.
2210
2211 iwhite Ignore changes in amount of white space. Adds
2212 the "-b" flag to the "diff" command if
2213 'diffexpr' is empty. Check the documentation
2214 of the "diff" command for what this does
2215 exactly. It should ignore adding trailing
2216 white space, but not leading white space.
2217
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002218 horizontal Start diff mode with horizontal splits (unless
2219 explicitly specified otherwise).
2220
2221 vertical Start diff mode with vertical splits (unless
2222 explicitly specified otherwise).
2223
2224 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2225 starting diff mode. Without this 2 is used.
2226
Bram Moolenaar071d4272004-06-13 20:20:40 +00002227 Examples: >
2228
2229 :set diffopt=filler,context:4
2230 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002231 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232<
2233 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2234'digraph' 'dg' boolean (default off)
2235 global
2236 {not in Vi}
2237 {not available when compiled without the |+digraphs|
2238 feature}
2239 Enable the entering of digraphs in Insert mode with {char1} <BS>
2240 {char2}. See |digraphs|.
2241 NOTE: This option is reset when 'compatible' is set.
2242
2243 *'directory'* *'dir'*
2244'directory' 'dir' string (default for Amiga: ".,t:",
2245 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2246 for Unix: ".,~/tmp,/var/tmp,/tmp")
2247 global
2248 List of directory names for the swap file, separated with commas.
2249 - The swap file will be created in the first directory where this is
2250 possible.
2251 - Empty means that no swap file will be used (recovery is
2252 impossible!).
2253 - A directory "." means to put the swap file in the same directory as
2254 the edited file. On Unix, a dot is prepended to the file name, so
2255 it doesn't show in a directory listing. On MS-Windows the "hidden"
2256 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002257 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002258 put the swap file relative to where the edited file is. The leading
2259 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002260 - For Unix and Win32, if a directory ends in two path separators "//"
2261 or "\\", the swap file name will be built from the complete path to
2262 the file with all path separators substituted to percent '%' signs.
2263 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002264 - Spaces after the comma are ignored, other spaces are considered part
2265 of the directory name. To have a space at the start of a directory
2266 name, precede it with a backslash.
2267 - To include a comma in a directory name precede it with a backslash.
2268 - A directory name may end in an ':' or '/'.
2269 - Environment variables are expanded |:set_env|.
2270 - Careful with '\' characters, type one before a space, type two to
2271 get one in the option (see |option-backslash|), for example: >
2272 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2273< - For backwards compatibility with Vim version 3.0 a '>' at the start
2274 of the option is removed.
2275 Using "." first in the list is recommended. This means that editing
2276 the same file twice will result in a warning. Using "/tmp" on Unix is
2277 discouraged: When the system crashes you lose the swap file.
2278 "/var/tmp" is often not cleared when rebooting, thus is a better
2279 choice than "/tmp". But it can contain a lot of files, your swap
2280 files get lost in the crowd. That is why a "tmp" directory in your
2281 home directory is tried first.
2282 The use of |:set+=| and |:set-=| is preferred when adding or removing
2283 directories from the list. This avoids problems when a future version
2284 uses another default.
2285 This option cannot be set from a |modeline| or in the |sandbox|, for
2286 security reasons.
2287 {Vi: directory to put temp file in, defaults to "/tmp"}
2288
2289 *'display'* *'dy'*
2290'display' 'dy' string (default "")
2291 global
2292 {not in Vi}
2293 Change the way text is displayed. This is comma separated list of
2294 flags:
2295 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002296 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002297 last line that doesn't fit is replaced with "@" lines.
2298 uhex Show unprintable characters hexadecimal as <xx>
2299 instead of using ^C and ~C.
2300
2301 *'eadirection'* *'ead'*
2302'eadirection' 'ead' string (default "both")
2303 global
2304 {not in Vi}
2305 {not available when compiled without the +vertsplit
2306 feature}
2307 Tells when the 'equalalways' option applies:
2308 ver vertically, width of windows is not affected
2309 hor horizontally, height of windows is not affected
2310 both width and height of windows is affected
2311
2312 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2313'edcompatible' 'ed' boolean (default off)
2314 global
2315 Makes the 'g' and 'c' flags of the ":substitute" command to be
2316 toggled each time the flag is given. See |complex-change|. See
2317 also 'gdefault' option.
2318 Switching this option on is discouraged!
2319
2320 *'encoding'* *'enc'* *E543*
2321'encoding' 'enc' string (default: "latin1" or value from $LANG)
2322 global
2323 {only available when compiled with the |+multi_byte|
2324 feature}
2325 {not in Vi}
2326 Sets the character encoding used inside Vim. It applies to text in
2327 the buffers, registers, Strings in expressions, text stored in the
2328 viminfo file, etc. It sets the kind of characters which Vim can work
2329 with. See |encoding-names| for the possible values.
2330
2331 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002332 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333 It should normally be kept at its default value, or set when Vim
2334 starts up. See |multibyte|.
2335
2336 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2337 "utf-8". Although care has been taken to allow different values of
2338 'encoding', "utf-8" is the natural choice for the environment and
2339 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002340 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 versions, and to avoid changing the encoding of newly created files
2342 without your knowledge (in case 'fileencodings' is empty).
2343
2344 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002345 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002346 iconv() or as specified with 'charconvert'.
2347
2348 Normally 'encoding' will be equal to your current locale. This will
2349 be the default if Vim recognizes your environment settings. If
2350 'encoding' is not set to the current locale, 'termencoding' must be
2351 set to convert typed and displayed text. See |encoding-table|.
2352
2353 When you set this option, it fires the |EncodingChanged| autocommand
2354 event so that you can set up fonts if necessary.
2355
2356 When the option is set, the value is converted to lowercase. Thus
2357 you can set it with uppercase values too. Underscores are translated
2358 to '-' signs.
2359 When the encoding is recognized, it is changed to the standard name.
2360 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2361 "iso-8859-2" and "utf8" becomes "utf-8".
2362
2363 Note: "latin1" is also used when the encoding could not be detected.
2364 This only works when editing files in the same encoding! When the
2365 actual character set is not latin1, make sure 'fileencoding' and
2366 'fileencodings' are empty. When conversion is needed, switch to using
2367 utf-8.
2368
2369 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2370 You don't notice this while editing, but it does matter for the
2371 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2372 setting 'encoding' to one of these values instead of utf-8 only has
2373 effect for encoding used for files when 'fileencoding' is empty.
2374
Bram Moolenaar661b1822005-07-28 22:36:45 +00002375 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2376 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377
2378 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2379'endofline' 'eol' boolean (default on)
2380 local to buffer
2381 {not in Vi}
2382 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002383 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 option is automatically set when starting to edit a new file, unless
2385 the file does not have an <EOL> for the last line in the file, in
2386 which case it is reset. Normally you don't have to set or reset this
2387 option. When 'binary' is off the value is not used when writing the
2388 file. When 'binary' is on it is used to remember the presence of a
2389 <EOL> for the last line in the file, so that when you write the file
2390 the situation from the original file can be kept. But you can change
2391 it if you want to.
2392
2393 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2394'equalalways' 'ea' boolean (default on)
2395 global
2396 {not in Vi}
2397 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002398 splitting or closing a window. This also happens the moment the
2399 option is switched on. When off, splitting a window will reduce the
2400 size of the current window and leave the other windows the same. When
2401 closing a window the extra lines are given to the window next to it
2402 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002403 When mixing vertically and horizontally split windows, a minimal size
2404 is computed and some windows may be larger if there is room. The
2405 'eadirection' option tells in which direction the size is affected.
2406 Changing the height of a window can be avoided by setting
2407 'winfixheight'.
2408
2409 *'equalprg'* *'ep'*
2410'equalprg' 'ep' string (default "")
2411 global or local to buffer |global-local|
2412 {not in Vi}
2413 External program to use for "=" command. When this option is empty
2414 the internal formatting functions are used ('lisp', 'cindent' or
2415 'indentexpr').
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002416 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 about including spaces and backslashes.
2418 This option cannot be set from a |modeline| or in the |sandbox|, for
2419 security reasons.
2420
2421 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2422'errorbells' 'eb' boolean (default off)
2423 global
2424 Ring the bell (beep or screen flash) for error messages. This only
2425 makes a difference for error messages, the bell will be used always
2426 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002427 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 screen flash or do nothing.
2429
2430 *'errorfile'* *'ef'*
2431'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2432 others: "errors.err")
2433 global
2434 {not in Vi}
2435 {not available when compiled without the |+quickfix|
2436 feature}
2437 Name of the errorfile for the QuickFix mode (see |:cf|).
2438 When the "-q" command-line argument is used, 'errorfile' is set to the
2439 following argument. See |-q|.
2440 NOT used for the ":make" command. See 'makeef' for that.
2441 Environment variables are expanded |:set_env|.
2442 See |option-backslash| about including spaces and backslashes.
2443 This option cannot be set from a |modeline| or in the |sandbox|, for
2444 security reasons.
2445
2446 *'errorformat'* *'efm'*
2447'errorformat' 'efm' string (default is very long)
2448 global or local to buffer |global-local|
2449 {not in Vi}
2450 {not available when compiled without the |+quickfix|
2451 feature}
2452 Scanf-like description of the format for the lines in the error file
2453 (see |errorformat|).
2454
2455 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2456'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2457 global
2458 {not in Vi}
2459 Function keys that start with an <Esc> are recognized in Insert
2460 mode. When this option is off, the cursor and function keys cannot be
2461 used in Insert mode if they start with an <Esc>. The advantage of
2462 this is that the single <Esc> is recognized immediately, instead of
2463 after one second. Instead of resetting this option, you might want to
2464 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2465 when 'esckeys' is off, you can still map anything, but the cursor keys
2466 won't work by default.
2467 NOTE: This option is set to the Vi default value when 'compatible' is
2468 set and to the Vim default value when 'compatible' is reset.
2469
2470 *'eventignore'* *'ei'*
2471'eventignore' 'ei' string (default "")
2472 global
2473 {not in Vi}
2474 {not available when compiled without the |+autocmd|
2475 feature}
2476 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002477 When set to "all" or when "all" is one of the items, all autocommand
2478 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002479 Otherwise this is a comma separated list of event names. Example: >
2480 :set ei=WinEnter,WinLeave
2481<
2482 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2483'expandtab' 'et' boolean (default off)
2484 local to buffer
2485 {not in Vi}
2486 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002487 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002488 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2489 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2490 NOTE: This option is reset when 'compatible' is set.
2491
2492 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2493'exrc' 'ex' boolean (default off)
2494 global
2495 {not in Vi}
2496 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2497 directory. If you switch this option on you should also consider
2498 setting the 'secure' option (see |initialization|). Using a local
2499 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2500 also see |.vimrc| and |gui-init|.
2501 This option cannot be set from a |modeline| or in the |sandbox|, for
2502 security reasons.
2503
2504 *'fileencoding'* *'fenc'* *E213*
2505'fileencoding' 'fenc' string (default: "")
2506 local to buffer
2507 {only available when compiled with the |+multi_byte|
2508 feature}
2509 {not in Vi}
2510 Sets the character encoding for the file of this buffer.
2511 When 'fileencoding' is different from 'encoding', conversion will be
2512 done when reading and writing the file.
2513 When 'fileencoding' is empty, the same value as 'encoding' will be
2514 used (no conversion when reading or writing a file).
2515 WARNING: Conversion can cause loss of information! When
2516 'encoding' is "utf-8" conversion is most likely done in a way
2517 that the reverse conversion results in the same text. When
2518 'encoding' is not "utf-8" some characters may be lost!
2519 See 'encoding' for the possible values. Additionally, values may be
2520 specified that can be handled by the converter, see
2521 |mbyte-conversion|.
2522 When reading a file 'fileencoding' will be set from 'fileencodings'.
2523 To read a file in a certain encoding it won't work by setting
2524 'fileencoding', use the |++enc| argument.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002525 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2527 When the option is set, the value is converted to lowercase. Thus
2528 you can set it with uppercase values too. '_' characters are
2529 replaced with '-'. If a name is recognized from the list for
2530 'encoding', it is replaced by the standard name. For example
2531 "ISO8859-2" becomes "iso-8859-2".
2532 When this option is set, after starting to edit a file, the 'modified'
2533 option is set, because the file would be different when written.
2534 If you do this in a modeline, you might want to set 'nomodified' to
2535 avoid this.
2536 This option can not be changed when 'modifiable' is off.
2537
2538 *'fe'*
2539 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002540 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002541 old short name was 'fe', which is no longer used.
2542
2543 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002544'fileencodings' 'fencs' string (default: "ucs-bom",
2545 "ucs-bom,utf-8,default,latin1" when
2546 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002547 global
2548 {only available when compiled with the |+multi_byte|
2549 feature}
2550 {not in Vi}
2551 This is a list of character encodings considered when starting to edit
2552 an existing file. When a file is read, Vim tries to use the first
2553 mentioned character encoding. If an error is detected, the next one
2554 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002555 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002556 an empty string, which means the value of 'encoding' is used.
2557 WARNING: Conversion can cause loss of information! When
2558 'encoding' is "utf-8" (or one of the other Unicode variants)
2559 conversion is most likely done in a way that the reverse
2560 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002561 "utf-8" some non-ASCII characters may be lost! You can use
2562 the |++bad| argument to specify what is done with characters
2563 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 For an empty file or a file with only ASCII characters most encodings
2565 will work and the first entry of 'fileencodings' will be used (except
2566 "ucs-bom", which requires the BOM to be present). If you prefer
2567 another encoding use an BufReadPost autocommand event to test if your
2568 preferred encoding is to be used. Example: >
2569 au BufReadPost * if search('\S', 'w') == 0 |
2570 \ set fenc=iso-2022-jp | endif
2571< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2572 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002573 When the |++enc| argument is used then the value of 'fileencodings' is
2574 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002575 Note that 'fileencodings' is not used for a new file, the global value
2576 of 'fileencoding' is used instead. You can set it with: >
2577 :setglobal fenc=iso-8859-2
2578< This means that a non-existing file may get a different encoding than
2579 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580 The special value "ucs-bom" can be used to check for a Unicode BOM
2581 (Byte Order Mark) at the start of the file. It must not be preceded
2582 by "utf-8" or another Unicode encoding for this to work properly.
2583 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2584 because Vim cannot detect an error, thus the encoding is always
2585 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002586 The special value "default" can be used for the encoding from the
2587 environment. This is the default value for 'encoding'. It is useful
2588 when 'encoding' is set to "utf-8" and your environment uses a
2589 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002590 When 'encoding' is "utf-8" and a file contains an illegal byte
2591 sequence it won't be recognized as UTF-8. You can use the |8g8|
2592 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002593 WRONG VALUES: WHAT'S WRONG:
2594 latin1,utf-8 "latin1" will always be used
2595 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2596 file
2597 cp1250,latin1 "cp1250" will always be used
2598 If 'fileencodings' is empty, 'fileencoding' is not modified.
2599 See 'fileencoding' for the possible values.
2600 Setting this option does not have an effect until the next time a file
2601 is read.
2602
2603 *'fileformat'* *'ff'*
2604'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2605 Unix default: "unix",
2606 Macintosh default: "mac")
2607 local to buffer
2608 {not in Vi}
2609 This gives the <EOL> of the current buffer, which is used for
2610 reading/writing the buffer from/to a file:
2611 dos <CR> <NL>
2612 unix <NL>
2613 mac <CR>
2614 When "dos" is used, CTRL-Z at the end of a file is ignored.
2615 See |file-formats| and |file-read|.
2616 For the character encoding of the file see 'fileencoding'.
2617 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2618 works like it was set to "unix'.
2619 This option is set automatically when starting to edit a file and
2620 'fileformats' is not empty and 'binary' is off.
2621 When this option is set, after starting to edit a file, the 'modified'
2622 option is set, because the file would be different when written.
2623 This option can not be changed when 'modifiable' is off.
2624 For backwards compatibility: When this option is set to "dos",
2625 'textmode' is set, otherwise 'textmode' is reset.
2626
2627 *'fileformats'* *'ffs'*
2628'fileformats' 'ffs' string (default:
2629 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2630 Vim Unix: "unix,dos",
2631 Vim Mac: "mac,unix,dos",
2632 Vi Cygwin: "unix,dos",
2633 Vi others: "")
2634 global
2635 {not in Vi}
2636 This gives the end-of-line (<EOL>) formats that will be tried when
2637 starting to edit a new buffer and when reading a file into an existing
2638 buffer:
2639 - When empty, the format defined with 'fileformat' will be used
2640 always. It is not set automatically.
2641 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002642 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002643 'fileformats' name will be used when a file is read into an existing
2644 buffer, no matter what 'fileformat' for that buffer is set to.
2645 - When more than one name is present, separated by commas, automatic
2646 <EOL> detection will be done when reading a file. When starting to
2647 edit a file, a check is done for the <EOL>:
2648 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2649 'fileformat' is set to "dos".
2650 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002651 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 preceding <CR>, "unix" is preferred over "dos".
2653 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2654 This means that "mac" is only chosen when "unix" is not present,
2655 or when no <NL> is found in the file, and when "dos" is not
2656 present, or no <CR><NL> is present in the file.
2657 Also if "unix" was first chosen, but the first <CR> is before
2658 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2659 the file, then 'fileformat' is set to "mac".
2660 4. If 'fileformat' is still not set, the first name from
2661 'fileformats' is used.
2662 When reading a file into an existing buffer, the same is done, but
2663 this happens like 'fileformat' has been set appropriately for that
2664 file only, the option is not changed.
2665 When 'binary' is set, the value of 'fileformats' is not used.
2666
2667 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2668 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2669 done:
2670 - When 'fileformats' is empty, there is no automatic detection. Dos
2671 format will be used.
2672 - When 'fileformats' is set to one or more names, automatic detection
2673 is done. This is based on the first <NL> in the file: If there is a
2674 <CR> in front of it, Dos format is used, otherwise Unix format is
2675 used.
2676 Also see |file-formats|.
2677 For backwards compatibility: When this option is set to an empty
2678 string or one format (no comma is included), 'textauto' is reset,
2679 otherwise 'textauto' is set.
2680 NOTE: This option is set to the Vi default value when 'compatible' is
2681 set and to the Vim default value when 'compatible' is reset.
2682
2683 *'filetype'* *'ft'*
2684'filetype' 'ft' string (default: "")
2685 local to buffer
2686 {not in Vi}
2687 {not available when compiled without the |+autocmd|
2688 feature}
2689 When this option is set, the FileType autocommand event is triggered.
2690 All autocommands that match with the value of this option will be
2691 executed. Thus the value of 'filetype' is used in place of the file
2692 name.
2693 Otherwise this option does not always reflect the current file type.
2694 This option is normally set when the file type is detected. To enable
2695 this use the ":filetype on" command. |:filetype|
2696 Setting this option to a different value is most useful in a modeline,
2697 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002698 Example, for in an IDL file:
2699 /* vim: set filetype=idl : */ ~
2700 |FileType| |filetypes|
2701 When a dot appears in the value then this separates two filetype
2702 names. Example:
2703 /* vim: set filetype=c.doxygen : */ ~
2704 This will use the "c" filetype first, then the "doxygen" filetype.
2705 This works both for filetype plugins and for syntax files. More than
2706 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 Do not confuse this option with 'osfiletype', which is for the file
2708 type that is actually stored with the file.
2709 This option is not copied to another buffer, independent of the 's' or
2710 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002711 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002712
2713 *'fillchars'* *'fcs'*
2714'fillchars' 'fcs' string (default "vert:|,fold:-")
2715 global
2716 {not in Vi}
2717 {not available when compiled without the |+windows|
2718 and |+folding| features}
2719 Characters to fill the statuslines and vertical separators.
2720 It is a comma separated list of items:
2721
2722 item default Used for ~
2723 stl:c ' ' or '^' statusline of the current window
2724 stlnc:c ' ' or '-' statusline of the non-current windows
2725 vert:c '|' vertical separators |:vsplit|
2726 fold:c '-' filling 'foldtext'
2727 diff:c '-' deleted lines of the 'diff' option
2728
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002729 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002730 "stlnc" the space will be used when there is highlighting, '^' or '-'
2731 otherwise.
2732
2733 Example: >
2734 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2735< This is similar to the default, except that these characters will also
2736 be used when there is highlighting.
2737
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002738 for "stl" and "stlnc" only single-byte values are supported.
2739
Bram Moolenaar071d4272004-06-13 20:20:40 +00002740 The highlighting used for these items:
2741 item highlight group ~
2742 stl:c StatusLine |hl-StatusLine|
2743 stlnc:c StatusLineNC |hl-StatusLineNC|
2744 vert:c VertSplit |hl-VertSplit|
2745 fold:c Folded |hl-Folded|
2746 diff:c DiffDelete |hl-DiffDelete|
2747
2748 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2749'fkmap' 'fk' boolean (default off) *E198*
2750 global
2751 {not in Vi}
2752 {only available when compiled with the |+rightleft|
2753 feature}
2754 When on, the keyboard is mapped for the Farsi character set.
2755 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002756 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757
2758 *'foldclose'* *'fcl'*
2759'foldclose' 'fcl' string (default "")
2760 global
2761 {not in Vi}
2762 {not available when compiled without the |+folding|
2763 feature}
2764 When set to "all", a fold is closed when the cursor isn't in it and
2765 its level is higher than 'foldlevel'. Useful if you want folds to
2766 automatically close when moving out of them.
2767
2768 *'foldcolumn'* *'fdc'*
2769'foldcolumn' 'fdc' number (default 0)
2770 local to window
2771 {not in Vi}
2772 {not available when compiled without the |+folding|
2773 feature}
2774 When non-zero, a column with the specified width is shown at the side
2775 of the window which indicates open and closed folds. The maximum
2776 value is 12.
2777 See |folding|.
2778
2779 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2780'foldenable' 'fen' boolean (default on)
2781 local to window
2782 {not in Vi}
2783 {not available when compiled without the |+folding|
2784 feature}
2785 When off, all folds are open. This option can be used to quickly
2786 switch between showing all text unfolded and viewing the text with
2787 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002788 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 'foldenable' is off.
2790 This option is set by commands that create a new fold or close a fold.
2791 See |folding|.
2792
2793 *'foldexpr'* *'fde'*
2794'foldexpr' 'fde' string (default: "0")
2795 local to window
2796 {not in Vi}
2797 {not available when compiled without the |+folding|
2798 or |+eval| feature}
2799 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002800 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002801
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002802 The expression may be evaluated in the |sandbox|, see
2803 |sandbox-option|.
2804
2805 It is not allowed to change text or jump to another window while
2806 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807
2808 *'foldignore'* *'fdi'*
2809'foldignore' 'fdi' string (default: "#")
2810 local to window
2811 {not in Vi}
2812 {not available when compiled without the |+folding|
2813 feature}
2814 Used only when 'foldmethod' is "indent". Lines starting with
2815 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002816 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002817 The default "#" works well for C programs. See |fold-indent|.
2818
2819 *'foldlevel'* *'fdl'*
2820'foldlevel' 'fdl' number (default: 0)
2821 local to window
2822 {not in Vi}
2823 {not available when compiled without the |+folding|
2824 feature}
2825 Sets the fold level: Folds with a higher level will be closed.
2826 Setting this option to zero will close all folds. Higher numbers will
2827 close fewer folds.
2828 This option is set by commands like |zm|, |zM| and |zR|.
2829 See |fold-foldlevel|.
2830
2831 *'foldlevelstart'* *'fdls'*
2832'foldlevelstart' 'fdls' number (default: -1)
2833 global
2834 {not in Vi}
2835 {not available when compiled without the |+folding|
2836 feature}
2837 Sets 'foldlevel' when starting to edit another buffer in a window.
2838 Useful to always start editing with all folds closed (value zero),
2839 some folds closed (one) or no folds closed (99).
2840 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002841 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002842 ignores this option and closes all folds.
2843 It is also done before BufReadPre autocommands, to allow an autocmd to
2844 overrule the 'foldlevel' value for specific files.
2845 When the value is negative, it is not used.
2846
2847 *'foldmarker'* *'fmr'* *E536*
2848'foldmarker' 'fmr' string (default: "{{{,}}}")
2849 local to window
2850 {not in Vi}
2851 {not available when compiled without the |+folding|
2852 feature}
2853 The start and end marker used when 'foldmethod' is "marker". There
2854 must be one comma, which separates the start and end marker. The
2855 marker is a literal string (a regular expression would be too slow).
2856 See |fold-marker|.
2857
2858 *'foldmethod'* *'fdm'*
2859'foldmethod' 'fdm' string (default: "manual")
2860 local to window
2861 {not in Vi}
2862 {not available when compiled without the |+folding|
2863 feature}
2864 The kind of folding used for the current window. Possible values:
2865 |fold-manual| manual Folds are created manually.
2866 |fold-indent| indent Lines with equal indent form a fold.
2867 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2868 |fold-marker| marker Markers are used to specify folds.
2869 |fold-syntax| syntax Syntax highlighting items specify folds.
2870 |fold-diff| diff Fold text that is not changed.
2871
2872 *'foldminlines'* *'fml'*
2873'foldminlines' 'fml' number (default: 1)
2874 local to window
2875 {not in Vi}
2876 {not available when compiled without the |+folding|
2877 feature}
2878 Sets the minimum number of screen lines for a fold to be displayed
2879 closed. Also for manually closed folds.
2880 Note that this only has an effect of what is displayed. After using
2881 "zc" to close a fold, which is displayed open because it's smaller
2882 than 'foldminlines', a following "zc" may close a containing fold.
2883
2884 *'foldnestmax'* *'fdn'*
2885'foldnestmax' 'fdn' number (default: 20)
2886 local to window
2887 {not in Vi}
2888 {not available when compiled without the |+folding|
2889 feature}
2890 Sets the maximum nesting of folds for the "indent" and "syntax"
2891 methods. This avoids that too many folds will be created. Using more
2892 than 20 doesn't work, because the internal limit is 20.
2893
2894 *'foldopen'* *'fdo'*
2895'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2896 search,tag,undo")
2897 global
2898 {not in Vi}
2899 {not available when compiled without the |+folding|
2900 feature}
2901 Specifies for which type of commands folds will be opened, if the
2902 command moves the cursor into a closed fold. It is a comma separated
2903 list of items.
2904 item commands ~
2905 all any
2906 block "(", "{", "[[", "[{", etc.
2907 hor horizontal movements: "l", "w", "fx", etc.
2908 insert any command in Insert mode
2909 jump far jumps: "G", "gg", etc.
2910 mark jumping to a mark: "'m", CTRL-O, etc.
2911 percent "%"
2912 quickfix ":cn", ":crew", ":make", etc.
2913 search search for a pattern: "/", "n", "*", "gd", etc.
2914 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002915 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 tag jumping to a tag: ":ta", CTRL-T, etc.
2917 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002918 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002919 the |zv| command to the mapping to get the same effect.
2920 When a movement command is used for an operator (e.g., "dl" or "y%")
2921 this option is not used. This means the operator will include the
2922 whole closed fold.
2923 Note that vertical movements are not here, because it would make it
2924 very difficult to move onto a closed fold.
2925 In insert mode the folds containing the cursor will always be open
2926 when text is inserted.
2927 To close folds you can re-apply 'foldlevel' with the |zx| command or
2928 set the 'foldclose' option to "all".
2929
2930 *'foldtext'* *'fdt'*
2931'foldtext' 'fdt' string (default: "foldtext()")
2932 local to window
2933 {not in Vi}
2934 {not available when compiled without the |+folding|
2935 feature}
2936 An expression which is used to specify the text displayed for a closed
2937 fold. See |fold-foldtext|.
2938
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002939 The expression may be evaluated in the |sandbox|, see
2940 |sandbox-option|.
2941
2942 It is not allowed to change text or jump to another window while
2943 evaluating 'foldtext' |textlock|.
2944
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 *'formatoptions'* *'fo'*
2946'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
2947 local to buffer
2948 {not in Vi}
2949 This is a sequence of letters which describes how automatic
2950 formatting is to be done. See |fo-table|. When the 'paste' option is
2951 on, no formatting is done (like 'formatoptions' is empty). Commas can
2952 be inserted for readability.
2953 To avoid problems with flags that are added in the future, use the
2954 "+=" and "-=" feature of ":set" |add-option-flags|.
2955 NOTE: This option is set to the Vi default value when 'compatible' is
2956 set and to the Vim default value when 'compatible' is reset.
2957
Bram Moolenaar86b68352004-12-27 21:59:20 +00002958 *'formatlistpat'* *'flp'*
2959'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
2960 local to buffer
2961 {not in Vi}
2962 A pattern that is used to recognize a list header. This is used for
2963 the "n" flag in 'formatoptions'.
2964 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00002965 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00002966 while still checking more characters. There must be a character
2967 following the pattern, when it matches the whole line it is handled
2968 like there is no match.
2969 The default recognizes a number, followed by an optional punctuation
2970 character and white space.
2971
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 *'formatprg'* *'fp'*
2973'formatprg' 'fp' string (default "")
2974 global
2975 {not in Vi}
2976 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002977 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00002979 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002980 If the 'formatexpr' option is not empty it will be used instead.
2981 Otherwise, if 'formatprg' option is an empty string, the internal
2982 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00002983 Environment variables are expanded |:set_env|. See |option-backslash|
2984 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002985 The expression may be evaluated in the |sandbox|, see
2986 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00002988 *'formatexpr'* *'fex'*
2989'formatexpr' 'fex' string (default "")
2990 local to buffer
2991 {not in Vi}
2992 {not available when compiled without the |+eval|
2993 feature}
2994 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002995 operator. When this option is empty 'formatprg' is used.
2996
2997 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002998 The |v:count| variable holds the number of lines to be formatted.
2999 The |v:char| variable holds the character that is going to be
3000 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003001
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003002 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003003 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003004< This will invoke the mylang#Format() function in the
3005 autoload/mylang.vim file in 'runtimepath'. |autoload|
3006
3007 The expression is also evaluated when 'textwidth' is set and adding
3008 text beyond that limit. This happens under the same conditions as
3009 when internal formatting is used. Make sure the cursor is kept in the
3010 same spot relative to the text then! The |mode()| function will
3011 return "i" or "R" in this situation. When the function returns
3012 non-zero Vim will fall back to using the internal format mechanism.
3013
3014 The expression may be evaluated in the |sandbox|, see
3015 |sandbox-option|.
3016
3017 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003018'fsync' 'fs' boolean (default on)
3019 global
3020 {not in Vi}
3021 When on, the library function fsync() will be called after writing a
3022 file. This will flush a file to disk, ensuring that it is safely
3023 written even on filesystems which do metadata-only journaling. This
3024 will force the harddrive to spin up on Linux systems running in laptop
3025 mode, so it may be undesirable in some situations. Be warned that
3026 turning this off increases the chances of data loss after a crash. On
3027 systems without an fsync() implementation, this variable is always
3028 off.
3029 Also see 'swapsync' for controlling fsync() on swap files.
3030
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3032'gdefault' 'gd' boolean (default off)
3033 global
3034 {not in Vi}
3035 When on, the ":substitute" flag 'g' is default on. This means that
3036 all matches in a line are substituted instead of one. When a 'g' flag
3037 is given to a ":substitute" command, this will toggle the substitution
3038 of all or one match. See |complex-change|.
3039
3040 command 'gdefault' on 'gdefault' off ~
3041 :s/// subst. all subst. one
3042 :s///g subst. one subst. all
3043 :s///gg subst. all subst. one
3044
3045 NOTE: This option is reset when 'compatible' is set.
3046
3047 *'grepformat'* *'gfm'*
3048'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3049 global
3050 {not in Vi}
3051 Format to recognize for the ":grep" command output.
3052 This is a scanf-like string that uses the same format as the
3053 'errorformat' option: see |errorformat|.
3054
3055 *'grepprg'* *'gp'*
3056'grepprg' 'gp' string (default "grep -n ",
3057 Unix: "grep -n $* /dev/null",
3058 Win32: "findstr /n" or "grep -n",
3059 VMS: "SEARCH/NUMBERS ")
3060 global or local to buffer |global-local|
3061 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003062 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003063 and '#' characters, which are expanded like when used in a command-
3064 line. The placeholder "$*" is allowed to specify where the arguments
3065 will be included. Environment variables are expanded |:set_env|. See
3066 |option-backslash| about including spaces and backslashes.
3067 When your "grep" accepts the "-H" argument, use this to make ":grep"
3068 also work well with a single file: >
3069 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003070< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003071 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3072 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003073 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 apply equally to 'grepprg'.
3075 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3076 otherwise it's "grep -n".
3077 This option cannot be set from a |modeline| or in the |sandbox|, for
3078 security reasons.
3079
3080 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3081'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3082 ve:ver35-Cursor,
3083 o:hor50-Cursor,
3084 i-ci:ver25-Cursor/lCursor,
3085 r-cr:hor20-Cursor/lCursor,
3086 sm:block-Cursor
3087 -blinkwait175-blinkoff150-blinkon175",
3088 for MS-DOS and Win32 console:
3089 "n-v-c:block,o:hor50,i-ci:hor15,
3090 r-cr:hor30,sm:block")
3091 global
3092 {not in Vi}
3093 {only available when compiled with GUI enabled, and
3094 for MS-DOS and Win32 console}
3095 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003096 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 the height of the cursor can be changed. This can be done by
3098 specifying a block cursor, or a percentage for a vertical or
3099 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003100 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003101
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003102 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003103 mode-list and an argument-list:
3104 mode-list:argument-list,mode-list:argument-list,..
3105 The mode-list is a dash separated list of these modes:
3106 n Normal mode
3107 v Visual mode
3108 ve Visual mode with 'selection' "exclusive" (same as 'v',
3109 if not specified)
3110 o Operator-pending mode
3111 i Insert mode
3112 r Replace mode
3113 c Command-line Normal (append) mode
3114 ci Command-line Insert mode
3115 cr Command-line Replace mode
3116 sm showmatch in Insert mode
3117 a all modes
3118 The argument-list is a dash separated list of these arguments:
3119 hor{N} horizontal bar, {N} percent of the character height
3120 ver{N} vertical bar, {N} percent of the character width
3121 block block cursor, fills the whole character
3122 [only one of the above three should be present]
3123 blinkwait{N} *cursor-blinking*
3124 blinkon{N}
3125 blinkoff{N}
3126 blink times for cursor: blinkwait is the delay before
3127 the cursor starts blinking, blinkon is the time that
3128 the cursor is shown and blinkoff is the time that the
3129 cursor is not shown. The times are in msec. When one
3130 of the numbers is zero, there is no blinking. The
3131 default is: "blinkwait700-blinkon400-blinkoff250".
3132 These numbers are used for a missing entry. This
3133 means that blinking is enabled by default. To switch
3134 blinking off you can use "blinkon0". The cursor only
3135 blinks when Vim is waiting for input, not while
3136 executing a command.
3137 To make the cursor blink in an xterm, see
3138 |xterm-blink|.
3139 {group-name}
3140 a highlight group name, that sets the color and font
3141 for the cursor
3142 {group-name}/{group-name}
3143 Two highlight group names, the first is used when
3144 no language mappings are used, the other when they
3145 are. |language-mapping|
3146
3147 Examples of parts:
3148 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3149 block cursor with colors from the "nCursor"
3150 highlight group
3151 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3152 In Insert and Command-line Insert mode, use a
3153 30% vertical bar cursor with colors from the
3154 "iCursor" highlight group. Blink a bit
3155 faster.
3156
3157 The 'a' mode is different. It will set the given argument-list for
3158 all modes. It does not reset anything to defaults. This can be used
3159 to do a common setting for all modes. For example, to switch off
3160 blinking: "a:blinkon0"
3161
3162 Examples of cursor highlighting: >
3163 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3164 :highlight Cursor gui=NONE guifg=bg guibg=fg
3165<
3166 *'guifont'* *'gfn'*
3167 *E235* *E596* *E610* *E611*
3168'guifont' 'gfn' string (default "")
3169 global
3170 {not in Vi}
3171 {only available when compiled with GUI enabled}
3172 This is a list of fonts which will be used for the GUI version of Vim.
3173 In its simplest form the value is just one font name. When
3174 the font cannot be found you will get an error message. To try other
3175 font names a list can be specified, font names separated with commas.
3176 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003177
Bram Moolenaar05159a02005-02-26 23:04:13 +00003178 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3179 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 Spaces after a comma are ignored. To include a comma in a font name
3182 precede it with a backslash. Setting an option requires an extra
3183 backslash before a space and a backslash. See also
3184 |option-backslash|. For example: >
3185 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003186< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003187 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003188
3189 If none of the fonts can be loaded, Vim will keep the current setting.
3190 If an empty font list is given, Vim will try using other resource
3191 settings (for X, it will use the Vim.font resource), and finally it
3192 will try some builtin default which should always be there ("7x13" in
3193 the case of X). The font names given should be "normal" fonts. Vim
3194 will try to find the related bold and italic fonts.
3195
Bram Moolenaar05159a02005-02-26 23:04:13 +00003196 For Win32, GTK, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003197 :set guifont=*
3198< will bring up a font requester, where you can pick the font you want.
3199
3200 The font name depends on the GUI used. See |setting-guifont| for a
3201 way to set 'guifont' for various systems.
3202
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 For the GTK+ 2 GUI the font name looks like this: >
3204 :set guifont=Andale\ Mono\ 11
3205< That's all. XLFDs are no longer accepted.
Bram Moolenaar05159a02005-02-26 23:04:13 +00003206
3207 For Mac OSX you can use something like this: >
3208 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003209< Also see 'macatsui', it can help fix display problems.
3210 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003212 width). An exception is GTK 2: all fonts are accepted, but
3213 mono-spaced fonts look best.
3214
Bram Moolenaar071d4272004-06-13 20:20:40 +00003215 To preview a font on X11, you might be able to use the "xfontsel"
3216 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 For the Win32 GUI *E244* *E245*
3219 - takes these options in the font name:
3220 hXX - height is XX (points, can be floating-point)
3221 wXX - width is XX (points, can be floating-point)
3222 b - bold
3223 i - italic
3224 u - underline
3225 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003226 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3228 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3229 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003230 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231
3232 Use a ':' to separate the options.
3233 - A '_' can be used in the place of a space, so you don't need to use
3234 backslashes to escape the spaces.
3235 - Examples: >
3236 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3237 :set guifont=Andale_Mono:h7.5:w4.5
3238< See also |font-sizes|.
3239
3240 *'guifontset'* *'gfs'*
3241 *E250* *E252* *E234* *E597* *E598*
3242'guifontset' 'gfs' string (default "")
3243 global
3244 {not in Vi}
3245 {only available when compiled with GUI enabled and
3246 with the |+xfontset| feature}
3247 {not available in the GTK+ 2 GUI}
3248 When not empty, specifies two (or more) fonts to be used. The first
3249 one for normal English, the second one for your special language. See
3250 |xfontset|.
3251 Setting this option also means that all font names will be handled as
3252 a fontset name. Also the ones used for the "font" argument of the
3253 |:highlight| command.
3254 The fonts must match with the current locale. If fonts for the
3255 character sets that the current locale uses are not included, setting
3256 'guifontset' will fail.
3257 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3258 the comma-separated names are alternative names, one of which will be
3259 used. In 'guifontset' the whole string is one fontset name,
3260 including the commas. It is not possible to specify alternative
3261 fontset names.
3262 This example works on many X11 systems: >
3263 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3264<
3265 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3266'guifontwide' 'gfw' string (default "")
3267 global
3268 {not in Vi}
3269 {only available when compiled with GUI enabled}
3270 When not empty, specifies a comma-separated list of fonts to be used
3271 for double-width characters. The first font that can be loaded is
3272 used.
3273 Note: The size of these fonts must be exactly twice as wide as the one
3274 specified with 'guifont' and the same height.
3275
3276 All GUI versions but GTK+ 2:
3277
3278 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3279 'guifontset' is empty or invalid.
3280 When 'guifont' is set and a valid font is found in it and
3281 'guifontwide' is empty Vim will attempt to find a matching
3282 double-width font and set 'guifontwide' to it.
3283
3284 GTK+ 2 GUI only: *guifontwide_gtk2*
3285
3286 If set and valid, 'guifontwide' is always used for double width
3287 characters, even if 'encoding' is not set to "utf-8".
3288 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003289 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003290 font for characters not available in 'guifont'. Thus you do not need
3291 to set 'guifontwide' at all unless you want to override the choice
3292 made by Pango/Xft.
3293
3294 *'guiheadroom'* *'ghr'*
3295'guiheadroom' 'ghr' number (default 50)
3296 global
3297 {not in Vi} {only for GTK and X11 GUI}
3298 The number of pixels subtracted from the screen height when fitting
3299 the GUI window on the screen. Set this before the GUI is started,
3300 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003301 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003302 lines will be left for window decorations and other items on the
3303 screen. Set it to a negative value to allow windows taller than the
3304 screen.
3305
3306 *'guioptions'* *'go'*
3307'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003308 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 global
3310 {not in Vi}
3311 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003312 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 sequence of letters which describes what components and options of the
3314 GUI should be used.
3315 To avoid problems with flags that are added in the future, use the
3316 "+=" and "-=" feature of ":set" |add-option-flags|.
3317
3318 Valid letters are as follows:
3319 *guioptions_a*
3320 'a' Autoselect: If present, then whenever VISUAL mode is started,
3321 or the Visual area extended, Vim tries to become the owner of
3322 the windowing system's global selection. This means that the
3323 Visually highlighted text is available for pasting into other
3324 applications as well as into Vim itself. When the Visual mode
3325 ends, possibly due to an operation on the text, or when an
3326 application wants to paste the selection, the highlighted text
3327 is automatically yanked into the "* selection register.
3328 Thus the selection is still available for pasting into other
3329 applications after the VISUAL mode has ended.
3330 If not present, then Vim won't become the owner of the
3331 windowing system's global selection unless explicitly told to
3332 by a yank or delete operation for the "* register.
3333 The same applies to the modeless selection.
3334
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 applies to the modeless selection.
3337
3338 'guioptions' autoselect Visual autoselect modeless ~
3339 "" - -
3340 "a" yes yes
3341 "A" - yes
3342 "aA" yes yes
3343
3344 'c' Use console dialogs instead of popup dialogs for simple
3345 choices.
3346
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003347 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003348 'guitablabel' can be used to change the text in the labels.
3349 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003350 The GUI tabs are only supported on some systems, currently
3351 GTK, Motif and MS-Windows.
Bram Moolenaar32466aa2006-02-24 23:53:04 +00003352
Bram Moolenaar071d4272004-06-13 20:20:40 +00003353 'f' Foreground: Don't use fork() to detach the GUI from the shell
3354 where it was started. Use this for programs that wait for the
3355 editor to finish (e.g., an e-mail program). Alternatively you
3356 can use "gvim -f" or ":gui -f" to start the GUI in the
3357 foreground. |gui-fork|
3358 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003359 happened already when the |gvimrc| file is read.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003360
3361 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3362 corner of the window. It's black&white on non-GTK, because of
3363 limitations of X11. For a color icon, see |X11-icon|.
3364
3365 'm' Menu bar is present.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003366 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003368 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003369 file is sourced the system menu has already been loaded; the
3370 ":syntax on" and ":filetype on" commands load the menu too).
3371 'g' Grey menu items: Make menu items that are not active grey. If
3372 'g' is not included inactive menu items are not shown at all.
3373 Exception: Athena will always use grey menu items.
3374
3375 't' Include tearoff menu items. Currently only works for Win32,
3376 GTK+, and Motif 1.2 GUI.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003377 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003378 and Athena GUIs.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003379
3380 'r' Right-hand scrollbar is always present.
3381 'R' Right-hand scrollbar is present when there is a vertically
3382 split window.
3383 'l' Left-hand scrollbar is always present.
3384 'L' Left-hand scrollbar is present when there is a vertically
3385 split window.
3386 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3387 the longest visible line, or on the cursor line if the 'h'
3388 flag is included. |gui-horiz-scroll|
3389 'h' Limit horizontal scrollbar size to the length of the cursor
3390 line. Reduces computations. |gui-horiz-scroll|
3391
3392 And yes, you may even have scrollbars on the left AND the right if
3393 you really want to :-). See |gui-scrollbars| for more information.
3394
3395 'v' Use a vertical button layout for dialogs. When not included,
3396 a horizontal layout is preferred, but when it doesn't fit a
3397 vertical layout is used anyway.
3398 'p' Use Pointer callbacks for X11 GUI. This is required for some
3399 window managers. If the cursor is not blinking or hollow at
3400 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003401 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 removing it after the GUI has started has no effect.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003403 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404
3405 *'guipty'* *'noguipty'*
3406'guipty' boolean (default on)
3407 global
3408 {not in Vi}
3409 {only available when compiled with GUI enabled}
3410 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3411 I/O to/from shell commands. See |gui-pty|.
3412
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003413 *'guitablabel'* *'gtl'*
3414'guitablabel' 'gtl' string (default empty)
3415 global
3416 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003417 {only available when compiled with GUI enabled and
3418 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003419 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003420 pages line. When empty and when the result is empty Vim will use a
3421 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003422
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003423 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003424 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003425
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003426 Only used when the GUI tab pages line is displayed. 'e' must be
3427 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3428 used.
3429
Bram Moolenaar57657d82006-04-21 22:12:41 +00003430 *'guitabtooltip'* *'gtt'*
3431'guitabtooltip' 'gtt' string (default empty)
3432 global
3433 {not in Vi}
3434 {only available when compiled with GUI enabled and
3435 with the +windows feature}
3436 When nonempty describes the text to use in a tooltip for the GUI tab
3437 pages line. When empty Vim will use a default tooltip.
3438 This option is otherwise just like 'guitablabel' above.
3439
Bram Moolenaar57657d82006-04-21 22:12:41 +00003440
Bram Moolenaar071d4272004-06-13 20:20:40 +00003441 *'helpfile'* *'hf'*
3442'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3443 (others) "$VIMRUNTIME/doc/help.txt")
3444 global
3445 {not in Vi}
3446 Name of the main help file. All distributed help files should be
3447 placed together in one directory. Additionally, all "doc" directories
3448 in 'runtimepath' will be used.
3449 Environment variables are expanded |:set_env|. For example:
3450 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003451 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003452 spaces and backslashes.
3453 This option cannot be set from a |modeline| or in the |sandbox|, for
3454 security reasons.
3455
3456 *'helpheight'* *'hh'*
3457'helpheight' 'hh' number (default 20)
3458 global
3459 {not in Vi}
3460 {not available when compiled without the +windows
3461 feature}
3462 Minimal initial height of the help window when it is opened with the
3463 ":help" command. The initial height of the help window is half of the
3464 current window, or (when the 'ea' option is on) the same as other
3465 windows. When the height is less than 'helpheight', the height is
3466 set to 'helpheight'. Set to zero to disable.
3467
3468 *'helplang'* *'hlg'*
3469'helplang' 'hlg' string (default: messages language or empty)
3470 global
3471 {only available when compiled with the |+multi_lang|
3472 feature}
3473 {not in Vi}
3474 Comma separated list of languages. Vim will use the first language
3475 for which the desired help can be found. The English help will always
3476 be used as a last resort. You can add "en" to prefer English over
3477 another language, but that will only find tags that exist in that
3478 language and not in the English help.
3479 Example: >
3480 :set helplang=de,it
3481< This will first search German, then Italian and finally English help
3482 files.
3483 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3484 try to find the tag in the current language before using this option.
3485 See |help-translated|.
3486
3487 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3488'hidden' 'hid' boolean (default off)
3489 global
3490 {not in Vi}
3491 When off a buffer is unloaded when it is |abandon|ed. When on a
3492 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3493 displayed in another window, it does not become hidden, of course.
3494 The commands that move through the buffer list sometimes make a buffer
3495 hidden although the 'hidden' option is off: When the buffer is
3496 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003497 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003498 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 This option is set for one command with ":hide {command}" |:hide|.
3500 WARNING: It's easy to forget that you have changes in hidden buffers.
3501 Think twice when using ":q!" or ":qa!".
3502
3503 *'highlight'* *'hl'*
3504'highlight' 'hl' string (default (as a single string):
3505 "8:SpecialKey,@:NonText,d:Directory,
3506 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3507 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003508 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3510 f:Folded,F:FoldColumn,A:DiffAdd,
3511 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003512 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003513 R:SpellRare,L:SpellLocal,
3514 +:Pmenu,=:PmenuSel,
3515 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003516 global
3517 {not in Vi}
3518 This option can be used to set highlighting mode for various
3519 occasions. It is a comma separated list of character pairs. The
3520 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003521 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3523 |hl-NonText| @ '~' and '@' at the end of the window and
3524 characters from 'showbreak'
3525 |hl-Directory| d directories in CTRL-D listing and other special
3526 things in listings
3527 |hl-ErrorMsg| e error messages
3528 h (obsolete, ignored)
3529 |hl-IncSearch| i 'incsearch' highlighting
3530 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3531 |hl-MoreMsg| m |more-prompt|
3532 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
3533 |hl-LineNr| n line number for ":number" and ":#" commands
3534 |hl-Question| r |hit-enter| prompt and yes/no questions
3535 |hl-StatusLine| s status line of current window |status-line|
3536 |hl-StatusLineNC| S status lines of not-current windows
3537 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3538 |hl-VertSplit| c column used to separate vertically split windows
3539 |hl-Visual| v Visual mode
3540 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3541 Selection" Only X11 Gui's |gui-x11| and
3542 |xterm-clipboard|.
3543 |hl-WarningMsg| w warning messages
3544 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3545 |hl-Folded| f line used for closed folds
3546 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003547 |hl-DiffAdd| A added line in diff mode
3548 |hl-DiffChange| C changed line in diff mode
3549 |hl-DiffDelete| D deleted line in diff mode
3550 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003552 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003553 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003554 |hl-SpellRare| R rare word |spell|
3555 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003556 |hl-Pmenu| + popup menu normal line
3557 |hl-PmenuSel| = popup menu normal line
3558 |hl-PmenuSbar| x popup menu scrollbar
3559 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560
3561 The display modes are:
3562 r reverse (termcap entry "mr" and "me")
3563 i italic (termcap entry "ZH" and "ZR")
3564 b bold (termcap entry "md" and "me")
3565 s standout (termcap entry "so" and "se")
3566 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003567 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 n no highlighting
3569 - no highlighting
3570 : use a highlight group
3571 The default is used for occasions that are not included.
3572 If you want to change what the display modes do, see |dos-colors|
3573 for an example.
3574 When using the ':' display mode, this must be followed by the name of
3575 a highlight group. A highlight group can be used to define any type
3576 of highlighting, including using color. See |:highlight| on how to
3577 define one. The default uses a different group for each occasion.
3578 See |highlight-default| for the default highlight groups.
3579
3580 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3581'hlsearch' 'hls' boolean (default off)
3582 global
3583 {not in Vi}
3584 {not available when compiled without the
3585 |+extra_search| feature}
3586 When there is a previous search pattern, highlight all its matches.
3587 The type of highlighting used can be set with the 'l' occasion in the
3588 'highlight' option. This uses the "Search" highlight group by
3589 default. Note that only the matching text is highlighted, any offsets
3590 are not applied.
3591 See also: 'incsearch' and |:match|.
3592 When you get bored looking at the highlighted matches, you can turn it
3593 off with |:nohlsearch|. As soon as you use a search command, the
3594 highlighting comes back.
3595 When the search pattern can match an end-of-line, Vim will try to
3596 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003597 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003599 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 NOTE: This option is reset when 'compatible' is set.
3601
3602 *'history'* *'hi'*
3603'history' 'hi' number (Vim default: 20, Vi default: 0)
3604 global
3605 {not in Vi}
3606 A history of ":" commands, and a history of previous search patterns
3607 are remembered. This option decides how many entries may be stored in
3608 each of these histories (see |cmdline-editing|).
3609 NOTE: This option is set to the Vi default value when 'compatible' is
3610 set and to the Vim default value when 'compatible' is reset.
3611
3612 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3613'hkmap' 'hk' boolean (default off)
3614 global
3615 {not in Vi}
3616 {only available when compiled with the |+rightleft|
3617 feature}
3618 When on, the keyboard is mapped for the Hebrew character set.
3619 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3620 toggle this option. See |rileft.txt|.
3621 NOTE: This option is reset when 'compatible' is set.
3622
3623 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3624'hkmapp' 'hkp' boolean (default off)
3625 global
3626 {not in Vi}
3627 {only available when compiled with the |+rightleft|
3628 feature}
3629 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3630 This is useful if you have a non-Hebrew keyboard.
3631 See |rileft.txt|.
3632 NOTE: This option is reset when 'compatible' is set.
3633
3634 *'icon'* *'noicon'*
3635'icon' boolean (default off, on when title can be restored)
3636 global
3637 {not in Vi}
3638 {not available when compiled without the |+title|
3639 feature}
3640 When on, the icon text of the window will be set to the value of
3641 'iconstring' (if it is not empty), or to the name of the file
3642 currently being edited. Only the last part of the name is used.
3643 Overridden by the 'iconstring' option.
3644 Only works if the terminal supports setting window icons (currently
3645 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3646 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3647 builtin termcap).
3648 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003649 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003650 X11.
3651
3652 *'iconstring'*
3653'iconstring' string (default "")
3654 global
3655 {not in Vi}
3656 {not available when compiled without the |+title|
3657 feature}
3658 When this option is not empty, it will be used for the icon text of
3659 the window. This happens only when the 'icon' option is on.
3660 Only works if the terminal supports setting window icon text
3661 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3662 Does not work for MS Windows.
3663 When Vim was compiled with HAVE_X11 defined, the original icon will be
3664 restored if possible |X11|.
3665 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003666 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 'titlestring' for example settings.
3668 {not available when compiled without the |+statusline| feature}
3669
3670 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3671'ignorecase' 'ic' boolean (default off)
3672 global
3673 Ignore case in search patterns. Also used when searching in the tags
3674 file.
3675 Also see 'smartcase'.
3676 Can be overruled by using "\c" or "\C" in the pattern, see
3677 |/ignorecase|.
3678
3679 *'imactivatekey'* *'imak'*
3680'imactivatekey' 'imak' string (default "")
3681 global
3682 {not in Vi}
3683 {only available when compiled with |+xim| and
3684 |+GUI_GTK|}
3685 Specifies the key that your Input Method in X-Windows uses for
3686 activation. When this is specified correctly, vim can fully control
3687 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3688 You can't use this option to change the activation key, the option
3689 tells Vim what the key is.
3690 Format:
3691 [MODIFIER_FLAG-]KEY_STRING
3692
3693 These characters can be used for MODIFIER_FLAG (case is ignored):
3694 S Shift key
3695 L Lock key
3696 C Control key
3697 1 Mod1 key
3698 2 Mod2 key
3699 3 Mod3 key
3700 4 Mod4 key
3701 5 Mod5 key
3702 Combinations are allowed, for example "S-C-space" or "SC-space" are
3703 both shift+ctrl+space.
3704 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3705
3706 Example: >
3707 :set imactivatekey=S-space
3708< "S-space" means shift+space. This is the activation key for kinput2 +
3709 canna (Japanese), and ami (Korean).
3710
3711 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3712'imcmdline' 'imc' boolean (default off)
3713 global
3714 {not in Vi}
3715 {only available when compiled with the |+xim|
3716 |+multi_byte_ime| or |global-ime| feature}
3717 When set the Input Method is always on when starting to edit a command
3718 line, unless entering a search pattern (see 'imsearch' for that).
3719 Setting this option is useful when your input method allows entering
3720 English characters directly, e.g., when it's used to type accented
3721 characters with dead keys.
3722
3723 *'imdisable'* *'imd'* *'nodisable'* *'noimd'*
3724'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3725 global
3726 {not in Vi}
3727 {only available when compiled with the |+xim|
3728 |+multi_byte_ime| or |global-ime| feature}
3729 When set the Input Method is never used. This is useful to disable
3730 the IM when it doesn't work properly.
3731 Currently this option is on by default for SGI/IRIX machines. This
3732 may change in later releases.
3733
3734 *'iminsert'* *'imi'*
3735'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3736 local to buffer
3737 {not in Vi}
3738 Specifies whether :lmap or an Input Method (IM) is to be used in
3739 Insert mode. Valid values:
3740 0 :lmap is off and IM is off
3741 1 :lmap is ON and IM is off
3742 2 :lmap is off and IM is ON
3743 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3744 or |global-ime|.
3745 To always reset the option to zero when leaving Insert mode with <Esc>
3746 this can be used: >
3747 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3748< This makes :lmap and IM turn off automatically when leaving Insert
3749 mode.
3750 Note that this option changes when using CTRL-^ in Insert mode
3751 |i_CTRL-^|.
3752 The value is set to 1 when setting 'keymap' to a valid keymap name.
3753 It is also used for the argument of commands like "r" and "f".
3754 The value 0 may not work correctly with Athena and Motif with some XIM
3755 methods. Use 'imdisable' to disable XIM then.
3756
3757 *'imsearch'* *'ims'*
3758'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3759 local to buffer
3760 {not in Vi}
3761 Specifies whether :lmap or an Input Method (IM) is to be used when
3762 entering a search pattern. Valid values:
3763 -1 the value of 'iminsert' is used, makes it look like
3764 'iminsert' is also used when typing a search pattern
3765 0 :lmap is off and IM is off
3766 1 :lmap is ON and IM is off
3767 2 :lmap is off and IM is ON
3768 Note that this option changes when using CTRL-^ in Command-line mode
3769 |c_CTRL-^|.
3770 The value is set to 1 when it is not -1 and setting the 'keymap'
3771 option to a valid keymap name.
3772 The value 0 may not work correctly with Athena and Motif with some XIM
3773 methods. Use 'imdisable' to disable XIM then.
3774
3775 *'include'* *'inc'*
3776'include' 'inc' string (default "^\s*#\s*include")
3777 global or local to buffer |global-local|
3778 {not in Vi}
3779 {not available when compiled without the
3780 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003781 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 pattern, just like for the "/" command (See |pattern|). The default
3783 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003784 "]I", "[d", etc.
3785 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003786 comes after the matched pattern. But if "\zs" appears in the pattern
3787 then the text matched from "\zs" to the end, or until "\ze" if it
3788 appears, is used as the file name. Use this to include characters
3789 that are not in 'isfname', such as a space. You can then use
3790 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003791 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792
3793 *'includeexpr'* *'inex'*
3794'includeexpr' 'inex' string (default "")
3795 local to buffer
3796 {not in Vi}
3797 {not available when compiled without the
3798 |+find_in_path| or |+eval| feature}
3799 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003800 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 :set includeexpr=substitute(v:fname,'\\.','/','g')
3802< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003803
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003805 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 Also used for |<cfile>|.
3807
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003808 The expression may be evaluated in the |sandbox|, see
3809 |sandbox-option|.
3810
3811 It is not allowed to change text or jump to another window while
3812 evaluating 'includeexpr' |textlock|.
3813
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3815'incsearch' 'is' boolean (default off)
3816 global
3817 {not in Vi}
3818 {not available when compiled without the
3819 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003820 While typing a search command, show where the pattern, as it was typed
3821 so far, matches. The matched string is highlighted. If the pattern
3822 is invalid or not found, nothing is shown. The screen will be updated
3823 often, this is only useful on fast terminals.
3824 Note that the match will be shown, but the cursor will return to its
3825 original position when no match is found and when pressing <Esc>. You
3826 still need to finish the search command with <Enter> to move the
3827 cursor to the match.
3828 The highlighting can be set with the 'i' flag in 'highlight'.
3829 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003830 CTRL-L can be used to add one character from after the current match
3831 to the command line.
3832 CTRL-R CTRL-W can be used to add the word at the end of the current
3833 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 NOTE: This option is reset when 'compatible' is set.
3835
3836 *'indentexpr'* *'inde'*
3837'indentexpr' 'inde' string (default "")
3838 local to buffer
3839 {not in Vi}
3840 {not available when compiled without the |+cindent|
3841 or |+eval| features}
3842 Expression which is evaluated to obtain the proper indent for a line.
3843 It is used when a new line is created, for the |=| operator and
3844 in Insert mode as specified with the 'indentkeys' option.
3845 When this option is not empty, it overrules the 'cindent' and
3846 'smartindent' indenting.
3847 When 'paste' is set this option is not used for indenting.
3848 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003849 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003850 when the expression is evaluated (but it may be moved around).
3851 The expression must return the number of spaces worth of indent. It
3852 can return "-1" to keep the current indent (this means 'autoindent' is
3853 used for the indent).
3854 Functions useful for computing the indent are |indent()|, |cindent()|
3855 and |lispindent()|.
3856 The evaluation of the expression must not have side effects! It must
3857 not change the text, jump to another window, etc. Afterwards the
3858 cursor position is always restored, thus the cursor may be moved.
3859 Normally this option would be set to call a function: >
3860 :set indentexpr=GetMyIndent()
3861< Error messages will be suppressed, unless the 'debug' option contains
3862 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003863 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003864 NOTE: This option is made empty when 'compatible' is set.
3865
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003866 The expression may be evaluated in the |sandbox|, see
3867 |sandbox-option|.
3868
3869 It is not allowed to change text or jump to another window while
3870 evaluating 'indentexpr' |textlock|.
3871
3872
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873 *'indentkeys'* *'indk'*
3874'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3875 local to buffer
3876 {not in Vi}
3877 {not available when compiled without the |+cindent|
3878 feature}
3879 A list of keys that, when typed in Insert mode, cause reindenting of
3880 the current line. Only happens if 'indentexpr' isn't empty.
3881 The format is identical to 'cinkeys', see |indentkeys-format|.
3882 See |C-indenting| and |indent-expression|.
3883
3884 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3885'infercase' 'inf' boolean (default off)
3886 local to buffer
3887 {not in Vi}
3888 When doing keyword completion in insert mode |ins-completion|, and
3889 'ignorecase' is also on, the case of the match is adjusted. If the
3890 typed text contains a lowercase letter where the match has an upper
3891 case letter, the completed part is made lowercase. If the typed text
3892 has no lowercase letters and the match has a lowercase letter where
3893 the typed text has an uppercase letter, and there is a letter before
3894 it, the completed part is made uppercase.
3895
3896 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3897'insertmode' 'im' boolean (default off)
3898 global
3899 {not in Vi}
3900 Makes Vim work in a way that Insert mode is the default mode. Useful
3901 if you want to use Vim as a modeless editor. Used for |evim|.
3902 These Insert mode commands will be useful:
3903 - Use the cursor keys to move around.
3904 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3905 this is a mapping, it is executed as if 'insertmode' was off.
3906 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003907 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003908 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3909 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003910
3911 These items change when 'insertmode' is set:
3912 - when starting to edit of a file, Vim goes to Insert mode.
3913 - <Esc> in Insert mode is a no-op and beeps.
3914 - <Esc> in Normal mode makes Vim go to Insert mode.
3915 - CTRL-L in Insert mode is a command, it is not inserted.
3916 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
3917 However, when <Esc> is used inside a mapping, it behaves like
3918 'insertmode' was not set. This was done to be able to use the same
3919 mappings with 'insertmode' set or not set.
3920 When executing commands with |:normal| 'insertmode' is not used.
3921
3922 NOTE: This option is reset when 'compatible' is set.
3923
3924 *'isfname'* *'isf'*
3925'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
3926 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
3927 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
3928 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
3929 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
3930 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
3931 global
3932 {not in Vi}
3933 The characters specified by this option are included in file names and
3934 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003935 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 Multi-byte characters 256 and above are always included, only the
3937 characters up to 255 are specified with this option.
3938 For UTF-8 the characters 0xa0 to 0xff are included as well.
3939
3940 Note that on systems using a backslash as path separator, Vim tries to
3941 do its best to make it work as you would expect. That is a bit
3942 tricky, since Vi originally used the backslash to escape special
3943 characters. Vim will not remove a backslash in front of a normal file
3944 name character on these systems, but it will on Unix and alikes. The
3945 '&' and '^' are not included by default, because these are special for
3946 cmd.exe.
3947
3948 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003949 Each part can be a single character number or a range. A range is two
3950 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 decimal number between 0 and 255 or the ASCII character itself (does
3952 not work for digits). Example:
3953 "_,-,128-140,#-43" (include '_' and '-' and the range
3954 128 to 140 and '#' to 43)
3955 If a part starts with '^', the following character number or range
3956 will be excluded from the option. The option is interpreted from left
3957 to right. Put the excluded character after the range where it is
3958 included. To include '^' itself use it as the last character of the
3959 option or the end of a range. Example:
3960 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
3961 If the character is '@', all characters where isalpha() returns TRUE
3962 are included. Normally these are the characters a to z and A to Z,
3963 plus accented characters. To include '@' itself use "@-@". Examples:
3964 "@,^a-z" All alphabetic characters, excluding lower
3965 case letters.
3966 "a-z,A-Z,@-@" All letters plus the '@' character.
3967 A comma can be included by using it where a character number is
3968 expected. Example:
3969 "48-57,,,_" Digits, comma and underscore.
3970 A comma can be excluded by prepending a '^'. Example:
3971 " -~,^,,9" All characters from space to '~', excluding
3972 comma, plus <Tab>.
3973 See |option-backslash| about including spaces and backslashes.
3974
3975 *'isident'* *'isi'*
3976'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
3977 "@,48-57,_,128-167,224-235"
3978 otherwise: "@,48-57,_,192-255")
3979 global
3980 {not in Vi}
3981 The characters given by this option are included in identifiers.
3982 Identifiers are used in recognizing environment variables and after a
3983 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00003984 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00003985 option.
3986 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003987 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003988 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
3989
3990 *'iskeyword'* *'isk'*
3991'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
3992 "@,48-57,_,128-167,224-235"
3993 otherwise: "@,48-57,_,192-255"
3994 Vi default: "@,48-57,_")
3995 local to buffer
3996 {not in Vi}
3997 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003998 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003999 'isfname' for a description of the format of this option. For C
4000 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4001 For a help file it is set to all non-blank printable characters except
4002 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4003 command).
4004 When the 'lisp' option is on the '-' character is always included.
4005 NOTE: This option is set to the Vi default value when 'compatible' is
4006 set and to the Vim default value when 'compatible' is reset.
4007
4008 *'isprint'* *'isp'*
4009'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4010 "@,~-255"; otherwise: "@,161-255")
4011 global
4012 {not in Vi}
4013 The characters given by this option are displayed directly on the
4014 screen. It is also used for "\p" in a |pattern|. The characters from
4015 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4016 even when they are not included in 'isprint' or excluded. See
4017 'isfname' for a description of the format of this option.
4018
4019 Non-printable characters are displayed with two characters:
4020 0 - 31 "^@" - "^_"
4021 32 - 126 always single characters
4022 127 "^?"
4023 128 - 159 "~@" - "~_"
4024 160 - 254 "| " - "|~"
4025 255 "~?"
4026 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4027 displayed as <xx>, with the hexadecimal value of the byte.
4028 When 'display' contains "uhex" all unprintable characters are
4029 displayed as <xx>.
4030 The NonText highlighting will be used for unprintable characters.
4031 |hl-NonText|
4032
4033 Multi-byte characters 256 and above are always included, only the
4034 characters up to 255 are specified with this option. When a character
4035 is printable but it is not available in the current font, a
4036 replacement character will be shown.
4037 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4038 There is no option to specify these characters.
4039
4040 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4041'joinspaces' 'js' boolean (default on)
4042 global
4043 {not in Vi}
4044 Insert two spaces after a '.', '?' and '!' with a join command.
4045 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4046 Otherwise only one space is inserted.
4047 NOTE: This option is set when 'compatible' is set.
4048
4049 *'key'*
4050'key' string (default "")
4051 local to buffer
4052 {not in Vi}
4053 The key that is used for encrypting and decrypting the current buffer.
4054 See |encryption|.
4055 Careful: Do not set the key value by hand, someone might see the typed
4056 key. Use the |:X| command. But you can make 'key' empty: >
4057 :set key=
4058< It is not possible to get the value of this option with ":set key" or
4059 "echo &key". This is to avoid showing it to someone who shouldn't
4060 know. It also means you cannot see it yourself once you have set it,
4061 be careful not to make a typing error!
4062
4063 *'keymap'* *'kmp'* *E544*
4064'keymap' 'kmp' string (default "")
4065 local to buffer
4066 {not in Vi}
4067 {only available when compiled with the |+keymap|
4068 feature}
4069 Name of a keyboard mapping. See |mbyte-keymap|.
4070 Setting this option to a valid keymap name has the side effect of
4071 setting 'iminsert' to one, so that the keymap becomes effective.
4072 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004073 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074
4075 *'keymodel'* *'km'*
4076'keymodel' 'km' string (default "")
4077 global
4078 {not in Vi}
4079 List of comma separated words, which enable special things that keys
4080 can do. These values can be used:
4081 startsel Using a shifted special key starts selection (either
4082 Select mode or Visual mode, depending on "key" being
4083 present in 'selectmode').
4084 stopsel Using a not-shifted special key stops selection.
4085 Special keys in this context are the cursor keys, <End>, <Home>,
4086 <PageUp> and <PageDown>.
4087 The 'keymodel' option is set by the |:behave| command.
4088
4089 *'keywordprg'* *'kp'*
4090'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4091 OS/2: "view /", VMS: "help")
4092 global or local to buffer |global-local|
4093 {not in Vi}
4094 Program to use for the |K| command. Environment variables are
4095 expanded |:set_env|. ":help" may be used to access the Vim internal
4096 help. (Note that previously setting the global option to the empty
4097 value did this, which is now deprecated.)
4098 When "man" is used, Vim will automatically translate a count for the
4099 "K" command to a section number. Also for "man -s", in which case the
4100 "-s" is removed when there is no count.
4101 See |option-backslash| about including spaces and backslashes.
4102 Example: >
4103 :set keywordprg=man\ -s
4104< This option cannot be set from a |modeline| or in the |sandbox|, for
4105 security reasons.
4106
4107 *'langmap'* *'lmap'* *E357* *E358*
4108'langmap' 'lmap' string (default "")
4109 global
4110 {not in Vi}
4111 {only available when compiled with the |+langmap|
4112 feature}
4113 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004114 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 inserted directly. When in command mode the 'langmap' option takes
4116 care of translating these special characters to the original meaning
4117 of the key. This means you don't have to change the keyboard mode to
4118 be able to execute Normal mode commands.
4119 This is the opposite of the 'keymap' option, where characters are
4120 mapped in Insert mode.
4121 This only works for 8-bit characters. The value of 'langmap' may be
4122 specified with multi-byte characters (e.g., UTF-8), but only the lower
4123 8 bits of each character will be used.
4124
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004125 Example (for Greek, in UTF-8): *greek* >
4126 :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 +00004127< Example (exchanges meaning of z and y for commands): >
4128 :set langmap=zy,yz,ZY,YZ
4129<
4130 The 'langmap' option is a list of parts, separated with commas. Each
4131 part can be in one of two forms:
4132 1. A list of pairs. Each pair is a "from" character immediately
4133 followed by the "to" character. Examples: "aA", "aAbBcC".
4134 2. A list of "from" characters, a semi-colon and a list of "to"
4135 characters. Example: "abc;ABC"
4136 Example: "aA,fgh;FGH,cCdDeE"
4137 Special characters need to be preceded with a backslash. These are
4138 ";", ',' and backslash itself.
4139
4140 This will allow you to activate vim actions without having to switch
4141 back and forth between the languages. Your language characters will
4142 be understood as normal vim English characters (according to the
4143 langmap mappings) in the following cases:
4144 o Normal/Visual mode (commands, buffer/register names, user mappings)
4145 o Insert/Replace Mode: Register names after CTRL-R
4146 o Insert/Replace Mode: Mappings
4147 Characters entered in Command-line mode will NOT be affected by
4148 this option. Note that this option can be changed at any time
4149 allowing to switch between mappings for different languages/encodings.
4150 Use a mapping to avoid having to type it each time!
4151
4152 *'langmenu'* *'lm'*
4153'langmenu' 'lm' string (default "")
4154 global
4155 {not in Vi}
4156 {only available when compiled with the |+menu| and
4157 |+multi_lang| features}
4158 Language to use for menu translation. Tells which file is loaded
4159 from the "lang" directory in 'runtimepath': >
4160 "lang/menu_" . &langmenu . ".vim"
4161< (without the spaces). For example, to always use the Dutch menus, no
4162 matter what $LANG is set to: >
4163 :set langmenu=nl_NL.ISO_8859-1
4164< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004165 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004166 If your $LANG is set to a non-English language but you do want to use
4167 the English menus: >
4168 :set langmenu=none
4169< This option must be set before loading menus, switching on filetype
4170 detection or syntax highlighting. Once the menus are defined setting
4171 this option has no effect. But you could do this: >
4172 :source $VIMRUNTIME/delmenu.vim
4173 :set langmenu=de_DE.ISO_8859-1
4174 :source $VIMRUNTIME/menu.vim
4175< Warning: This deletes all menus that you defined yourself!
4176
4177 *'laststatus'* *'ls'*
4178'laststatus' 'ls' number (default 1)
4179 global
4180 {not in Vi}
4181 The value of this option influences when the last window will have a
4182 status line:
4183 0: never
4184 1: only if there are at least two windows
4185 2: always
4186 The screen looks nicer with a status line if you have several
4187 windows, but it takes another screen line. |status-line|
4188
4189 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4190'lazyredraw' 'lz' boolean (default off)
4191 global
4192 {not in Vi}
4193 When this option is set, the screen will not be redrawn while
4194 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004195 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 update use |:redraw|.
4197
4198 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4199'linebreak' 'lbr' boolean (default off)
4200 local to window
4201 {not in Vi}
4202 {not available when compiled without the |+linebreak|
4203 feature}
4204 If on Vim will wrap long lines at a character in 'breakat' rather
4205 than at the last character that fits on the screen. Unlike
4206 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4207 it only affects the way the file is displayed, not its contents. The
4208 value of 'showbreak' is used to put in front of wrapped lines.
4209 This option is not used when the 'wrap' option is off or 'list' is on.
4210 Note that <Tab> characters after an <EOL> are mostly not displayed
4211 with the right amount of white space.
4212
4213 *'lines'* *E593*
4214'lines' number (default 24 or terminal height)
4215 global
4216 Number of lines of the Vim window.
4217 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004218 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004219 When Vim is running in the GUI or in a resizable window, setting this
4220 option will cause the window size to be changed. When you only want
4221 to use the size for the GUI, put the command in your |gvimrc| file.
4222 Vim limits the number of lines to what fits on the screen. You can
4223 use this command to get the tallest window possible: >
4224 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004225< Minimum value is 2, maximum value is 1000.
4226 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004227 When you set this option and Vim is unable to change the physical
4228 number of lines of the display, the display may be messed up.
4229
4230 *'linespace'* *'lsp'*
4231'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4232 global
4233 {not in Vi}
4234 {only in the GUI}
4235 Number of pixel lines inserted between characters. Useful if the font
4236 uses the full character cell height, making lines touch each other.
4237 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004238 With some fonts there can be too much room between lines (to have
4239 space for ascents and descents). Then it makes sense to set
4240 'linespace' to a negative value. This may cause display problems
4241 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004242
4243 *'lisp'* *'nolisp'*
4244'lisp' boolean (default off)
4245 local to buffer
4246 {not available when compiled without the |+lispindent|
4247 feature}
4248 Lisp mode: When <Enter> is typed in insert mode set the indent for
4249 the next line to Lisp standards (well, sort of). Also happens with
4250 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4251 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4252 better. Also see 'lispwords'.
4253 The '-' character is included in keyword characters. Redefines the
4254 "=" operator to use this same indentation algorithm rather than
4255 calling an external program if 'equalprg' is empty.
4256 This option is not used when 'paste' is set.
4257 {Vi: Does it a little bit differently}
4258
4259 *'lispwords'* *'lw'*
4260'lispwords' 'lw' string (default is very long)
4261 global
4262 {not in Vi}
4263 {not available when compiled without the |+lispindent|
4264 feature}
4265 Comma separated list of words that influence the Lisp indenting.
4266 |'lisp'|
4267
4268 *'list'* *'nolist'*
4269'list' boolean (default off)
4270 local to window
4271 List mode: Show tabs as CTRL-I, show end of line with $. Useful to
4272 see the difference between tabs and spaces and for trailing blanks.
4273 Note that this will also affect formatting (set with 'textwidth' or
4274 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
4275 changing the way tabs are displayed.
4276
4277 *'listchars'* *'lcs'*
4278'listchars' 'lcs' string (default "eol:$")
4279 global
4280 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004281 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 settings.
4283 eol:c Character to show at the end of each line. When
4284 omitted, there is no extra character at the end of the
4285 line.
4286 tab:xy Two characters to be used to show a Tab. The first
4287 char is used once. The second char is repeated to
4288 fill the space that the Tab normally occupies.
4289 "tab:>-" will show a Tab that takes four spaces as
4290 ">---". When omitted, a Tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004291 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 trailing spaces are blank.
4293 extends:c Character to show in the last column, when 'wrap' is
4294 off and the line continues beyond the right of the
4295 screen.
4296 precedes:c Character to show in the first column, when 'wrap'
4297 is off and there is text preceding the character
4298 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004299 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004300 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004301
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004302 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004303 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004304 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305
4306 Examples: >
4307 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004308 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 :set lcs=extends:>,precedes:<
4310< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004311 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004312
4313 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4314'loadplugins' 'lpl' boolean (default on)
4315 global
4316 {not in Vi}
4317 When on the plugin scripts are loaded when starting up |load-plugins|.
4318 This option can be reset in your |vimrc| file to disable the loading
4319 of plugins.
4320 Note that using the "-u NONE" and "--noplugin" command line arguments
4321 reset this option. |-u| |--noplugin|
4322
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004323 *'macatsui'* *'nomacatsui'*
4324'macatsui' boolean (default on)
4325 global
4326 {only available in Mac GUI version}
4327 This is a workaround for when drawing doesn't work properly. When set
4328 and compiled with multi-byte support ATSUI text drawing is used. When
4329 not set ATSUI text drawing is not used. Switch this option off when
4330 you experience drawing problems. In a future version the problems may
4331 be solved and this option becomes obsolete. Therefore use this method
4332 to unset it: >
4333 if exists('&macatsui')
4334 set nomacatsui
4335 endif
4336<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 *'magic'* *'nomagic'*
4338'magic' boolean (default on)
4339 global
4340 Changes the special characters that can be used in search patterns.
4341 See |pattern|.
4342 NOTE: To avoid portability problems with using patterns, always keep
4343 this option at the default "on". Only switch it off when working with
4344 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004345 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004346
4347 *'makeef'* *'mef'*
4348'makeef' 'mef' string (default: "")
4349 global
4350 {not in Vi}
4351 {not available when compiled without the |+quickfix|
4352 feature}
4353 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4354 and the |:grep| command.
4355 When it is empty, an internally generated temp file will be used.
4356 When "##" is included, it is replaced by a number to make the name
4357 unique. This makes sure that the ":make" command doesn't overwrite an
4358 existing file.
4359 NOT used for the ":cf" command. See 'errorfile' for that.
4360 Environment variables are expanded |:set_env|.
4361 See |option-backslash| about including spaces and backslashes.
4362 This option cannot be set from a |modeline| or in the |sandbox|, for
4363 security reasons.
4364
4365 *'makeprg'* *'mp'*
4366'makeprg' 'mp' string (default "make", VMS: "MMS")
4367 global or local to buffer |global-local|
4368 {not in Vi}
4369 Program to use for the ":make" command. See |:make_makeprg|. This
4370 option may contain '%' and '#' characters, which are expanded like
4371 when used in a command-line. Environment variables are expanded
4372 |:set_env|. See |option-backslash| about including spaces and
4373 backslashes. Note that a '|' must be escaped twice: once for ":set"
4374 and once for the interpretation of a command. When you use a filter
4375 called "myfilter" do it like this: >
4376 :set makeprg=gmake\ \\\|\ myfilter
4377< The placeholder "$*" can be given (even multiple times) to specify
4378 where the arguments will be included, for example: >
4379 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4380< This option cannot be set from a |modeline| or in the |sandbox|, for
4381 security reasons.
4382
4383 *'matchpairs'* *'mps'*
4384'matchpairs' 'mps' string (default "(:),{:},[:]")
4385 local to buffer
4386 {not in Vi}
4387 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004388 other. Currently only single character pairs are allowed, and they
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 must be different. The characters must be separated by a colon. The
4390 pairs must be separated by a comma. Example for including '<' and '>'
4391 (HTML): >
4392 :set mps+=<:>
4393
4394< A more exotic example, to jump between the '=' and ';' in an
4395 assignment, useful for languages like C and Java: >
4396 :au FileType c,cpp,java set mps+==:;
4397
4398< For a more advanced way of using "%", see the matchit.vim plugin in
4399 the $VIMRUNTIME/macros directory. |add-local-help|
4400
4401 *'matchtime'* *'mat'*
4402'matchtime' 'mat' number (default 5)
4403 global
4404 {not in Vi}{in Nvi}
4405 Tenths of a second to show the matching paren, when 'showmatch' is
4406 set. Note that this is not in milliseconds, like other options that
4407 set a time. This is to be compatible with Nvi.
4408
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004409 *'maxcombine'* *'mco'*
4410'maxcombine' 'mco' number (default 2)
4411 global
4412 {not in Vi}
4413 {only available when compiled with the |+multi_byte|
4414 feature}
4415 The maximum number of combining characters supported for displaying.
4416 Only used when 'encoding' is "utf-8".
4417 The default is OK for most languages. Hebrew may require 4.
4418 Maximum value is 6.
4419 Even when this option is set to 2 you can still edit text with more
4420 combining characters, you just can't see them. Use |g8| or |ga|.
4421 See |mbyte-combining|.
4422
Bram Moolenaar071d4272004-06-13 20:20:40 +00004423 *'maxfuncdepth'* *'mfd'*
4424'maxfuncdepth' 'mfd' number (default 100)
4425 global
4426 {not in Vi}
4427 Maximum depth of function calls for user functions. This normally
4428 catches endless recursion. When using a recursive function with
4429 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4430 more memory, there is the danger of failing when memory is exhausted.
4431 See also |:function|.
4432
4433 *'maxmapdepth'* *'mmd'* *E223*
4434'maxmapdepth' 'mmd' number (default 1000)
4435 global
4436 {not in Vi}
4437 Maximum number of times a mapping is done without resulting in a
4438 character to be used. This normally catches endless mappings, like
4439 ":map x y" with ":map y x". It still does not catch ":map g wg",
4440 because the 'w' is used before the next mapping is done. See also
4441 |key-mapping|.
4442
4443 *'maxmem'* *'mm'*
4444'maxmem' 'mm' number (default between 256 to 5120 (system
4445 dependent) or half the amount of memory
4446 available)
4447 global
4448 {not in Vi}
4449 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4450 limit is reached allocating extra memory for a buffer will cause
4451 other memory to be freed. Maximum value 2000000. Use this to work
4452 without a limit. Also see 'maxmemtot'.
4453
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004454 *'maxmempattern'* *'mmp'*
4455'maxmempattern' 'mmp' number (default 1000)
4456 global
4457 {not in Vi}
4458 Maximum amount of memory (in Kbyte) to use for pattern matching.
4459 Maximum value 2000000. Use this to work without a limit.
4460 *E363*
4461 When Vim runs into the limit it gives an error message mostly behaves
4462 like CTRL-C was typed.
4463 Running into the limit often means that the pattern is very
4464 inefficient or too complex. This may already happen with the pattern
4465 "\(.\)*" on a very long line. ".*" works much better.
4466 Vim may run out of memory before hitting the 'maxmempattern' limit.
4467
Bram Moolenaar071d4272004-06-13 20:20:40 +00004468 *'maxmemtot'* *'mmt'*
4469'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4470 dependent) or half the amount of memory
4471 available)
4472 global
4473 {not in Vi}
4474 Maximum amount of memory (in Kbyte) to use for all buffers together.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004475 Maximum value 2000000. Use this to work without a limit. Also see
Bram Moolenaar071d4272004-06-13 20:20:40 +00004476 'maxmem'.
4477
4478 *'menuitems'* *'mis'*
4479'menuitems' 'mis' number (default 25)
4480 global
4481 {not in Vi}
4482 {not available when compiled without the |+menu|
4483 feature}
4484 Maximum number of items to use in a menu. Used for menus that are
4485 generated from a list of items, e.g., the Buffers menu. Changing this
4486 option has no direct effect, the menu must be refreshed first.
4487
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004488 *'mkspellmem'* *'msm'*
4489'mkspellmem' 'msm' string (default "460000,2000,500")
4490 global
4491 {not in Vi}
4492 {not available when compiled without the |+syntax|
4493 feature}
4494 Parameters for |:mkspell|. This tunes when to start compressing the
4495 word tree. Compression can be slow when there are many words, but
4496 it's needed to avoid running out of memory. The amount of memory used
4497 per word depends very much on how similar the words are, that's why
4498 this tuning is complicated.
4499
4500 There are three numbers, separated by commas:
4501 {start},{inc},{added}
4502
4503 For most languages the uncompressed word tree fits in memory. {start}
4504 gives the amount of memory in Kbyte that can be used before any
4505 compression is done. It should be a bit smaller than the amount of
4506 memory that is available to Vim.
4507
4508 When going over the {start} limit the {inc} number specifies the
4509 amount of memory in Kbyte that can be allocated before another
4510 compression is done. A low number means compression is done after
4511 less words are added, which is slow. A high number means more memory
4512 will be allocated.
4513
4514 After doing compression, {added} times 1024 words can be added before
4515 the {inc} limit is ignored and compression is done when any extra
4516 amount of memory is needed. A low number means there is a smaller
4517 chance of hitting the {inc} limit, less memory is used but it's
4518 slower.
4519
4520 The languages for which these numbers are important are Italian and
4521 Hungarian. The default works for when you have about 512 Mbyte. If
4522 you have 1 Gbyte you could use: >
4523 :set mkspellmem=900000,3000,800
4524< If you have less than 512 Mbyte |:mkspell| may fail for some
4525 languages, no matter what you set 'mkspellmem' to.
4526
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004528'modeline' 'ml' boolean (Vim default: on (off for root),
4529 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 local to buffer
4531 *'modelines'* *'mls'*
4532'modelines' 'mls' number (default 5)
4533 global
4534 {not in Vi}
4535 If 'modeline' is on 'modelines' gives the number of lines that is
4536 checked for set commands. If 'modeline' is off or 'modelines' is zero
4537 no lines are checked. See |modeline|.
4538 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4539 set and to the Vim default value when 'compatible' is reset.
4540
4541 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4542'modifiable' 'ma' boolean (default on)
4543 local to buffer
4544 {not in Vi} *E21*
4545 When off the buffer contents cannot be changed. The 'fileformat' and
4546 'fileencoding' options also can't be changed.
4547 Can be reset with the |-M| command line argument.
4548
4549 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4550'modified' 'mod' boolean (default off)
4551 local to buffer
4552 {not in Vi}
4553 When on, the buffer is considered to be modified. This option is set
4554 when:
4555 1. A change was made to the text since it was last written. Using the
4556 |undo| command to go back to the original text will reset the
4557 option. But undoing changes that were made before writing the
4558 buffer will set the option again, since the text is different from
4559 when it was written.
4560 2. 'fileformat' or 'fileencoding' is different from its original
4561 value. The original value is set when the buffer is read or
4562 written. A ":set nomodified" command also resets the original
4563 values to the current values and the 'modified' option will be
4564 reset.
4565 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4566 will be ignored.
4567
4568 *'more'* *'nomore'*
4569'more' boolean (Vim default: on, Vi default: off)
4570 global
4571 {not in Vi}
4572 When on, listings pause when the whole screen is filled. You will get
4573 the |more-prompt|. When this option is off there are no pauses, the
4574 listing continues until finished.
4575 NOTE: This option is set to the Vi default value when 'compatible' is
4576 set and to the Vim default value when 'compatible' is reset.
4577
4578 *'mouse'* *E538*
4579'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4580 global
4581 {not in Vi}
4582 Enable the use of the mouse. Only works for certain terminals
4583 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, and Linux console
4584 with gpm). For using the mouse in the GUI, see |gui-mouse|.
4585 The mouse can be enabled for different modes:
4586 n Normal mode
4587 v Visual mode
4588 i Insert mode
4589 c Command-line mode
4590 h all previous modes when editing a help file
4591 a all previous modes
4592 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 Normally you would enable the mouse in all four modes with: >
4594 :set mouse=a
4595< When the mouse is not enabled, the GUI will still use the mouse for
4596 modeless selection. This doesn't move the text cursor.
4597
4598 See |mouse-using|. Also see |'clipboard'|.
4599
4600 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004601 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 the mouse buttons can still be used by keeping the shift key pressed.
4603 Also see the 'clipboard' option.
4604
4605 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4606'mousefocus' 'mousef' boolean (default off)
4607 global
4608 {not in Vi}
4609 {only works in the GUI}
4610 The window that the mouse pointer is on is automatically activated.
4611 When changing the window layout or window focus in another way, the
4612 mouse pointer is moved to the window with keyboard focus. Off is the
4613 default because it makes using the pull down menus a little goofy, as
4614 a pointer transit may activate a window unintentionally.
4615
4616 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4617'mousehide' 'mh' boolean (default on)
4618 global
4619 {not in Vi}
4620 {only works in the GUI}
4621 When on, the mouse pointer is hidden when characters are typed.
4622 The mouse pointer is restored when the mouse is moved.
4623
4624 *'mousemodel'* *'mousem'*
4625'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4626 global
4627 {not in Vi}
4628 Sets the model to use for the mouse. The name mostly specifies what
4629 the right mouse button is used for:
4630 extend Right mouse button extends a selection. This works
4631 like in an xterm.
4632 popup Right mouse button pops up a menu. The shifted left
4633 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004634 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004635 popup_setpos Like "popup", but the cursor will be moved to the
4636 position where the mouse was clicked, and thus the
4637 selected operation will act upon the clicked object.
4638 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004639 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004640 course, that right clicking outside a selection will
4641 end Visual mode.
4642 Overview of what button does what for each model:
4643 mouse extend popup(_setpos) ~
4644 left click place cursor place cursor
4645 left drag start selection start selection
4646 shift-left search word extend selection
4647 right click extend selection popup menu (place cursor)
4648 right drag extend selection -
4649 middle click paste paste
4650
4651 In the "popup" model the right mouse button produces a pop-up menu.
4652 You need to define this first, see |popup-menu|.
4653
4654 Note that you can further refine the meaning of buttons with mappings.
4655 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4656 selection (because that's handled in the GUI code directly).
4657
4658 The 'mousemodel' option is set by the |:behave| command.
4659
4660 *'mouseshape'* *'mouses'* *E547*
4661'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004662 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004663 global
4664 {not in Vi}
4665 {only available when compiled with the |+mouseshape|
4666 feature}
4667 This option tells Vim what the mouse pointer should look like in
4668 different modes. The option is a comma separated list of parts, much
4669 like used for 'guicursor'. Each part consist of a mode/location-list
4670 and an argument-list:
4671 mode-list:shape,mode-list:shape,..
4672 The mode-list is a dash separated list of these modes/locations:
4673 In a normal window: ~
4674 n Normal mode
4675 v Visual mode
4676 ve Visual mode with 'selection' "exclusive" (same as 'v',
4677 if not specified)
4678 o Operator-pending mode
4679 i Insert mode
4680 r Replace mode
4681
4682 Others: ~
4683 c appending to the command-line
4684 ci inserting in the command-line
4685 cr replacing in the command-line
4686 m at the 'Hit ENTER' or 'More' prompts
4687 ml idem, but cursor in the last line
4688 e any mode, pointer below last window
4689 s any mode, pointer on a status line
4690 sd any mode, while dragging a status line
4691 vs any mode, pointer on a vertical separator line
4692 vd any mode, while dragging a vertical separator line
4693 a everywhere
4694
4695 The shape is one of the following:
4696 avail name looks like ~
4697 w x arrow Normal mouse pointer
4698 w x blank no pointer at all (use with care!)
4699 w x beam I-beam
4700 w x updown up-down sizing arrows
4701 w x leftright left-right sizing arrows
4702 w x busy The system's usual busy pointer
4703 w x no The system's usual 'no input' pointer
4704 x udsizing indicates up-down resizing
4705 x lrsizing indicates left-right resizing
4706 x crosshair like a big thin +
4707 x hand1 black hand
4708 x hand2 white hand
4709 x pencil what you write with
4710 x question big ?
4711 x rightup-arrow arrow pointing right-up
4712 w x up-arrow arrow pointing up
4713 x <number> any X11 pointer number (see X11/cursorfont.h)
4714
4715 The "avail" column contains a 'w' if the shape is available for Win32,
4716 x for X11.
4717 Any modes not specified or shapes not available use the normal mouse
4718 pointer.
4719
4720 Example: >
4721 :set mouseshape=s:udsizing,m:no
4722< will make the mouse turn to a sizing arrow over the status lines and
4723 indicate no input when the hit-enter prompt is displayed (since
4724 clicking the mouse has no effect in this state.)
4725
4726 *'mousetime'* *'mouset'*
4727'mousetime' 'mouset' number (default 500)
4728 global
4729 {not in Vi}
4730 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4731 time in msec between two mouse clicks for the second click to be
4732 recognized as a multi click.
4733
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004734 *'mzquantum'* *'mzq'*
4735'mzquantum' 'mzq' number (default 100)
4736 global
4737 {not in Vi}
4738 {not available when compiled without the |+mzscheme|
4739 feature}
4740 The number of milliseconds between polls for MzScheme threads.
4741 Negative or zero value means no thread scheduling.
4742
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 *'nrformats'* *'nf'*
4744'nrformats' 'nf' string (default "octal,hex")
4745 local to buffer
4746 {not in Vi}
4747 This defines what bases Vim will consider for numbers when using the
4748 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4749 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004750 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 incremented or decremented. This is useful for a list with a
4752 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004753 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004754 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004755 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004756 considered to be hexadecimal. Example: Using CTRL-X on
4757 "0x100" results in "0x0ff".
4758 Numbers which simply begin with a digit in the range 1-9 are always
4759 considered decimal. This also happens for numbers that are not
4760 recognized as octal or hex.
4761
4762 *'number'* *'nu'* *'nonumber'* *'nonu'*
4763'number' 'nu' boolean (default off)
4764 local to window
4765 Print the line number in front of each line. When the 'n' option is
4766 excluded from 'cpoptions' a wrapped line will not use the column of
4767 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004768 The 'numberwidth' option can be used to set the room used for the line
4769 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 When a long, wrapped line doesn't start with the first character, '-'
4771 characters are put before the number.
4772 See |hl-LineNr| for the highlighting used for the number.
4773
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004774 *'numberwidth'* *'nuw'*
4775'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4776 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004777 {not in Vi}
4778 {only available when compiled with the |+linebreak|
4779 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004780 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar5e3cb7e2006-02-27 23:58:35 +00004781 when the 'number' option is set or printing lines with a line number.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004782 Since one space is always between the number and the text, there is
4783 one less character for the number itself.
4784 The value is the minimum width. A bigger width is used when needed to
4785 fit the highest line number in the buffer. Thus with the Vim default
4786 of 4 there is room for a line number up to 999. When the buffer has
4787 1000 lines five columns will be used.
4788 The minimum value is 1, the maximum value is 10.
4789 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4790
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004791 *'omnifunc'* *'ofu'*
4792'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004793 local to buffer
4794 {not in Vi}
4795 {not available when compiled without the +eval
4796 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004797 This option specifies a function to be used for Insert mode omni
4798 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004799 See |complete-functions| for an explanation of how the function is
4800 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004801 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004802 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004803
4804
Bram Moolenaar043545e2006-10-10 16:44:07 +00004805 *'opendevice* *'odev* *'noopendevice* *'noodev*
4806'opendevice' 'odev' boolean (default off)
4807 global
4808 {not in Vi}
4809 {only for MS-DOS, MS-Windows and OS/2}
4810 Enable reading and writing from devices. This may get Vim stuck on a
4811 device that can be opened but doesn't actually do the I/O. Therefore
4812 it is off by default.
4813 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4814 result in editing a device.
4815
4816
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004817 *'operatorfunc'* *'opfunc'*
4818'operatorfunc' 'opfunc' string (default: empty)
4819 global
4820 {not in Vi}
4821 This option specifies a function to be called by the |g@| operator.
4822 See |:map-operator| for more info and an example.
4823
4824 This option cannot be set from a |modeline| or in the |sandbox|, for
4825 security reasons.
4826
4827
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 *'osfiletype'* *'oft'* *E366*
4829'osfiletype' 'oft' string (RISC-OS default: "Text",
4830 others default: "")
4831 local to buffer
4832 {not in Vi}
4833 {only available when compiled with the |+osfiletype|
4834 feature}
4835 Some operating systems store extra information about files besides
4836 name, datestamp and permissions. This option contains the extra
4837 information, the nature of which will vary between systems.
4838 The value of this option is usually set when the file is loaded, and
4839 use to set the file type when file is written.
4840 It can affect the pattern matching of the automatic commands.
4841 |autocmd-osfiletypes|
4842
4843 *'paragraphs'* *'para'*
4844'paragraphs' 'para' string (default "IPLPPPQPP LIpplpipbp")
4845 global
4846 Specifies the nroff macros that separate paragraphs. These are pairs
4847 of two letters (see |object-motions|).
4848
4849 *'paste'* *'nopaste'*
4850'paste' boolean (default off)
4851 global
4852 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004853 Put Vim in Paste mode. This is useful if you want to cut or copy
4854 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 unexpected effects.
4856 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004857 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004858 knows about pasting and will mostly do the right thing without 'paste'
4859 being set. The same is true for a terminal where Vim handles the
4860 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004861 This option is reset when starting the GUI. Thus if you set it in
4862 your .vimrc it will work in a terminal, but not in the GUI. Setting
4863 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4864 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004865 When the 'paste' option is switched on (also when it was already on):
4866 - mapping in Insert mode and Command-line mode is disabled
4867 - abbreviations are disabled
4868 - 'textwidth' is set to 0
4869 - 'wrapmargin' is set to 0
4870 - 'autoindent' is reset
4871 - 'smartindent' is reset
4872 - 'softtabstop' is set to 0
4873 - 'revins' is reset
4874 - 'ruler' is reset
4875 - 'showmatch' is reset
4876 - 'formatoptions' is used like it is empty
4877 These options keep their value, but their effect is disabled:
4878 - 'lisp'
4879 - 'indentexpr'
4880 - 'cindent'
4881 NOTE: When you start editing another file while the 'paste' option is
4882 on, settings from the modelines or autocommands may change the
4883 settings again, causing trouble when pasting text. You might want to
4884 set the 'paste' option again.
4885 When the 'paste' option is reset the mentioned options are restored to
4886 the value before the moment 'paste' was switched from off to on.
4887 Resetting 'paste' before ever setting it does not have any effect.
4888 Since mapping doesn't work while 'paste' is active, you need to use
4889 the 'pastetoggle' option to toggle the 'paste' option with some key.
4890
4891 *'pastetoggle'* *'pt'*
4892'pastetoggle' 'pt' string (default "")
4893 global
4894 {not in Vi}
4895 When non-empty, specifies the key sequence that toggles the 'paste'
4896 option. This is like specifying a mapping: >
4897 :map {keys} :set invpaste<CR>
4898< Where {keys} is the value of 'pastetoggle'.
4899 The difference is that it will work even when 'paste' is set.
4900 'pastetoggle' works in Insert mode and Normal mode, but not in
4901 Command-line mode.
4902 Mappings are checked first, thus overrule 'pastetoggle'. However,
4903 when 'paste' is on mappings are ignored in Insert mode, thus you can do
4904 this: >
4905 :map <F10> :set paste<CR>
4906 :map <F11> :set nopaste<CR>
4907 :imap <F10> <C-O>:set paste<CR>
4908 :imap <F11> <nop>
4909 :set pastetoggle=<F11>
4910< This will make <F10> start paste mode and <F11> stop paste mode.
4911 Note that typing <F10> in paste mode inserts "<F10>", since in paste
4912 mode everything is inserted literally, except the 'pastetoggle' key
4913 sequence.
4914
4915 *'pex'* *'patchexpr'*
4916'patchexpr' 'pex' string (default "")
4917 global
4918 {not in Vi}
4919 {not available when compiled without the |+diff|
4920 feature}
4921 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004922 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923
4924 *'patchmode'* *'pm'* *E206*
4925'patchmode' 'pm' string (default "")
4926 global
4927 {not in Vi}
4928 When non-empty the oldest version of a file is kept. This can be used
4929 to keep the original version of a file if you are changing files in a
4930 source distribution. Only the first time that a file is written a
4931 copy of the original file will be kept. The name of the copy is the
4932 name of the original file with the string in the 'patchmode' option
4933 appended. This option should start with a dot. Use a string like
4934 ".org". 'backupdir' must not be empty for this to work (Detail: The
4935 backup file is renamed to the patchmode file after the new file has
4936 been successfully written, that's why it must be possible to write a
4937 backup file). If there was no file to be backed up, an empty file is
4938 created.
4939 When the 'backupskip' pattern matches, a patchmode file is not made.
4940 Using 'patchmode' for compressed files appends the extension at the
4941 end (e.g., "file.gz.orig"), thus the resulting name isn't always
4942 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004943 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004944
4945 *'path'* *'pa'* *E343* *E345* *E347*
4946'path' 'pa' string (default on Unix: ".,/usr/include,,"
4947 on OS/2: ".,/emx/include,,"
4948 other systems: ".,,")
4949 global or local to buffer |global-local|
4950 {not in Vi}
4951 This is a list of directories which will be searched when using the
4952 |gf|, [f, ]f, ^Wf, |:find| and other commands, provided that the file
4953 being searched for has a relative path (not starting with '/'). The
4954 directories in the 'path' option may be relative or absolute.
4955 - Use commas to separate directory names: >
4956 :set path=.,/usr/local/include,/usr/include
4957< - Spaces can also be used to separate directory names (for backwards
4958 compatibility with version 3.0). To have a space in a directory
4959 name, precede it with an extra backslash, and escape the space: >
4960 :set path=.,/dir/with\\\ space
4961< - To include a comma in a directory name precede it with an extra
4962 backslash: >
4963 :set path=.,/dir/with\\,comma
4964< - To search relative to the directory of the current file, use: >
4965 :set path=.
4966< - To search in the current directory use an empty string between two
4967 commas: >
4968 :set path=,,
4969< - A directory name may end in a ':' or '/'.
4970 - Environment variables are expanded |:set_env|.
4971 - When using |netrw.vim| URLs can be used. For example, adding
4972 "http://www.vim.org" will make ":find index.html" work.
4973 - Search upwards and downwards in a directory tree:
4974 1) "*" matches a sequence of characters, e.g.: >
4975 :set path=/usr/include/*
4976< means all subdirectories in /usr/include (but not /usr/include
4977 itself). >
4978 :set path=/usr/*c
4979< matches /usr/doc and /usr/src.
4980 2) "**" matches a subtree, up to 100 directories deep. Example: >
4981 :set path=/home/user_x/src/**
4982< means search in the whole subtree under "/home/usr_x/src".
4983 3) If the path ends with a ';', this path is the startpoint
4984 for upward search.
4985 See |file-searching| for more info and exact syntax.
4986 {not available when compiled without the |+path_extra| feature}
4987 - Careful with '\' characters, type two to get one in the option: >
4988 :set path=.,c:\\include
4989< Or just use '/' instead: >
4990 :set path=.,c:/include
4991< Don't forget "." or files won't even be found in the same directory as
4992 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004993 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00004994 it is something like 256 or 1024 characters.
4995 You can check if all the include files are found, using the value of
4996 'path', see |:checkpath|.
4997 The use of |:set+=| and |:set-=| is preferred when adding or removing
4998 directories from the list. This avoids problems when a future version
4999 uses another default. To remove the current directory use: >
5000 :set path-=
5001< To add the current directory use: >
5002 :set path+=
5003< To use an environment variable, you probably need to replace the
5004 separator. Here is an example to append $INCL, in which directory
5005 names are separated with a semi-colon: >
5006 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5007< Replace the ';' with a ':' or whatever separator is used. Note that
5008 this doesn't work when $INCL contains a comma or white space.
5009
5010 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5011'preserveindent' 'pi' boolean (default off)
5012 local to buffer
5013 {not in Vi}
5014 When changing the indent of the current line, preserve as much of the
5015 indent structure as possible. Normally the indent is replaced by a
5016 series of tabs followed by spaces as required (unless |'expandtab'| is
5017 enabled, in which case only spaces are used). Enabling this option
5018 means the indent will preserve as many existing characters as possible
5019 for indenting, and only add additional tabs or spaces as required.
5020 NOTE: When using ">>" multiple times the resulting indent is a mix of
5021 tabs and spaces. You might not like this.
5022 NOTE: 'preserveindent' is reset when 'compatible' is set.
5023 Also see 'copyindent'.
5024 Use |:retab| to clean up white space.
5025
5026 *'previewheight'* *'pvh'*
5027'previewheight' 'pvh' number (default 12)
5028 global
5029 {not in Vi}
5030 {not available when compiled without the |+windows| or
5031 |+quickfix| feature}
5032 Default height for a preview window. Used for |:ptag| and associated
5033 commands. Used for |CTRL-W_}| when no count is given.
5034
5035 *'previewwindow'* *'nopreviewwindow'*
5036 *'pvw'* *'nopvw'* *E590*
5037'previewwindow' 'pvw' boolean (default off)
5038 local to window
5039 {not in Vi}
5040 {not available when compiled without the |+windows| or
5041 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005042 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 set. It's normally not set directly, but by using one of the commands
5044 |:ptag|, |:pedit|, etc.
5045
5046 *'printdevice'* *'pdev'*
5047'printdevice' 'pdev' string (default empty)
5048 global
5049 {not in Vi}
5050 {only available when compiled with the |+printer|
5051 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005052 The name of the printer to be used for |:hardcopy|.
5053 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005054 This option cannot be set from a |modeline| or in the |sandbox|, for
5055 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056
Bram Moolenaar8299df92004-07-10 09:47:34 +00005057 *'printencoding'* *'penc'*
5058'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 global
5060 {not in Vi}
5061 {only available when compiled with the |+printer|
5062 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005063 Sets the character encoding used when printing.
5064 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005065
5066 *'printexpr'* *'pexpr'*
5067'printexpr' 'pexpr' String (default: see below)
5068 global
5069 {not in Vi}
5070 {only available when compiled with the |+printer|
5071 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005072 Expression used to print the PostScript produced with |:hardcopy|.
5073 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
Bram Moolenaar8299df92004-07-10 09:47:34 +00005075 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005076'printfont' 'pfn' string (default "courier")
5077 global
5078 {not in Vi}
5079 {only available when compiled with the |+printer|
5080 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005081 The name of the font that will be used for |:hardcopy|.
5082 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005083
5084 *'printheader'* *'pheader'*
5085'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5086 global
5087 {not in Vi}
5088 {only available when compiled with the |+printer|
5089 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005090 The format of the header produced in |:hardcopy| output.
5091 See |pheader-option|.
5092
5093 *'printmbcharset'* *'pmbcs'*
5094'printmbcharset' 'pmbcs' string (default "")
5095 global
5096 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005097 {only available when compiled with the |+printer|,
5098 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005099 The CJK character set to be used for CJK output from |:hardcopy|.
5100 See |pmbcs-option|.
5101
5102 *'printmbfont'* *'pmbfn'*
5103'printmbfont' 'pmbfn' string (default "")
5104 global
5105 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005106 {only available when compiled with the |+printer|,
5107 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005108 List of font names to be used for CJK output from |:hardcopy|.
5109 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005110
5111 *'printoptions'* *'popt'*
5112'printoptions' 'popt' string (default "")
5113 global
5114 {not in Vi}
5115 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005116 List of items that control the format of the output of |:hardcopy|.
5117 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005119 *'prompt'* *'noprompt'*
5120'prompt' boolean (default on)
5121 global
5122 When on a ":" prompt is used in Ex mode.
5123
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005124 *'pumheight'* *'ph'*
5125'pumheight' 'ph' number (default 0)
5126 global
5127 {not available when compiled without the
5128 |+insert_expand| feature}
5129 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005130 Determines the maximum number of items to show in the popup menu for
5131 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005132 |ins-completion-menu|.
5133
5134
Bram Moolenaar677ee682005-01-27 14:41:15 +00005135 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005136'quoteescape' 'qe' string (default "\")
5137 local to buffer
5138 {not in Vi}
5139 The characters that are used to escape quotes in a string. Used for
5140 objects like a', a" and a` |a'|.
5141 When one of the characters in this option is found inside a string,
5142 the following character will be skipped. The default value makes the
5143 text "foo\"bar\\" considered to be one string.
5144
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5146'readonly' 'ro' boolean (default off)
5147 local to buffer
5148 If on, writes fail unless you use a '!'. Protects you from
5149 accidentally overwriting a file. Default on when Vim is started
5150 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005151 When using ":w!" the 'readonly' option is reset for the current
5152 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005154 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155
5156 *'remap'* *'noremap'*
5157'remap' boolean (default on)
5158 global
5159 Allows for mappings to work recursively. If you do not want this for
5160 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005161 NOTE: To avoid portability problems with Vim scripts, always keep
5162 this option at the default "on". Only switch it off when working with
5163 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165 *'report'*
5166'report' number (default 2)
5167 global
5168 Threshold for reporting number of lines changed. When the number of
5169 changed lines is more than 'report' a message will be given for most
5170 ":" commands. If you want it always, set 'report' to 0.
5171 For the ":substitute" command the number of substitutions is used
5172 instead of the number of lines.
5173
5174 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5175'restorescreen' 'rs' boolean (default on)
5176 global
5177 {not in Vi} {only in Windows 95/NT console version}
5178 When set, the screen contents is restored when exiting Vim. This also
5179 happens when executing external commands.
5180
5181 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5182 options in your .vimrc. To disable restoring:
5183 set t_ti= t_te=
5184 To enable restoring (for an xterm):
5185 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5186 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5187
5188 *'revins'* *'ri'* *'norevins'* *'nori'*
5189'revins' 'ri' boolean (default off)
5190 global
5191 {not in Vi}
5192 {only available when compiled with the |+rightleft|
5193 feature}
5194 Inserting characters in Insert mode will work backwards. See "typing
5195 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5196 command in Insert mode, when 'allowrevins' is set.
5197 NOTE: This option is reset when 'compatible' or 'paste' is set.
5198
5199 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5200'rightleft' 'rl' boolean (default off)
5201 local to window
5202 {not in Vi}
5203 {only available when compiled with the |+rightleft|
5204 feature}
5205 When on, display orientation becomes right-to-left, i.e., characters
5206 that are stored in the file appear from the right to the left.
5207 Using this option, it is possible to edit files for languages that
5208 are written from the right to the left such as Hebrew and Arabic.
5209 This option is per window, so it is possible to edit mixed files
5210 simultaneously, or to view the same file in both ways (this is
5211 useful whenever you have a mixed text file with both right-to-left
5212 and left-to-right strings so that both sets are displayed properly
5213 in different windows). Also see |rileft.txt|.
5214
5215 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5216'rightleftcmd' 'rlc' string (default "search")
5217 local to window
5218 {not in Vi}
5219 {only available when compiled with the |+rightleft|
5220 feature}
5221 Each word in this option enables the command line editing to work in
5222 right-to-left mode for a group of commands:
5223
5224 search "/" and "?" commands
5225
5226 This is useful for languages such as Hebrew, Arabic and Farsi.
5227 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5228
5229 *'ruler'* *'ru'* *'noruler'* *'noru'*
5230'ruler' 'ru' boolean (default off)
5231 global
5232 {not in Vi}
5233 {not available when compiled without the
5234 |+cmdline_info| feature}
5235 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005236 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005237 text in the file is shown on the far right:
5238 Top first line is visible
5239 Bot last line is visible
5240 All first and last line are visible
5241 45% relative position in the file
5242 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005243 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005245 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005246 this option takes precedence over 'ruler' and 'rulerformat'
5247 If the number of characters displayed is different from the number of
5248 bytes in the text (e.g., for a TAB or a multi-byte character), both
5249 the text column (byte number) and the screen column are shown,
5250 separated with a dash.
5251 For an empty line "0-1" is shown.
5252 For an empty buffer the line number will also be zero: "0,0-1".
5253 This option is reset when the 'paste' option is set.
5254 If you don't want to see the ruler all the time but want to know where
5255 you are, use "g CTRL-G" |g_CTRL-G|.
5256 NOTE: This option is reset when 'compatible' is set.
5257
5258 *'rulerformat'* *'ruf'*
5259'rulerformat' 'ruf' string (default empty)
5260 global
5261 {not in Vi}
5262 {not available when compiled without the |+statusline|
5263 feature}
5264 When this option is not empty, it determines the content of the ruler
5265 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005266 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005267 The default ruler width is 17 characters. To make the ruler 15
5268 characters wide, put "%15(" at the start and "%)" at the end.
5269 Example: >
5270 :set rulerformat=%15(%c%V\ %p%%%)
5271<
5272 *'runtimepath'* *'rtp'* *vimfiles*
5273'runtimepath' 'rtp' string (default:
5274 Unix: "$HOME/.vim,
5275 $VIM/vimfiles,
5276 $VIMRUNTIME,
5277 $VIM/vimfiles/after,
5278 $HOME/.vim/after"
5279 Amiga: "home:vimfiles,
5280 $VIM/vimfiles,
5281 $VIMRUNTIME,
5282 $VIM/vimfiles/after,
5283 home:vimfiles/after"
5284 PC, OS/2: "$HOME/vimfiles,
5285 $VIM/vimfiles,
5286 $VIMRUNTIME,
5287 $VIM/vimfiles/after,
5288 $HOME/vimfiles/after"
5289 Macintosh: "$VIM:vimfiles,
5290 $VIMRUNTIME,
5291 $VIM:vimfiles:after"
5292 RISC-OS: "Choices:vimfiles,
5293 $VIMRUNTIME,
5294 Choices:vimfiles/after"
5295 VMS: "sys$login:vimfiles,
5296 $VIM/vimfiles,
5297 $VIMRUNTIME,
5298 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005299 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 global
5301 {not in Vi}
5302 This is a list of directories which will be searched for runtime
5303 files:
5304 filetype.vim filetypes by file name |new-filetype|
5305 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005306 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307 colors/ color scheme files |:colorscheme|
5308 compiler/ compiler files |:compiler|
5309 doc/ documentation |write-local-help|
5310 ftplugin/ filetype plugins |write-filetype-plugin|
5311 indent/ indent scripts |indent-expression|
5312 keymap/ key mapping files |mbyte-keymap|
5313 lang/ menu translations |:menutrans|
5314 menu.vim GUI menus |menu.vim|
5315 plugin/ plugin scripts |write-plugin|
5316 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005317 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318 syntax/ syntax files |mysyntaxfile|
5319 tutor/ files for vimtutor |tutor|
5320
5321 And any other file searched for with the |:runtime| command.
5322
5323 The defaults for most systems are setup to search five locations:
5324 1. In your home directory, for your personal preferences.
5325 2. In a system-wide Vim directory, for preferences from the system
5326 administrator.
5327 3. In $VIMRUNTIME, for files distributed with Vim.
5328 *after-directory*
5329 4. In the "after" directory in the system-wide Vim directory. This is
5330 for the system administrator to overrule or add to the distributed
5331 defaults (rarely needed)
5332 5. In the "after" directory in your home directory. This is for
5333 personal preferences to overrule or add to the distributed defaults
5334 or system-wide settings (rarely needed).
5335
5336 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5337 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005338 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005339 wildcards.
5340 See |:runtime|.
5341 Example: >
5342 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5343< This will use the directory "~/vimruntime" first (containing your
5344 personal Vim runtime files), then "/mygroup/vim" (shared between a
5345 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5346 files).
5347 You probably should always include $VIMRUNTIME somewhere, to use the
5348 distributed runtime files. You can put a directory before $VIMRUNTIME
5349 to find files which replace a distributed runtime files. You can put
5350 a directory after $VIMRUNTIME to find files which add to distributed
5351 runtime files.
5352 This option cannot be set from a |modeline| or in the |sandbox|, for
5353 security reasons.
5354
5355 *'scroll'* *'scr'*
5356'scroll' 'scr' number (default: half the window height)
5357 local to window
5358 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5359 set to half the number of lines in the window when the window size
5360 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005361 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5363 the number of screen lines instead of file lines, makes a difference
5364 when lines wrap}
5365
5366 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5367'scrollbind' 'scb' boolean (default off)
5368 local to window
5369 {not in Vi}
5370 {not available when compiled without the |+scrollbind|
5371 feature}
5372 See also |scroll-binding|. When this option is set, the current
5373 window scrolls as other scrollbind windows (windows that also have
5374 this option set) scroll. This option is useful for viewing the
5375 differences between two versions of a file, see 'diff'.
5376 See |'scrollopt'| for options that determine how this option should be
5377 interpreted.
5378 This option is mostly reset when splitting a window to edit another
5379 file. This means that ":split | edit file" results in two windows
5380 with scroll-binding, but ":split file" does not.
5381
5382 *'scrolljump'* *'sj'*
5383'scrolljump' 'sj' number (default 1)
5384 global
5385 {not in Vi}
5386 Minimal number of lines to scroll when the cursor gets off the
5387 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5388 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005389 When set to a negative number from -1 to -100 this is used as the
5390 percentage of the window height. Thus -50 scrolls half the window
5391 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005392 NOTE: This option is set to 1 when 'compatible' is set.
5393
5394 *'scrolloff'* *'so'*
5395'scrolloff' 'so' number (default 0)
5396 global
5397 {not in Vi}
5398 Minimal number of screen lines to keep above and below the cursor.
5399 This will make some context visible around where you are working. If
5400 you set it to a very large value (999) the cursor line will always be
5401 in the middle of the window (except at the start or end of the file or
5402 when long lines wrap).
5403 For scrolling horizontally see 'sidescrolloff'.
5404 NOTE: This option is set to 0 when 'compatible' is set.
5405
5406 *'scrollopt'* *'sbo'*
5407'scrollopt' 'sbo' string (default "ver,jump")
5408 global
5409 {not available when compiled without the |+scrollbind|
5410 feature}
5411 {not in Vi}
5412 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005413 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5414 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 The following words are available:
5416 ver Bind vertical scrolling for 'scrollbind' windows
5417 hor Bind horizontal scrolling for 'scrollbind' windows
5418 jump Applies to the offset between two windows for vertical
5419 scrolling. This offset is the difference in the first
5420 displayed line of the bound windows. When moving
5421 around in a window, another 'scrollbind' window may
5422 reach a position before the start or after the end of
5423 the buffer. The offset is not changed though, when
5424 moving back the 'scrollbind' window will try to scroll
5425 to the desired position when possible.
5426 When now making that window the current one, two
5427 things can be done with the relative offset:
5428 1. When "jump" is not included, the relative offset is
5429 adjusted for the scroll position in the new current
5430 window. When going back to the other window, the
5431 the new relative offset will be used.
5432 2. When "jump" is included, the other windows are
5433 scrolled to keep the same relative offset. When
5434 going back to the other window, it still uses the
5435 same relative offset.
5436 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005437 When 'diff' mode is active there always is vertical scroll binding,
5438 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439
5440 *'sections'* *'sect'*
5441'sections' 'sect' string (default "SHNHH HUnhsh")
5442 global
5443 Specifies the nroff macros that separate sections. These are pairs of
5444 two letters (See |object-motions|). The default makes a section start
5445 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5446
5447 *'secure'* *'nosecure'* *E523*
5448'secure' boolean (default off)
5449 global
5450 {not in Vi}
5451 When on, ":autocmd", shell and write commands are not allowed in
5452 ".vimrc" and ".exrc" in the current directory and map commands are
5453 displayed. Switch it off only if you know that you will not run into
5454 problems, or when the 'exrc' option is off. On Unix this option is
5455 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005456 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005457 'secure' at the end of your ~/.vimrc then.
5458 This option cannot be set from a |modeline| or in the |sandbox|, for
5459 security reasons.
5460
5461 *'selection'* *'sel'*
5462'selection' 'sel' string (default "inclusive")
5463 global
5464 {not in Vi}
5465 This option defines the behavior of the selection. It is only used
5466 in Visual and Select mode.
5467 Possible values:
5468 value past line inclusive ~
5469 old no yes
5470 inclusive yes yes
5471 exclusive yes no
5472 "past line" means that the cursor is allowed to be positioned one
5473 character past the line.
5474 "inclusive" means that the last character of the selection is included
5475 in an operation. For example, when "x" is used to delete the
5476 selection.
5477 Note that when "exclusive" is used and selecting from the end
5478 backwards, you cannot include the last character of a line, when
5479 starting in Normal mode and 'virtualedit' empty.
5480
5481 The 'selection' option is set by the |:behave| command.
5482
5483 *'selectmode'* *'slm'*
5484'selectmode' 'slm' string (default "")
5485 global
5486 {not in Vi}
5487 This is a comma separated list of words, which specifies when to start
5488 Select mode instead of Visual mode, when a selection is started.
5489 Possible values:
5490 mouse when using the mouse
5491 key when using shifted special keys
5492 cmd when using "v", "V" or CTRL-V
5493 See |Select-mode|.
5494 The 'selectmode' option is set by the |:behave| command.
5495
5496 *'sessionoptions'* *'ssop'*
5497'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005498 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 global
5500 {not in Vi}
5501 {not available when compiled without the +mksession
5502 feature}
5503 Changes the effect of the |:mksession| command. It is a comma
5504 separated list of words. Each word enables saving and restoring
5505 something:
5506 word save and restore ~
5507 blank empty windows
5508 buffers hidden and unloaded buffers, not just those in windows
5509 curdir the current directory
5510 folds manually created folds, opened/closed folds and local
5511 fold options
5512 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005513 and contain at least one lowercase letter. Only
5514 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 help the help window
5516 localoptions options and mappings local to a window or buffer (not
5517 global values for local options)
5518 options all options and mappings (also global values for local
5519 options)
5520 resize size of the Vim window: 'lines' and 'columns'
5521 sesdir the directory in which the session file is located
5522 will become the current directory (useful with
5523 projects accessed over a network from different
5524 systems)
5525 slash backslashes in file names replaced with forward
5526 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005527 tabpages all tab pages; without this only the current tab page
5528 is restored, so that you can make a session for each
5529 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 unix with Unix end-of-line format (single <NL>), even when
5531 on Windows or DOS
5532 winpos position of the whole Vim window
5533 winsize window sizes
5534
5535 Don't include both "curdir" and "sesdir".
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00005536 There is no option to include tab pages yet, only the current tab page
5537 is stored in the session. |tab-page|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005538 When "curdir" nor "sesdir" is included, file names are stored with
5539 absolute paths.
5540 "slash" and "unix" are useful on Windows when sharing session files
5541 with Unix. The Unix version of Vim cannot source dos format scripts,
5542 but the Windows version of Vim can source unix format scripts.
5543
5544 *'shell'* *'sh'* *E91*
5545'shell' 'sh' string (default $SHELL or "sh",
5546 MS-DOS and Win32: "command.com" or
5547 "cmd.exe", OS/2: "cmd")
5548 global
5549 Name of the shell to use for ! and :! commands. When changing the
5550 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5551 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005552 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005553 See |option-backslash| about including spaces and backslashes.
5554 Environment variables are expanded |:set_env|.
5555 If the name of the shell contains a space, you might need to enclose
5556 it in quotes. Example: >
5557 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5558< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005559 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 "-f" is not inside the quotes, because it is not part of the command
5561 name. And Vim automagically recognizes the backslashes that are path
5562 separators.
5563 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5564 variable to change the way external commands are executed. See the
5565 libc.inf file of DJGPP.
5566 Under MS-Windows, when the executable ends in ".com" it must be
5567 included. Thus setting the shell to "command.com" or "4dos.com"
5568 works, but "command" and "4dos" do not work for all commands (e.g.,
5569 filtering).
5570 For unknown reasons, when using "4dos.com" the current directory is
5571 changed to "C:\". To avoid this set 'shell' like this: >
5572 :set shell=command.com\ /c\ 4dos
5573< This option cannot be set from a |modeline| or in the |sandbox|, for
5574 security reasons.
5575
5576 *'shellcmdflag'* *'shcf'*
5577'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5578 does not contain "sh" somewhere: "/c")
5579 global
5580 {not in Vi}
5581 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5582 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5583 systems, the default is set according to the value of 'shell', to
5584 reduce the need to set this option by the user. It's not used for
5585 OS/2 (EMX figures this out itself). See |option-backslash| about
5586 including spaces and backslashes. See |dos-shell|.
5587 This option cannot be set from a |modeline| or in the |sandbox|, for
5588 security reasons.
5589
5590 *'shellpipe'* *'sp'*
5591'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5592 global
5593 {not in Vi}
5594 {not available when compiled without the |+quickfix|
5595 feature}
5596 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005597 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 including spaces and backslashes.
5599 The name of the temporary file can be represented by "%s" if necessary
5600 (the file name is appended automatically if no %s appears in the value
5601 of this option).
5602 For the Amiga and MS-DOS the default is ">". The output is directly
5603 saved in a file and not echoed to the screen.
5604 For Unix the default it "| tee". The stdout of the compiler is saved
5605 in a file and echoed to the screen. If the 'shell' option is "csh" or
5606 "tcsh" after initializations, the default becomes "|& tee". If the
5607 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
5608 "2>&1| tee". This means that stderr is also included.
5609 The initialization of this option is done after reading the ".vimrc"
5610 and the other initializations, so that when the 'shell' option is set
5611 there, the 'shellpipe' option changes automatically, unless it was
5612 explicitly set before.
5613 When 'shellpipe' is set to an empty string, no redirection of the
5614 ":make" output will be done. This is useful if you use a 'makeprg'
5615 that writes to 'makeef' by itself. If you want no piping, but do
5616 want to include the 'makeef', set 'shellpipe' to a single space.
5617 Don't forget to precede the space with a backslash: ":set sp=\ ".
5618 In the future pipes may be used for filtering and this option will
5619 become obsolete (at least for Unix).
5620 This option cannot be set from a |modeline| or in the |sandbox|, for
5621 security reasons.
5622
5623 *'shellquote'* *'shq'*
5624'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5625 contains "sh" somewhere: "\"")
5626 global
5627 {not in Vi}
5628 Quoting character(s), put around the command passed to the shell, for
5629 the "!" and ":!" commands. The redirection is kept outside of the
5630 quoting. See 'shellxquote' to include the redirection. It's
5631 probably not useful to set both options.
5632 This is an empty string by default. Only known to be useful for
5633 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5634 or bash, where it should be "\"". The default is adjusted according
5635 the value of 'shell', to reduce the need to set this option by the
5636 user. See |dos-shell|.
5637 This option cannot be set from a |modeline| or in the |sandbox|, for
5638 security reasons.
5639
5640 *'shellredir'* *'srr'*
5641'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5642 global
5643 {not in Vi}
5644 String to be used to put the output of a filter command in a temporary
5645 file. See also |:!|. See |option-backslash| about including spaces
5646 and backslashes.
5647 The name of the temporary file can be represented by "%s" if necessary
5648 (the file name is appended automatically if no %s appears in the value
5649 of this option).
5650 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5651 or "zsh" during initializations, the default becomes ">&". If the
5652 'shell' option is "sh", "ksh" or "bash" the default becomes
5653 ">%s 2>&1". This means that stderr is also included.
5654 For Win32, the Unix checks are done and additionally "cmd" is checked
5655 for, which makes the default ">%s 2>&1". Also, the same names with
5656 ".exe" appended are checked for.
5657 The initialization of this option is done after reading the ".vimrc"
5658 and the other initializations, so that when the 'shell' option is set
5659 there, the 'shellredir' option changes automatically unless it was
5660 explicitly set before.
5661 In the future pipes may be used for filtering and this option will
5662 become obsolete (at least for Unix).
5663 This option cannot be set from a |modeline| or in the |sandbox|, for
5664 security reasons.
5665
5666 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5667'shellslash' 'ssl' boolean (default off)
5668 global
5669 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5670 When set, a forward slash is used when expanding file names. This is
5671 useful when a Unix-like shell is used instead of command.com or
5672 cmd.exe. Backward slashes can still be typed, but they are changed to
5673 forward slashes by Vim.
5674 Note that setting or resetting this option has no effect for some
5675 existing file names, thus this option needs to be set before opening
5676 any file for best results. This might change in the future.
5677 'shellslash' only works when a backslash can be used as a path
5678 separator. To test if this is so use: >
5679 if exists('+shellslash')
5680<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005681 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5682'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5683 global
5684 {not in Vi}
5685 When on, use temp files for shell commands. When off use a pipe.
5686 When using a pipe is not possible temp files are used anyway.
5687 Currently a pipe is only supported on Unix. You can check it with: >
5688 :if has("filterpipe")
5689< The advantage of using a pipe is that nobody can read the temp file
5690 and the 'shell' command does not need to support redirection.
5691 The advantage of using a temp file is that the file type and encoding
5692 can be detected.
5693 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5694 |FilterWritePost| autocommands event are not triggered when
5695 'shelltemp' is off.
5696
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 *'shelltype'* *'st'*
5698'shelltype' 'st' number (default 0)
5699 global
5700 {not in Vi} {only for the Amiga}
5701 On the Amiga this option influences the way how the commands work
5702 which use a shell.
5703 0 and 1: always use the shell
5704 2 and 3: use the shell only to filter lines
5705 4 and 5: use shell only for ':sh' command
5706 When not using the shell, the command is executed directly.
5707
5708 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5709 1 and 3: use "shell cmd" to start external commands
5710
5711 *'shellxquote'* *'sxq'*
5712'shellxquote' 'sxq' string (default: "";
5713 for Win32, when 'shell' contains "sh"
5714 somewhere: "\""
5715 for Unix, when using system(): "\"")
5716 global
5717 {not in Vi}
5718 Quoting character(s), put around the command passed to the shell, for
5719 the "!" and ":!" commands. Includes the redirection. See
5720 'shellquote' to exclude the redirection. It's probably not useful
5721 to set both options.
5722 This is an empty string by default. Known to be useful for
5723 third-party shells when using the Win32 version, such as the MKS Korn
5724 Shell or bash, where it should be "\"". The default is adjusted
5725 according the value of 'shell', to reduce the need to set this option
5726 by the user. See |dos-shell|.
5727 This option cannot be set from a |modeline| or in the |sandbox|, for
5728 security reasons.
5729
5730 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5731'shiftround' 'sr' boolean (default off)
5732 global
5733 {not in Vi}
5734 Round indent to multiple of 'shiftwidth'. Applies to > and <
5735 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5736 a multiple of 'shiftwidth' (this is Vi compatible).
5737 NOTE: This option is reset when 'compatible' is set.
5738
5739 *'shiftwidth'* *'sw'*
5740'shiftwidth' 'sw' number (default 8)
5741 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005742 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 |'cindent'|, |>>|, |<<|, etc.
5744
5745 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005746'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5747 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 global
5749 {not in Vi}
5750 This option helps to avoid all the |hit-enter| prompts caused by file
5751 messages, for example with CTRL-G, and to avoid some other messages.
5752 It is a list of flags:
5753 flag meaning when present ~
5754 f use "(3 of 5)" instead of "(file 3 of 5)"
5755 i use "[noeol]" instead of "[Incomplete last line]"
5756 l use "999L, 888C" instead of "999 lines, 888 characters"
5757 m use "[+]" instead of "[Modified]"
5758 n use "[New]" instead of "[New File]"
5759 r use "[RO]" instead of "[readonly]"
5760 w use "[w]" instead of "written" for file write message
5761 and "[a]" instead of "appended" for ':w >> file' command
5762 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5763 "[unix format]" and "[mac]" instead of "[mac format]".
5764 a all of the above abbreviations
5765
5766 o overwrite message for writing a file with subsequent message
5767 for reading a file (useful for ":wn" or when 'autowrite' on)
5768 O message for reading a file overwrites any previous message.
5769 Also for quickfix message (e.g., ":cn").
5770 s don't give "search hit BOTTOM, continuing at TOP" or "search
5771 hit TOP, continuing at BOTTOM" messages
5772 t truncate file message at the start if it is too long to fit
5773 on the command-line, "<" will appear in the left most column.
5774 Ignored in Ex mode.
5775 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005776 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 Ignored in Ex mode.
5778 W don't give "written" or "[w]" when writing a file
5779 A don't give the "ATTENTION" message when an existing swap file
5780 is found.
5781 I don't give the intro message when starting Vim |:intro|.
5782
5783 This gives you the opportunity to avoid that a change between buffers
5784 requires you to hit <Enter>, but still gives as useful a message as
5785 possible for the space available. To get the whole message that you
5786 would have got with 'shm' empty, use ":file!"
5787 Useful values:
5788 shm= No abbreviation of message.
5789 shm=a Abbreviation, but no loss of information.
5790 shm=at Abbreviation, and truncate message when necessary.
5791
5792 NOTE: This option is set to the Vi default value when 'compatible' is
5793 set and to the Vim default value when 'compatible' is reset.
5794
5795 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5796'shortname' 'sn' boolean (default off)
5797 local to buffer
5798 {not in Vi, not in MS-DOS versions}
5799 Filenames are assumed to be 8 characters plus one extension of 3
5800 characters. Multiple dots in file names are not allowed. When this
5801 option is on, dots in file names are replaced with underscores when
5802 adding an extension (".~" or ".swp"). This option is not available
5803 for MS-DOS, because then it would always be on. This option is useful
5804 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5805 or crossdos. When running the Win32 GUI version under Win32s, this
5806 option is always on by default.
5807
5808 *'showbreak'* *'sbr'* *E595*
5809'showbreak' 'sbr' string (default "")
5810 global
5811 {not in Vi}
5812 {not available when compiled without the |+linebreak|
5813 feature}
5814 String to put at the start of lines that have been wrapped. Useful
5815 values are "> " or "+++ ".
5816 Only printable single-cell characters are allowed, excluding <Tab> and
5817 comma (in a future version the comma might be used to separate the
5818 part that is shown at the end and at the start of a line).
5819 The characters are highlighted according to the '@' flag in
5820 'highlight'.
5821 Note that tabs after the showbreak will be displayed differently.
5822 If you want the 'showbreak' to appear in between line numbers, add the
5823 "n" flag to 'cpoptions'.
5824
5825 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5826'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5827 off)
5828 global
5829 {not in Vi}
5830 {not available when compiled without the
5831 |+cmdline_info| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005832 Show (partial) command in status line. Set this option off if your
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 terminal is slow.
5834 In Visual mode the size of the selected area is shown:
5835 - When selecting characters within a line, the number of characters.
5836 - When selecting more than one line, the number of lines.
5837 - When selecting a block, the size in screen characters: linesxcolumns.
5838 NOTE: This option is set to the Vi default value when 'compatible' is
5839 set and to the Vim default value when 'compatible' is reset.
5840
5841 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5842'showfulltag' 'sft' boolean (default off)
5843 global
5844 {not in Vi}
5845 When completing a word in insert mode (see |ins-completion|) from the
5846 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005847 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005848 matched a C function, you can see a template for what arguments are
5849 required (coding style permitting).
5850
5851 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5852'showmatch' 'sm' boolean (default off)
5853 global
5854 When a bracket is inserted, briefly jump to the matching one. The
5855 jump is only done if the match can be seen on the screen. The time to
5856 show the match can be set with 'matchtime'.
5857 A Beep is given if there is no match (no matter if the match can be
5858 seen or not). This option is reset when the 'paste' option is set.
5859 When the 'm' flag is not included in 'cpoptions', typing a character
5860 will immediately move the cursor back to where it belongs.
5861 See the "sm" field in 'guicursor' for setting the cursor shape and
5862 blinking when showing the match.
5863 The 'matchpairs' option can be used to specify the characters to show
5864 matches for. 'rightleft' and 'revins' are used to look for opposite
5865 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00005866 Also see the matchparen plugin for highlighting the match when moving
5867 around |pi_paren.txt|.
5868 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869
5870 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
5871'showmode' 'smd' boolean (Vim default: on, Vi default: off)
5872 global
5873 If in Insert, Replace or Visual mode put a message on the last line.
5874 Use the 'M' flag in 'highlight' to set the type of highlighting for
5875 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005876 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005877 doesn't mean XIM is really active, especially when 'imactivatekey' is
5878 not set.
5879 NOTE: This option is set to the Vi default value when 'compatible' is
5880 set and to the Vim default value when 'compatible' is reset.
5881
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00005882 *'showtabline'* *'stal'*
5883'showtabline' 'stal' number (default 1)
5884 global
5885 {not in Vi}
5886 {not available when compiled without the +windows
5887 feature}
5888 The value of this option specifies when the line with tab page labels
5889 will be displayed:
5890 0: never
5891 1: only if there are at least two tab pages
5892 2: always
5893 This is both for the GUI and non-GUI implementation of the tab pages
5894 line.
5895 See |tab-page| for more information about tab pages.
5896
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 *'sidescroll'* *'ss'*
5898'sidescroll' 'ss' number (default 0)
5899 global
5900 {not in Vi}
5901 The minimal number of columns to scroll horizontally. Used only when
5902 the 'wrap' option is off and the cursor is moved off of the screen.
5903 When it is zero the cursor will be put in the middle of the screen.
5904 When using a slow terminal set it to a large number or 0. When using
5905 a fast terminal use a small number or 1. Not used for "zh" and "zl"
5906 commands.
5907
5908 *'sidescrolloff'* *'siso'*
5909'sidescrolloff' 'siso' number (default 0)
5910 global
5911 {not in Vi}
5912 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00005913 right of the cursor if 'nowrap' is set. Setting this option to a
5914 value greater than 0 while having |'sidescroll'| also at a non-zero
5915 value makes some context visible in the line you are scrolling in
5916 horizontally (except at beginning of the line). Setting this option
5917 to a large value (like 999) has the effect of keeping the cursor
5918 horizontally centered in the window, as long as one does not come too
5919 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005920 NOTE: This option is set to 0 when 'compatible' is set.
5921
5922 Example: Try this together with 'sidescroll' and 'listchars' as
5923 in the following example to never allow the cursor to move
5924 onto the "extends" character:
5925
5926 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
5927 :set sidescrolloff=1
5928
5929
5930 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
5931'smartcase' 'scs' boolean (default off)
5932 global
5933 {not in Vi}
5934 Override the 'ignorecase' option if the search pattern contains upper
5935 case characters. Only used when the search pattern is typed and
5936 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005937 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 "*" and "#" you can make 'smartcase' used by doing a "/" command,
5939 recalling the search pattern from history and hitting <Enter>.
5940 NOTE: This option is reset when 'compatible' is set.
5941
5942 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
5943'smartindent' 'si' boolean (default off)
5944 local to buffer
5945 {not in Vi}
5946 {not available when compiled without the
5947 |+smartindent| feature}
5948 Do smart autoindenting when starting a new line. Works for C-like
5949 programs, but can also be used for other languages. 'cindent' does
5950 something like this, works better in most cases, but is more strict,
5951 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
5952 'indentexpr' is a more advanced alternative.
5953 Normally 'autoindent' should also be on when using 'smartindent'.
5954 An indent is automatically inserted:
5955 - After a line ending in '{'.
5956 - After a line starting with a keyword from 'cinwords'.
5957 - Before a line starting with '}' (only with the "O" command).
5958 When typing '}' as the first character in a new line, that line is
5959 given the same indent as the matching '{'.
5960 When typing '#' as the first character in a new line, the indent for
5961 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005962 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00005963 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
5964 When using the ">>" command, lines starting with '#' are not shifted
5965 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005966 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967 is set smart indenting is disabled.
5968
5969 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
5970'smarttab' 'sta' boolean (default off)
5971 global
5972 {not in Vi}
5973 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00005974 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
5975 <BS> will delete a 'shiftwidth' worth of space at the start of the
5976 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005977 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00005978 'softtabstop'. 'shiftwidth' is only used for shifting text left or
5979 right |shift-left-right|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005980 What gets inserted (a Tab or spaces) depends on the 'expandtab'
5981 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00005982 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005983 NOTE: This option is reset when 'compatible' is set.
5984
5985 *'softtabstop'* *'sts'*
5986'softtabstop' 'sts' number (default 0)
5987 local to buffer
5988 {not in Vi}
5989 Number of spaces that a <Tab> counts for while performing editing
5990 operations, like inserting a <Tab> or using <BS>. It "feels" like
5991 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
5992 used. This is useful to keep the 'ts' setting at its standard value
5993 of 8, while being able to edit like it is set to 'sts'. However,
5994 commands like "x" still work on the actual characters.
5995 When 'sts' is zero, this feature is off.
5996 'softtabstop' is set to 0 when the 'paste' option is set.
5997 See also |ins-expandtab|. When 'expandtab' is not set, the number of
5998 spaces is minimized by using <Tab>s.
5999 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6000 set.
6001 NOTE: This option is set to 0 when 'compatible' is set.
6002
Bram Moolenaar217ad922005-03-20 22:37:15 +00006003 *'spell'* *'nospell'*
6004'spell' boolean (default off)
6005 local to window
6006 {not in Vi}
6007 {not available when compiled without the |+syntax|
6008 feature}
6009 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006010 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006011
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006012 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006013'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006014 local to buffer
6015 {not in Vi}
6016 {not available when compiled without the |+syntax|
6017 feature}
6018 Pattern to locate the end of a sentence. The following word will be
6019 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006020 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006021 When this check is not wanted make this option empty.
6022 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006023 Be careful with special characters, see |option-backslash| about
6024 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006025 To set this option automatically depending on the language, see
6026 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006027
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006028 *'spellfile'* *'spf'*
6029'spellfile' 'spf' string (default empty)
6030 local to buffer
6031 {not in Vi}
6032 {not available when compiled without the |+syntax|
6033 feature}
6034 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006035 commands. It must end in ".{encoding}.add". You need to include the
6036 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006037 *E765*
6038 It may also be a comma separated list of names. A count before the
6039 |zg| and |zw| commands can be used to access each. This allows using
6040 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006041 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006042 you: Using the first directory in 'runtimepath' that is writable. If
6043 there is no "spell" directory yet it will be created. For the file
6044 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006045 ignoring the region.
6046 The resulting ".spl" file will be used for spell checking, it does not
6047 have to appear in 'spelllang'.
6048 Normally one file is used for all regions, but you can add the region
6049 name if you want to. However, it will then only be used when
6050 'spellfile' is set to it, for entries in 'spelllang' only files
6051 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006052 This option cannot be set from a |modeline| or in the |sandbox|, for
6053 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006054
Bram Moolenaar217ad922005-03-20 22:37:15 +00006055 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006056'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006057 local to buffer
6058 {not in Vi}
6059 {not available when compiled without the |+syntax|
6060 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006061 A comma separated list of word list names. When the 'spell' option is
6062 on spellchecking will be done for these languages. Example: >
6063 set spelllang=en_us,nl,medical
6064< This means US English, Dutch and medical words are recognized. Words
6065 that are not recognized will be highlighted.
6066 The word list name must not include a comma or dot. Using a dash is
6067 recommended to separate the two letter language name from a
6068 specification. Thus "en-rare" is used for rare English words.
6069 A region name must come last and have the form "_xx", where "xx" is
6070 the two-letter, lower case region name. You can use more than one
6071 region by listing them: "en_us,en_ca" supports both US and Canadian
6072 English, but not words specific for Australia, New Zealand or Great
6073 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006074 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006075 As a special case the name of a .spl file can be given as-is. The
6076 first "_xx" in the name is removed and used as the region name
6077 (_xx is an underscore, two letters and followed by a non-letter).
6078 This is mainly for testing purposes. You must make sure the correct
6079 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006080 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006081 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6082 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006083 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006084
Bram Moolenaar98692072006-02-04 00:57:42 +00006085 If the |spellfile.vim| plugin is active and you use a language name
6086 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6087 will ask you if you want to download the file.
6088
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006089 After this option has been set successfully, Vim will source the files
6090 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006091 up to the first comma, dot or underscore.
6092 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006093
6094
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006095 *'spellsuggest'* *'sps'*
6096'spellsuggest' 'sps' string (default "best")
6097 global
6098 {not in Vi}
6099 {not available when compiled without the |+syntax|
6100 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006101 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006102 the |spellsuggest()| function. This is a comma-separated list of
6103 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006104
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006105 best Internal method that works best for English. Finds
6106 changes like "fast" and uses a bit of sound-a-like
6107 scoring to improve the ordering.
6108
6109 double Internal method that uses two methods and mixes the
6110 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006111 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006112 word. That only works when the language specifies
6113 sound folding. Can be slow and doesn't always give
6114 better results.
6115
6116 fast Internal method that only checks for simple changes:
6117 character inserts/deletes/swaps. Works well for
6118 simple typing mistakes.
6119
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006120 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006121 Not used for |spellsuggest()|. The number of
6122 suggestions is never more than the value of 'lines'
6123 minus two.
6124
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006125 file:{filename} Read file {filename}, which must have two columns,
6126 separated by a slash. The first column contains the
6127 bad word, the second column the suggested good word.
6128 Example:
6129 theribal/terrible ~
6130 Use this for common mistakes that do not appear at the
6131 top of the suggestion list with the internal methods.
6132 Lines without a slash are ignored, use this for
6133 comments.
6134 The file is used for all languages.
6135
6136 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6137 trouble with spaces. |v:val| holds the badly spelled
6138 word. The expression must evaluate to a List of
6139 Lists, each with a suggestion and a score.
6140 Example:
6141 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006142 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006143 internal methods use. A lower score is better.
6144 This may invoke |spellsuggest()| if you temporarily
6145 set 'spellsuggest' to exclude the "expr:" part.
6146 Errors are silently ignored, unless you set the
6147 'verbose' option to a non-zero value.
6148
6149 Only one of "best", "double" or "fast" may be used. The others may
6150 appear several times in any order. Example: >
6151 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6152<
6153 This option cannot be set from a |modeline| or in the |sandbox|, for
6154 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006155
6156
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6158'splitbelow' 'sb' boolean (default off)
6159 global
6160 {not in Vi}
6161 {not available when compiled without the +windows
6162 feature}
6163 When on, splitting a window will put the new window below the current
6164 one. |:split|
6165
6166 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6167'splitright' 'spr' boolean (default off)
6168 global
6169 {not in Vi}
6170 {not available when compiled without the +vertsplit
6171 feature}
6172 When on, splitting a window will put the new window right of the
6173 current one. |:vsplit|
6174
6175 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6176'startofline' 'sol' boolean (default on)
6177 global
6178 {not in Vi}
6179 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006180 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006181 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006182 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006183 with a linewise operator, with "%" with a count and to buffer changing
6184 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6185 only has a line number, e.g., ":25" or ":+".
6186 In case of buffer changing commands the cursor is placed at the column
6187 where it was the last time the buffer was edited.
6188 NOTE: This option is set when 'compatible' is set.
6189
6190 *'statusline'* *'stl'* *E540* *E541* *E542*
6191'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006192 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006193 {not in Vi}
6194 {not available when compiled without the |+statusline|
6195 feature}
6196 When nonempty, this option determines the content of the status line.
6197 Also see |status-line|.
6198
6199 The option consists of printf style '%' items interspersed with
6200 normal text. Each status line item is of the form:
6201 %-0{minwid}.{maxwid}{item}
6202 All fields except the {item} is optional. A single percent sign can
6203 be given as "%%". Up to 80 items can be specified.
6204
Bram Moolenaar238a5642006-02-21 22:12:05 +00006205 When the option starts with "%!" then it is used as an expression,
6206 evaluated and the result is used as the option value. Example: >
6207 :set statusline=%!MyStatusLine()
6208< The result can contain %{} items that will be evaluated too.
6209
6210 When there is error while evaluating the option then it will be made
6211 empty to avoid further errors. Otherwise screen updating would loop.
6212
Bram Moolenaar071d4272004-06-13 20:20:40 +00006213 Note that the only effect of 'ruler' when this option is set (and
6214 'laststatus' is 2) is controlling the output of |CTRL-G|.
6215
6216 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006217 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006218 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006219 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 minwid Minimum width of the item, padding as set by '-' & '0'.
6221 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006222 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006223 on the left for text items. Numeric items will be
6224 shifted down to maxwid-2 digits followed by '>'number
6225 where number is the amount of missing digits, much like
6226 an exponential notation.
6227 item A one letter code as described below.
6228
6229 Following is a description of the possible statusline items. The
6230 second character in "item" is the type:
6231 N for number
6232 S for string
6233 F for flags as described below
6234 - not applicable
6235
6236 item meaning ~
6237 f S Path to the file in the buffer, relative to current directory.
6238 F S Full path to the file in the buffer.
6239 t S File name (tail) of file in the buffer.
6240 m F Modified flag, text is " [+]"; " [-]" if 'modifiable' is off.
6241 M F Modified flag, text is ",+" or ",-".
6242 r F Readonly flag, text is " [RO]".
6243 R F Readonly flag, text is ",RO".
6244 h F Help buffer flag, text is " [help]".
6245 H F Help buffer flag, text is ",HLP".
6246 w F Preview window flag, text is " [Preview]".
6247 W F Preview window flag, text is ",PRV".
6248 y F Type of file in the buffer, e.g., " [vim]". See 'filetype'.
6249 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6250 {not available when compiled without |+autocmd| feature}
6251 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6252 being used: "<keymap>"
6253 n N Buffer number.
6254 b N Value of byte under cursor.
6255 B N As above, in hexadecimal.
6256 o N Byte number in file of byte under cursor, first byte is 1.
6257 Mnemonic: Offset from start of file (with one added)
6258 {not available when compiled without |+byte_offset| feature}
6259 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006260 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 l N Line number.
6262 L N Number of lines in buffer.
6263 c N Column number.
6264 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006265 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 p N Percentage through file in lines as in |CTRL-G|.
6267 P S Percentage through file of displayed window. This is like the
6268 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006269 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006270 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006271 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006272 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006273 ( - Start of item group. Can be used for setting the width and
6274 alignment of a section. Must be followed by %) somewhere.
6275 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006276 T N For 'tabline': start of tab page N label. Use %T after the last
6277 label. This information is used for mouse clicks.
6278 X N For 'tabline': start of close tab N label. Use %X after the
6279 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6280 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 < - Where to truncate line if too long. Default is at the start.
6282 No width fields allowed.
6283 = - Separation point between left and right aligned items.
6284 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006285 # - Set highlight group. The name must follow and then a # again.
6286 Thus use %#HLname# for highlight group HLname. The same
6287 highlighting is used, also for the statusline of non-current
6288 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006290 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006291 The difference between User{N} and StatusLine will be applied
6292 to StatusLineNC for the statusline of non-current windows.
6293 The number N must be between 1 and 9. See |hl-User1..9|
6294
6295 Display of flags are controlled by the following heuristic:
6296 If a flag text starts with comma it is assumed that it wants to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006297 separate itself from anything but preceding plaintext. If it starts
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 with a space it is assumed that it wants to separate itself from
6299 anything but other flags. That is: A leading comma is removed if the
6300 preceding character stems from plaintext. A leading space is removed
Bram Moolenaar582fd852005-03-28 20:58:01 +00006301 if the preceding character stems from another active flag. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 make a nice display when flags are used like in the examples below.
6303
Bram Moolenaar582fd852005-03-28 20:58:01 +00006304 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 not set) and a minwid is not set for the group, the whole group will
6306 become empty. This will make a group like the following disappear
6307 completely from the statusline when none of the flags are set. >
6308 :set statusline=...%(\ [%M%R%H]%)...
6309<
6310 Beware that an expression is evaluated each and every time the status
6311 line is displayed. The current buffer and current window will be set
6312 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006313 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006314 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006315 real current buffer.
6316
6317 The 'statusline' option may be evaluated in the |sandbox|, see
6318 |sandbox-option|.
6319
6320 It is not allowed to change text or jump to another window while
6321 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322
6323 If the statusline is not updated when you want it (e.g., after setting
6324 a variable that's used in an expression), you can force an update by
6325 setting an option without changing its value. Example: >
6326 :let &ro = &ro
6327
6328< A result of all digits is regarded a number for display purposes.
6329 Otherwise the result is taken as flag text and applied to the rules
6330 described above.
6331
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006332 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006333 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6334 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6335
6336 Examples:
6337 Emulate standard status line with 'ruler' set >
6338 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6339< Similar, but add ASCII value of char under the cursor (like "ga") >
6340 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6341< Display byte count and byte value, modified flag in red. >
6342 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6343 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6344< Display a ,GZ flag if a compressed file is loaded >
6345 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6346< In the |:autocmd|'s: >
6347 :let b:gzflag = 1
6348< And: >
6349 :unlet b:gzflag
6350< And define this function: >
6351 :function VarExists(var, val)
6352 : if exists(a:var) | return a:val | else | return '' | endif
6353 :endfunction
6354<
6355 *'suffixes'* *'su'*
6356'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6357 global
6358 {not in Vi}
6359 Files with these suffixes get a lower priority when multiple files
6360 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006361 suffixes. Spaces after the comma are ignored. A dot is also seen as
6362 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 separator, precede it with a backslash (see |option-backslash| about
6364 including spaces and backslashes).
6365 See 'wildignore' for completely ignoring files.
6366 The use of |:set+=| and |:set-=| is preferred when adding or removing
6367 suffixes from the list. This avoids problems when a future version
6368 uses another default.
6369
6370 *'suffixesadd'* *'sua'*
6371'suffixesadd' 'sua' string (default "")
6372 local to buffer
6373 {not in Vi}
6374 {not available when compiled without the
6375 |+file_in_path| feature}
6376 Comma separated list of suffixes, which are used when searching for a
6377 file for the "gf", "[I", etc. commands. Example: >
6378 :set suffixesadd=.java
6379<
6380 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6381'swapfile' 'swf' boolean (default on)
6382 local to buffer
6383 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006384 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006385 swapfile is not wanted for a specific buffer. For example, with
6386 confidential information that even root must not be able to access.
6387 Careful: All text will be in memory:
6388 - Don't use this for big files.
6389 - Recovery will be impossible!
6390 A swapfile will only be present when |'updatecount'| is non-zero and
6391 'swapfile' is set.
6392 When 'swapfile' is reset, the swap file for the current buffer is
6393 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6394 non-zero, a swap file is immediately created.
6395 Also see |swap-file| and |'swapsync'|.
6396
6397 This option is used together with 'bufhidden' and 'buftype' to
6398 specify special kinds of buffers. See |special-buffers|.
6399
6400 *'swapsync'* *'sws'*
6401'swapsync' 'sws' string (default "fsync")
6402 global
6403 {not in Vi}
6404 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006405 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 When this option is empty parts of the swap file may be in memory and
6407 not written to disk. When the system crashes you may lose more work.
6408 On Unix the system does a sync now and then without Vim asking for it,
6409 so the disadvantage of setting this option off is small. On some
6410 systems the swap file will not be written at all. For a unix system
6411 setting it to "sync" will use the sync() call instead of the default
6412 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006413 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006414
6415 *'switchbuf'* *'swb'*
6416'switchbuf' 'swb' string (default "")
6417 global
6418 {not in Vi}
6419 This option controls the behavior when switching between buffers.
6420 Possible values (comma separated list):
6421 useopen If included, jump to the first open window that
6422 contains the specified buffer (if there is one).
6423 Otherwise: Do not examine other windows.
6424 This setting is checked with |quickfix| commands, when
6425 jumping to errors (":cc", ":cn", "cp", etc.). It is
6426 also used in all buffer related split commands, for
6427 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006428 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006429 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006431 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006432 Supported in |quickfix| commands that display errors.
6433
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006434 *'synmaxcol'* *'smc'*
6435'synmaxcol' 'smc' number (default 3000)
6436 local to buffer
6437 {not in Vi}
6438 {not available when compiled without the |+syntax|
6439 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006440 Maximum column in which to search for syntax items. In long lines the
6441 text after this column is not highlighted and following lines may not
6442 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006443 This helps to avoid very slow redrawing for an XML file that is one
6444 long line.
6445 Set to zero to remove the limit.
6446
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 *'syntax'* *'syn'*
6448'syntax' 'syn' string (default empty)
6449 local to buffer
6450 {not in Vi}
6451 {not available when compiled without the |+syntax|
6452 feature}
6453 When this option is set, the syntax with this name is loaded, unless
6454 syntax highlighting has been switched off with ":syntax off".
6455 Otherwise this option does not always reflect the current syntax (the
6456 b:current_syntax variable does).
6457 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006458 not automatically recognized. Example, in an IDL file:
6459 /* vim: set syntax=idl : */ ~
6460 When a dot appears in the value then this separates two filetype
6461 names. Example:
6462 /* vim: set syntax=c.doxygen : */ ~
6463 This will use the "c" syntax first, then the "doxygen" syntax.
6464 Note that the second one must be prepared to be loaded as an addition,
6465 otherwise it will be skipped. More than one dot may appear.
6466 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006467 :set syntax=OFF
6468< To switch syntax highlighting on according to the current value of the
6469 'filetype' option: >
6470 :set syntax=ON
6471< What actually happens when setting the 'syntax' option is that the
6472 Syntax autocommand event is triggered with the value as argument.
6473 This option is not copied to another buffer, independent of the 's' or
6474 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006475 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006477 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006478'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006479 global
6480 {not in Vi}
6481 {not available when compiled without the +windows
6482 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006483 When nonempty, this option determines the content of the tab pages
6484 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006485 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006486
6487 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006488 option and only when there is no GUI tab line. When 'e' is in
6489 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6490 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006491
6492 The value is evaluated like with 'statusline'. You can use
6493 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006494 the text to be displayed. Use "%1T" for the first label, "%2T" for
6495 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006496
6497 Keep in mind that only one of the tab pages is the current one, others
6498 are invisible and you can't jump to their windows.
6499
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006500
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006501 *'tabpagemax'* *'tpm'*
6502'tabpagemax' 'tpm' number (default 10)
6503 global
6504 {not in Vi}
6505 {not available when compiled without the +windows
6506 feature}
6507 Maximum number of tab pages to be opened by the |-p| command line
6508 argument or the ":tab all" command. |tabpage|
6509
6510
6511 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006512'tabstop' 'ts' number (default 8)
6513 local to buffer
6514 Number of spaces that a <Tab> in the file counts for. Also see
6515 |:retab| command, and 'softtabstop' option.
6516
6517 Note: Setting 'tabstop' to any other value than 8 can make your file
6518 appear wrong in many places (e.g., when printing it).
6519
6520 There are four main ways to use tabs in Vim:
6521 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6522 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
6523 will use a mix of tabs and spaces, but typing Tab and BS will
6524 behave like a tab appears every 4 (or 3) characters.
6525 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6526 'expandtab'. This way you will always insert spaces. The
6527 formatting will never be messed up when 'tabstop' is changed.
6528 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006529 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 works when using Vim to edit the file.
6531 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6532 'noexpandtab'. This should then work (for initial indents only)
6533 for any tabstop setting that people use. It might be nice to have
6534 tabs after the first non-blank inserted as spaces if you do this
6535 though. Otherwise aligned comments will be wrong when 'tabstop' is
6536 changed.
6537
6538 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6539'tagbsearch' 'tbs' boolean (default on)
6540 global
6541 {not in Vi}
6542 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006543 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 searching makes searching for a tag a LOT faster, but a linear search
6545 will find more tags if the tags file wasn't properly sorted.
6546 Vim normally assumes that your tags files are sorted, or indicate that
6547 they are not sorted. Only when this is not the case does the
6548 'tagbsearch' option need to be switched off.
6549
6550 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006551 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 certain files, or retry all files with a linear search. When
6553 'tagbsearch' is off, only a linear search is done.
6554
6555 Linear searching is done anyway, for one file, when Vim finds a line
6556 at the start of the file indicating that it's not sorted: >
6557 !_TAG_FILE_SORTED 0 /some command/
6558< [The whitespace before and after the '0' must be a single <Tab>]
6559
6560 When a binary search was done and no match was found in any of the
6561 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6562 instead of a normal tag name, a retry is done with a linear search.
6563 Tags in unsorted tags files, and matches with different case will only
6564 be found in the retry.
6565
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006566 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 linear search can be avoided for the 'ignorecase' case. Use a value
6568 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6569 case-fold sorted with the -f switch to "sort" in most unices, as in
6570 the command: "sort -f -o tags tags". For "Exuberant ctags" version
6571 5.3 or higher the -f or --fold-case-sort switch can be used for this
6572 as well. Note that case must be folded to uppercase for this to work.
6573
6574 When 'tagbsearch' is off, tags searching is slower when a full match
6575 exists, but faster when no full match exists. Tags in unsorted tags
6576 files may only be found with 'tagbsearch' off.
6577 When the tags file is not sorted, or sorted in a wrong way (not on
6578 ASCII byte value), 'tagbsearch' should be off, or the line given above
6579 must be included in the tags file.
6580 This option doesn't affect commands that find all matching tags (e.g.,
6581 command-line completion and ":help").
6582 {Vi: always uses binary search in some versions}
6583
6584 *'taglength'* *'tl'*
6585'taglength' 'tl' number (default 0)
6586 global
6587 If non-zero, tags are significant up to this number of characters.
6588
6589 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6590'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6591 global
6592 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006593 If on and using a tags file in another directory, file names in that
6594 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 NOTE: This option is set to the Vi default value when 'compatible' is
6596 set and to the Vim default value when 'compatible' is reset.
6597
6598 *'tags'* *'tag'* *E433*
6599'tags' 'tag' string (default "./tags,tags", when compiled with
6600 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6601 global or local to buffer |global-local|
6602 Filenames for the tag command, separated by spaces or commas. To
6603 include a space or comma in a file name, precede it with a backslash
6604 (see |option-backslash| about including spaces and backslashes).
6605 When a file name starts with "./", the '.' is replaced with the path
6606 of the current file. But only when the 'd' flag is not included in
6607 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6608 |tags-option|.
6609 "*", "**" and other wildcards can be used to search for tags files in
6610 a directory tree. See |file-searching|. {not available when compiled
6611 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006612 The |tagfiles()| function can be used to get a list of the file names
6613 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006614 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6615 files are also supported. They are automatically recognized. The
6616 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6617 differences are ignored (MS-Windows). |emacs-tags|
6618 The use of |:set+=| and |:set-=| is preferred when adding or removing
6619 file names from the list. This avoids problems when a future version
6620 uses another default.
6621 {Vi: default is "tags /usr/lib/tags"}
6622
6623 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6624'tagstack' 'tgst' boolean (default on)
6625 global
6626 {not in all versions of Vi}
6627 When on, the |tagstack| is used normally. When off, a ":tag" or
6628 ":tselect" command with an argument will not push the tag onto the
6629 tagstack. A following ":tag" without an argument, a ":pop" command or
6630 any other command that uses the tagstack will use the unmodified
6631 tagstack, but does change the pointer to the active entry.
6632 Resetting this option is useful when using a ":tag" command in a
6633 mapping which should not change the tagstack.
6634
6635 *'term'* *E529* *E530* *E531*
6636'term' string (default is $TERM, if that fails:
6637 in the GUI: "builtin_gui"
6638 on Amiga: "amiga"
6639 on BeOS: "beos-ansi"
6640 on Mac: "mac-ansi"
6641 on MiNT: "vt52"
6642 on MS-DOS: "pcterm"
6643 on OS/2: "os2ansi"
6644 on Unix: "ansi"
6645 on VMS: "ansi"
6646 on Win 32: "win32")
6647 global
6648 Name of the terminal. Used for choosing the terminal control
6649 characters. Environment variables are expanded |:set_env|.
6650 For example: >
6651 :set term=$TERM
6652< See |termcap|.
6653
6654 *'termbidi'* *'tbidi'*
6655 *'notermbidi'* *'notbidi'*
6656'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6657 global
6658 {not in Vi}
6659 {only available when compiled with the |+arabic|
6660 feature}
6661 The terminal is in charge of Bi-directionality of text (as specified
6662 by Unicode). The terminal is also expected to do the required shaping
6663 that some languages (such as Arabic) require.
6664 Setting this option implies that 'rightleft' will not be set when
6665 'arabic' is set and the value of 'arabicshape' will be ignored.
6666 Note that setting 'termbidi' has the immediate effect that
6667 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6668 This option is reset when the GUI is started.
6669 For further details see |arabic.txt|.
6670
6671 *'termencoding'* *'tenc'*
6672'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6673 Macintosh GUI: "macroman")
6674 global
6675 {only available when compiled with the |+multi_byte|
6676 feature}
6677 {not in Vi}
6678 Encoding used for the terminal. This specifies what character
6679 encoding the keyboard produces and the display will understand. For
6680 the GUI it only applies to the keyboard ('encoding' is used for the
6681 display).
6682 In the Win32 console version the default value is the console codepage
6683 when it differs from the ANSI codepage.
6684 *E617*
6685 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6686 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6687 Any attempts to set a different value will be rejected, and an error
6688 message is shown.
6689 For the Win32 GUI 'termencoding' is not used for typed characters,
6690 because the Win32 system always passes Unicode characters.
6691 When empty, the same encoding is used as for the 'encoding' option.
6692 This is the normal value.
6693 Not all combinations for 'termencoding' and 'encoding' are valid. See
6694 |encoding-table|.
6695 The value for this option must be supported by internal conversions or
6696 iconv(). When this is not possible no conversion will be done and you
6697 will probably experience problems with non-ASCII characters.
6698 Example: You are working with the locale set to euc-jp (Japanese) and
6699 want to edit a UTF-8 file: >
6700 :let &termencoding = &encoding
6701 :set encoding=utf-8
6702< You need to do this when your system has no locale support for UTF-8.
6703
6704 *'terse'* *'noterse'*
6705'terse' boolean (default off)
6706 global
6707 When set: Add 's' flag to 'shortmess' option (this makes the message
6708 for a search that hits the start or end of the file not being
6709 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6710 shortens a lot of messages}
6711
6712 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6713'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6714 global
6715 {not in Vi}
6716 This option is obsolete. Use 'fileformats'.
6717 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6718 set to the default value for the current system. When 'textauto' is
6719 reset, 'fileformats' is made empty.
6720 NOTE: This option is set to the Vi default value when 'compatible' is
6721 set and to the Vim default value when 'compatible' is reset.
6722
6723 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6724'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6725 others: default off)
6726 local to buffer
6727 {not in Vi}
6728 This option is obsolete. Use 'fileformat'.
6729 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6730 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6731 "unix".
6732
6733 *'textwidth'* *'tw'*
6734'textwidth' 'tw' number (default 0)
6735 local to buffer
6736 {not in Vi}
6737 Maximum width of text that is being inserted. A longer line will be
6738 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006739 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6740 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006741 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006742 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 NOTE: This option is set to 0 when 'compatible' is set.
6744
6745 *'thesaurus'* *'tsr'*
6746'thesaurus' 'tsr' string (default "")
6747 global or local to buffer |global-local|
6748 {not in Vi}
6749 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006750 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 the file should contain words with similar meaning, separated by
6752 non-keyword characters (white space is preferred). Maximum line
6753 length is 510 bytes.
6754 To obtain a file to be used here, check out the wordlist FAQ at
6755 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006756 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757 after a comma are ignored, otherwise spaces are included in the file
6758 name. See |option-backslash| about using backslashes.
6759 The use of |:set+=| and |:set-=| is preferred when adding or removing
6760 directories from the list. This avoids problems when a future version
6761 uses another default.
6762 Backticks cannot be used in this option for security reasons.
6763
6764 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6765'tildeop' 'top' boolean (default off)
6766 global
6767 {not in Vi}
6768 When on: The tilde command "~" behaves like an operator.
6769 NOTE: This option is reset when 'compatible' is set.
6770
6771 *'timeout'* *'to'* *'notimeout'* *'noto'*
6772'timeout' 'to' boolean (default on)
6773 global
6774 *'ttimeout'* *'nottimeout'*
6775'ttimeout' boolean (default off)
6776 global
6777 {not in Vi}
6778 These two options together determine the behavior when part of a
6779 mapped key sequence or keyboard code has been received:
6780
6781 'timeout' 'ttimeout' action ~
6782 off off do not time out
6783 on on or off time out on :mappings and key codes
6784 off on time out on key codes
6785
6786 If both options are off, Vim will wait until either the complete
6787 mapping or key sequence has been received, or it is clear that there
6788 is no mapping or key sequence for the received characters. For
6789 example: if you have mapped "vl" and Vim has received 'v', the next
6790 character is needed to see if the 'v' is followed by an 'l'.
6791 When one of the options is on, Vim will wait for about 1 second for
6792 the next character to arrive. After that the already received
6793 characters are interpreted as single characters. The waiting time can
6794 be changed with the 'timeoutlen' option.
6795 On slow terminals or very busy systems timing out may cause
6796 malfunctioning cursor keys. If both options are off, Vim waits
6797 forever after an entered <Esc> if there are key codes that start
6798 with <Esc>. You will have to type <Esc> twice. If you do not have
6799 problems with key codes, but would like to have :mapped key
6800 sequences not timing out in 1 second, set the 'ttimeout' option and
6801 reset the 'timeout' option.
6802
6803 NOTE: 'ttimeout' is reset when 'compatible' is set.
6804
6805 *'timeoutlen'* *'tm'*
6806'timeoutlen' 'tm' number (default 1000)
6807 global
6808 {not in all versions of Vi}
6809 *'ttimeoutlen'* *'ttm'*
6810'ttimeoutlen' 'ttm' number (default -1)
6811 global
6812 {not in Vi}
6813 The time in milliseconds that is waited for a key code or mapped key
6814 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6815 when part of a command has been typed.
6816 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6817 different timeout value for key codes is desired set 'ttimeoutlen' to
6818 a non-negative number.
6819
6820 ttimeoutlen mapping delay key code delay ~
6821 < 0 'timeoutlen' 'timeoutlen'
6822 >= 0 'timeoutlen' 'ttimeoutlen'
6823
6824 The timeout only happens when the 'timeout' and 'ttimeout' options
6825 tell so. A useful setting would be >
6826 :set timeout timeoutlen=3000 ttimeoutlen=100
6827< (time out on mapping after three seconds, time out on key codes after
6828 a tenth of a second).
6829
6830 *'title'* *'notitle'*
6831'title' boolean (default off, on when title can be restored)
6832 global
6833 {not in Vi}
6834 {not available when compiled without the |+title|
6835 feature}
6836 When on, the title of the window will be set to the value of
6837 'titlestring' (if it is not empty), or to:
6838 filename [+=-] (path) - VIM
6839 Where:
6840 filename the name of the file being edited
6841 - indicates the file cannot be modified, 'ma' off
6842 + indicates the file was modified
6843 = indicates the file is read-only
6844 =+ indicates the file is read-only and modified
6845 (path) is the path of the file being edited
6846 - VIM the server name |v:servername| or "VIM"
6847 Only works if the terminal supports setting window titles
6848 (currently Amiga console, Win32 console, all GUI versions and
6849 terminals with a non- empty 't_ts' option - these are Unix xterm and
6850 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6851 *X11*
6852 When Vim was compiled with HAVE_X11 defined, the original title will
6853 be restored if possible. The output of ":version" will include "+X11"
6854 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6855 works for the icon name |'icon'|.
6856 But: When Vim was started with the |-X| argument, restoring the title
6857 will not work (except in the GUI).
6858 If the title cannot be restored, it is set to the value of 'titleold'.
6859 You might want to restore the title outside of Vim then.
6860 When using an xterm from a remote machine you can use this command:
6861 rsh machine_name xterm -display $DISPLAY &
6862 then the WINDOWID environment variable should be inherited and the
6863 title of the window should change back to what it should be after
6864 exiting Vim.
6865
6866 *'titlelen'*
6867'titlelen' number (default 85)
6868 global
6869 {not in Vi}
6870 {not available when compiled without the |+title|
6871 feature}
6872 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006873 title. When the title is longer, only the end of the path name is
6874 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 Using a percentage makes this adapt to the width of the window. But
6876 it won't work perfectly, because the actual number of characters
6877 available also depends on the font used and other things in the title
6878 bar. When 'titlelen' is zero the full path is used. Otherwise,
6879 values from 1 to 30000 percent can be used.
6880 'titlelen' is also used for the 'titlestring' option.
6881
6882 *'titleold'*
6883'titleold' string (default "Thanks for flying Vim")
6884 global
6885 {not in Vi}
6886 {only available when compiled with the |+title|
6887 feature}
6888 This option will be used for the window title when exiting Vim if the
6889 original title cannot be restored. Only happens if 'title' is on or
6890 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006891 This option cannot be set from a |modeline| or in the |sandbox|, for
6892 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 *'titlestring'*
6894'titlestring' string (default "")
6895 global
6896 {not in Vi}
6897 {not available when compiled without the |+title|
6898 feature}
6899 When this option is not empty, it will be used for the title of the
6900 window. This happens only when the 'title' option is on.
6901 Only works if the terminal supports setting window titles (currently
6902 Amiga console, Win32 console, all GUI versions and terminals with a
6903 non-empty 't_ts' option).
6904 When Vim was compiled with HAVE_X11 defined, the original title will
6905 be restored if possible |X11|.
6906 When this option contains printf-style '%' items, they will be
6907 expanded according to the rules used for 'statusline'.
6908 Example: >
6909 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
6910 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
6911< The value of 'titlelen' is used to align items in the middle or right
6912 of the available space.
6913 Some people prefer to have the file name first: >
6914 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
6915< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006916 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 separating space only when needed.
6918 NOTE: Use of special characters in 'titlestring' may cause the display
6919 to be garbled (e.g., when it contains a CR or NL character).
6920 {not available when compiled without the |+statusline| feature}
6921
6922 *'toolbar'* *'tb'*
6923'toolbar' 'tb' string (default "icons,tooltips")
6924 global
6925 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
6926 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006927 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 possible values are:
6929 icons Toolbar buttons are shown with icons.
6930 text Toolbar buttons shown with text.
6931 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006932 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006933 tooltips Tooltips are active for toolbar buttons.
6934 Tooltips refer to the popup help text which appears after the mouse
6935 cursor is placed over a toolbar button for a brief moment.
6936
6937 If you want the toolbar to be shown with icons as well as text, do the
6938 following: >
6939 :set tb=icons,text
6940< Motif and Athena cannot display icons and text at the same time. They
6941 will show icons if both are requested.
6942
6943 If none of the strings specified in 'toolbar' are valid or if
6944 'toolbar' is empty, this option is ignored. If you want to disable
6945 the toolbar, you need to set the 'guioptions' option. For example: >
6946 :set guioptions-=T
6947< Also see |gui-toolbar|.
6948
6949 *'toolbariconsize'* *'tbis'*
6950'toolbariconsize' 'tbis' string (default "small")
6951 global
6952 {not in Vi}
6953 {only in the GTK+ 2 GUI}
6954 Controls the size of toolbar icons. The possible values are:
6955 tiny Use tiny toolbar icons.
6956 small Use small toolbar icons (default).
6957 medium Use medium-sized toolbar icons.
6958 large Use large toolbar icons.
6959 The exact dimensions in pixels of the various icon sizes depend on
6960 the current theme. Common dimensions are large=32x32, medium=24x24,
6961 small=20x20 and tiny=16x16.
6962
6963 If 'toolbariconsize' is empty, the global default size as determined
6964 by user preferences or the current theme is used.
6965
6966 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
6967'ttybuiltin' 'tbi' boolean (default on)
6968 global
6969 {not in Vi}
6970 When on, the builtin termcaps are searched before the external ones.
6971 When off the builtin termcaps are searched after the external ones.
6972 When this option is changed, you should set the 'term' option next for
6973 the change to take effect, for example: >
6974 :set notbi term=$TERM
6975< See also |termcap|.
6976 Rationale: The default for this option is "on", because the builtin
6977 termcap entries are generally better (many systems contain faulty
6978 xterm entries...).
6979
6980 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
6981'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
6982 sun-cmd, screen, rxvt, dtterm or
6983 iris-ansi; also on when running Vim in
6984 a DOS console)
6985 global
6986 {not in Vi}
6987 Indicates a fast terminal connection. More characters will be sent to
6988 the screen for redrawing, instead of using insert/delete line
6989 commands. Improves smoothness of redrawing when there are multiple
6990 windows and the terminal does not support a scrolling region.
6991 Also enables the extra writing of characters at the end of each screen
6992 line for lines that wrap. This helps when using copy/paste with the
6993 mouse in an xterm and other terminals.
6994
6995 *'ttymouse'* *'ttym'*
6996'ttymouse' 'ttym' string (default depends on 'term')
6997 global
6998 {not in Vi}
6999 {only in Unix and VMS, doesn't work in the GUI; not
7000 available when compiled without |+mouse|}
7001 Name of the terminal type for which mouse codes are to be recognized.
7002 Currently these three strings are valid:
7003 *xterm-mouse*
7004 xterm xterm-like mouse handling. The mouse generates
7005 "<Esc>[Mscr", where "scr" is three bytes:
7006 "s" = button state
7007 "c" = column plus 33
7008 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007009 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007010 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 xterm2 Works like "xterm", but with the xterm reporting the
7012 mouse position while the mouse is dragged. This works
7013 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007014 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007015 work. See below for how Vim detects this
7016 automatically.
7017 *netterm-mouse*
7018 netterm NetTerm mouse handling. The mouse generates
7019 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7020 for the row and column.
7021 *dec-mouse*
7022 dec DEC terminal mouse handling. The mouse generates a
7023 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007024 This is also available for an Xterm, if it was
7025 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007026 *jsbterm-mouse*
7027 jsbterm JSB term mouse handling.
7028 *pterm-mouse*
7029 pterm QNX pterm mouse handling.
7030
7031 The mouse handling must be enabled at compile time |+mouse_xterm|
7032 |+mouse_dec| |+mouse_netterm|.
7033 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7034 recognized, if enabled at compile time. DEC terminal mouse codes
7035 are recognized if enabled at compile time, and 'ttymouse' is not
7036 "xterm" (because the xterm and dec mouse codes conflict).
7037 This option is automatically set to "xterm", when the 'term' option is
7038 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7039 or "xterm2" already. The main use of this option is to set it to
7040 "xterm", when the terminal name doesn't start with "xterm", but it can
7041 handle xterm mouse codes.
7042 The "xterm2" value will be set if the xterm version is reported to be
7043 95 of higher. This only works when compiled with the |+termresponse|
7044 feature and if |t_RV| is set to the escape sequence to request the
7045 xterm version number. Otherwise "xterm2" must be set explicitly.
7046 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7047 t_RV to an empty string: >
7048 :set t_RV=
7049<
7050 *'ttyscroll'* *'tsl'*
7051'ttyscroll' 'tsl' number (default 999)
7052 global
7053 Maximum number of lines to scroll the screen. If there are more lines
7054 to scroll the window is redrawn. For terminals where scrolling is
7055 very slow and redrawing is not slow this can be set to a small number,
7056 e.g., 3, to speed up displaying.
7057
7058 *'ttytype'* *'tty'*
7059'ttytype' 'tty' string (default from $TERM)
7060 global
7061 Alias for 'term', see above.
7062
7063 *'undolevels'* *'ul'*
7064'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7065 Win32 and OS/2)
7066 global
7067 {not in Vi}
7068 Maximum number of changes that can be undone. Since undo information
7069 is kept in memory, higher numbers will cause more memory to be used
7070 (nevertheless, a single change can use an unlimited amount of memory).
7071 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7072 itself: >
7073 set ul=0
7074< But you can also get Vi compatibility by including the 'u' flag in
7075 'cpoptions', and still be able to use CTRL-R to repeat undo.
7076 Set to a negative number for no undo at all: >
7077 set ul=-1
7078< This helps when you run out of memory for a single change.
7079 Also see |undo-two-ways|.
7080
7081 *'updatecount'* *'uc'*
7082'updatecount' 'uc' number (default: 200)
7083 global
7084 {not in Vi}
7085 After typing this many characters the swap file will be written to
7086 disk. When zero, no swap file will be created at all (see chapter on
7087 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7088 Vim with the "-n" option, see |startup|. When editing in readonly
7089 mode this option will be initialized to 10000.
7090 The swapfile can be disabled per buffer with |'swapfile'|.
7091 When 'updatecount' is set from zero to non-zero, swap files are
7092 created for all buffers that have 'swapfile' set. When 'updatecount'
7093 is set to zero, existing swap files are not deleted.
7094 Also see |'swapsync'|.
7095 This option has no meaning in buffers where |'buftype'| is "nofile"
7096 or "nowrite".
7097
7098 *'updatetime'* *'ut'*
7099'updatetime' 'ut' number (default 4000)
7100 global
7101 {not in Vi}
7102 If this many milliseconds nothing is typed the swap file will be
7103 written to disk (see |crash-recovery|). Also used for the
7104 |CursorHold| autocommand event.
7105
7106 *'verbose'* *'vbs'*
7107'verbose' 'vbs' number (default 0)
7108 global
7109 {not in Vi, although some versions have a boolean
7110 verbose option}
7111 When bigger than zero, Vim will give messages about what it is doing.
7112 Currently, these messages are given:
7113 >= 1 When the viminfo file is read or written.
7114 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007115 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007116 >= 8 Files for which a group of autocommands is executed.
7117 >= 9 Every executed autocommand.
7118 >= 12 Every executed function.
7119 >= 13 When an exception is thrown, caught, finished, or discarded.
7120 >= 14 Anything pending in a ":finally" clause.
7121 >= 15 Every executed Ex command (truncated at 200 characters).
7122
7123 This option can also be set with the "-V" argument. See |-V|.
7124 This option is also set by the |:verbose| command.
7125
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007126 When the 'verbosefile' option is set then the verbose messages are not
7127 displayed.
7128
7129 *'verbosefile'* *'vfile'*
7130'verbosefile' 'vfile' string (default empty)
7131 global
7132 {not in Vi}
7133 When not empty all messages are written in a file with this name.
7134 When the file exists messages are appended.
7135 Writing to the file ends when Vim exits or when 'verbosefile' is made
7136 empty.
7137 Setting 'verbosefile' to a new value is like making it empty first.
7138 The difference with |:redir| is that verbose messages are not
7139 displayed when 'verbosefile' is set.
7140
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141 *'viewdir'* *'vdir'*
7142'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7143 "$VIM/vimfiles/view",
7144 for Unix: "~/.vim/view",
7145 for Macintosh: "$VIM:vimfiles:view"
7146 for VMS: "sys$login:vimfiles/view"
7147 for RiscOS: "Choices:vimfiles/view")
7148 global
7149 {not in Vi}
7150 {not available when compiled without the +mksession
7151 feature}
7152 Name of the directory where to store files for |:mkview|.
7153 This option cannot be set from a |modeline| or in the |sandbox|, for
7154 security reasons.
7155
7156 *'viewoptions'* *'vop'*
7157'viewoptions' 'vop' string (default: "folds,options,cursor")
7158 global
7159 {not in Vi}
7160 {not available when compiled without the +mksession
7161 feature}
7162 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007163 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 word save and restore ~
7165 cursor cursor position in file and in window
7166 folds manually created folds, opened/closed folds and local
7167 fold options
7168 options options and mappings local to a window or buffer (not
7169 global values for local options)
7170 slash backslashes in file names replaced with forward
7171 slashes
7172 unix with Unix end-of-line format (single <NL>), even when
7173 on Windows or DOS
7174
7175 "slash" and "unix" are useful on Windows when sharing view files
7176 with Unix. The Unix version of Vim cannot source dos format scripts,
7177 but the Windows version of Vim can source unix format scripts.
7178
7179 *'viminfo'* *'vi'* *E526* *E527* *E528*
7180'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
7181 Windows and OS/2: '20,<50,s10,h,rA:,rB:,
7182 for Amiga: '20,<50,s10,h,rdf0:,rdf1:,rdf2:
7183 for others: '20,<50,s10,h)
7184 global
7185 {not in Vi}
7186 {not available when compiled without the |+viminfo|
7187 feature}
7188 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007189 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 separated list of parameters, each consisting of a single character
7191 identifying the particular parameter, followed by a number or string
7192 which specifies the value of that parameter. If a particular
7193 character is left out, then the default value is used for that
7194 parameter. The following is a list of the identifying characters and
7195 the effect of their value.
7196 CHAR VALUE ~
7197 ! When included, save and restore global variables that start
7198 with an uppercase letter, and don't contain a lowercase
7199 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007200 and "_K_L_M" are not. Only String and Number types are
7201 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 " Maximum number of lines saved for each register. Old name of
7203 the '<' item, with the disadvantage that you need to put a
7204 backslash before the ", otherwise it will be recognized as the
7205 start of a comment!
7206 % When included, save and restore the buffer list. If Vim is
7207 started with a file name argument, the buffer list is not
7208 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007209 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007210 without a file name and buffers for help files are not written
7211 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007212 When followed by a number, the number specifies the maximum
7213 number of buffers that are stored. Without a number all
7214 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 ' Maximum number of previously edited files for which the marks
7216 are remembered. This parameter must always be included when
7217 'viminfo' is non-empty.
7218 Including this item also means that the |jumplist| and the
7219 |changelist| are stored in the viminfo file.
7220 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007221 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 patterns are also saved. When not included, the value of
7223 'history' is used.
7224 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007225 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 < Maximum number of lines saved for each register. If zero then
7227 registers are not saved. When not included, all lines are
7228 saved. '"' is the old name for this item.
7229 Also see the 's' item below: limit specified in Kbyte.
7230 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007231 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 c When included, convert the text in the viminfo file from the
7233 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007234 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 f Whether file marks need to be stored. If zero, file marks ('0
7236 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007237 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 cursor position (when exiting or when doing ":wviminfo").
7239 h Disable the effect of 'hlsearch' when loading the viminfo
7240 file. When not included, it depends on whether ":nohlsearch"
7241 has been used since the last search command.
7242 n Name of the viminfo file. The name must immediately follow
7243 the 'n'. Must be the last one! If the "-i" argument was
7244 given when starting Vim, that file name overrides the one
7245 given here with 'viminfo'. Environment variables are expanded
7246 when opening the file, not when setting the option.
7247 r Removable media. The argument is a string (up to the next
7248 ','). This parameter can be given several times. Each
7249 specifies the start of a path for which no marks will be
7250 stored. This is to avoid removable media. For MS-DOS you
7251 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7252 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7253 ignored. Maximum length of each 'r' argument is 50
7254 characters.
7255 s Maximum size of an item in Kbyte. If zero then registers are
7256 not saved. Currently only applies to registers. The default
7257 "s10" will exclude registers with more than 10 Kbyte of text.
7258 Also see the '<' item above: line count limit.
7259
7260 Example: >
7261 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7262<
7263 '50 Marks will be remembered for the last 50 files you
7264 edited.
7265 <1000 Contents of registers (up to 1000 lines each) will be
7266 remembered.
7267 s100 Registers with more than 100 Kbyte text are skipped.
7268 :0 Command-line history will not be saved.
7269 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7270 no / Since '/' is not specified, the default will be used,
7271 that is, save all of the search history, and also the
7272 previous search and substitute patterns.
7273 no % The buffer list will not be saved nor read back.
7274 no h 'hlsearch' highlighting will be restored.
7275
7276 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7277 load the contents of the file, this is not done automatically.
7278
7279 This option cannot be set from a |modeline| or in the |sandbox|, for
7280 security reasons.
7281
7282 *'virtualedit'* *'ve'*
7283'virtualedit' 've' string (default "")
7284 global
7285 {not in Vi}
7286 {not available when compiled without the
7287 |+virtualedit| feature}
7288 A comma separated list of these words:
7289 block Allow virtual editing in Visual block mode.
7290 insert Allow virtual editing in Insert mode.
7291 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007292 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007293
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 Virtual editing means that the cursor can be positioned where there is
7295 no actual character. This can be halfway into a Tab or beyond the end
7296 of the line. Useful for selecting a rectangle in Visual mode and
7297 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007298 "onemore" is not the same, it will only allow moving the cursor just
7299 after the last character of the line. This makes some commands more
7300 consistent. Previously the cursor was always past the end of the line
7301 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007302 break some plugins or Vim scripts. For example because |l| can move
7303 the cursor after the last character. Use with care!
7304 Using the |$| command will move to the last character in the line, not
7305 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007306 It doesn't make sense to combine "all" with "onemore", but you will
7307 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007308
7309 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7310'visualbell' 'vb' boolean (default off)
7311 global
7312 {not in Vi}
7313 Use visual bell instead of beeping. The terminal code to display the
7314 visual bell is given with 't_vb'. When no beep or flash is wanted,
7315 use ":set vb t_vb=".
7316 Note: When the GUI starts, 't_vb' is reset to its default value. You
7317 might want to set it again in your |gvimrc|.
7318 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7319 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7320 where 40 is the time in msec.
7321 Does not work on the Amiga, you always get a screen flash.
7322 Also see 'errorbells'.
7323
7324 *'warn'* *'nowarn'*
7325'warn' boolean (default on)
7326 global
7327 Give a warning message when a shell command is used while the buffer
7328 has been changed.
7329
7330 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7331'weirdinvert' 'wiv' boolean (default off)
7332 global
7333 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007334 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 It is provided for backwards compatibility with version 4.x.
7336 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7337 vice versa. Has no effect when the GUI is running.
7338
7339 *'whichwrap'* *'ww'*
7340'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7341 global
7342 {not in Vi}
7343 Allow specified keys that move the cursor left/right to move to the
7344 previous/next line when the cursor is on the first/last character in
7345 the line. Concatenate characters to allow this for these keys:
7346 char key mode ~
7347 b <BS> Normal and Visual
7348 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007349 h "h" Normal and Visual (not recommended)
7350 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 < <Left> Normal and Visual
7352 > <Right> Normal and Visual
7353 ~ "~" Normal
7354 [ <Left> Insert and Replace
7355 ] <Right> Insert and Replace
7356 For example: >
7357 :set ww=<,>,[,]
7358< allows wrap only when cursor keys are used.
7359 When the movement keys are used in combination with a delete or change
7360 operator, the <EOL> also counts for a character. This makes "3h"
7361 different from "3dh" when the cursor crosses the end of a line. This
7362 is also true for "x" and "X", because they do the same as "dl" and
7363 "dh". If you use this, you may also want to use the mapping
7364 ":map <BS> X" to make backspace delete the character in front of the
7365 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007366 When 'l' is included and it is used after an operator at the end of a
7367 line then it will not move to the next line. This makes "dl", "cl",
7368 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007369 NOTE: This option is set to the Vi default value when 'compatible' is
7370 set and to the Vim default value when 'compatible' is reset.
7371
7372 *'wildchar'* *'wc'*
7373'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7374 global
7375 {not in Vi}
7376 Character you have to type to start wildcard expansion in the
7377 command-line, as specified with 'wildmode'.
7378 The character is not recognized when used inside a macro. See
7379 'wildcharm' for that.
7380 Although 'wc' is a number option, you can set it to a special key: >
7381 :set wc=<Esc>
7382< NOTE: This option is set to the Vi default value when 'compatible' is
7383 set and to the Vim default value when 'compatible' is reset.
7384
7385 *'wildcharm'* *'wcm'*
7386'wildcharm' 'wcm' number (default: none (0))
7387 global
7388 {not in Vi}
7389 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007390 recognized when used inside a macro. You can find "spare" command-line
7391 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007392 you'll never actually type 'wildcharm', just use it in mappings that
7393 automatically invoke completion mode, e.g.: >
7394 :set wcm=<C-Z>
7395 :cmap ss so $vim/sessions/*.vim<C-Z>
7396< Then after typing :ss you can use CTRL-P & CTRL-N.
7397
7398 *'wildignore'* *'wig'*
7399'wildignore' 'wig' string (default "")
7400 global
7401 {not in Vi}
7402 {not available when compiled without the |+wildignore|
7403 feature}
7404 A list of file patterns. A file that matches with one of these
7405 patterns is ignored when completing file or directory names.
7406 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7407 Also see 'suffixes'.
7408 Example: >
7409 :set wildignore=*.o,*.obj
7410< The use of |:set+=| and |:set-=| is preferred when adding or removing
7411 a pattern from the list. This avoids problems when a future version
7412 uses another default.
7413
7414 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7415'wildmenu' 'wmnu' boolean (default off)
7416 global
7417 {not in Vi}
7418 {not available if compiled without the |+wildmenu|
7419 feature}
7420 When 'wildmenu' is on, command-line completion operates in an enhanced
7421 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7422 the possible matches are shown just above the command line, with the
7423 first match highlighted (overwriting the status line, if there is
7424 one). Keys that show the previous/next match, such as <Tab> or
7425 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7426 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7427 specified. "longest" and "list" do not start "wildmenu" mode.
7428 If there are more matches than can fit in the line, a ">" is shown on
7429 the right and/or a "<" is shown on the left. The status line scrolls
7430 as needed.
7431 The "wildmenu" mode is abandoned when a key is hit that is not used
7432 for selecting a completion.
7433 While the "wildmenu" is active the following keys have special
7434 meanings:
7435
7436 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7437 <Down> - in filename/menu name completion: move into a
7438 subdirectory or submenu.
7439 <CR> - in menu completion, when the cursor is just after a
7440 dot: move into a submenu.
7441 <Up> - in filename/menu name completion: move up into
7442 parent directory or parent menu.
7443
7444 This makes the menus accessible from the console |console-menus|.
7445
7446 If you prefer the <Left> and <Right> keys to move the cursor instead
7447 of selecting a different match, use this: >
7448 :cnoremap <Left> <Space><BS><Left>
7449 :cnoremap <Right> <Space><BS><Right>
7450<
7451 The "WildMenu" highlighting is used for displaying the current match
7452 |hl-WildMenu|.
7453
7454 *'wildmode'* *'wim'*
7455'wildmode' 'wim' string (Vim default: "full")
7456 global
7457 {not in Vi}
7458 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007459 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar071d4272004-06-13 20:20:40 +00007460 part specifies what to do for each consecutive use of 'wildchar. The
7461 first part specifies the behavior for the first use of 'wildchar',
7462 The second part for the second use, etc.
7463 These are the possible values for each part:
7464 "" Complete only the first match.
7465 "full" Complete the next full match. After the last match,
7466 the original string is used and then the first match
7467 again.
7468 "longest" Complete till longest common string. If this doesn't
7469 result in a longer string, use the next part.
7470 "longest:full" Like "longest", but also start 'wildmenu' if it is
7471 enabled.
7472 "list" When more than one match, list all matches.
7473 "list:full" When more than one match, list all matches and
7474 complete first match.
7475 "list:longest" When more than one match, list all matches and
7476 complete till longest common string.
7477 When there is only a single match, it is fully completed in all cases.
7478
7479 Examples: >
7480 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007481< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007482 :set wildmode=longest,full
7483< Complete longest common string, then each full match >
7484 :set wildmode=list:full
7485< List all matches and complete each full match >
7486 :set wildmode=list,full
7487< List all matches without completing, then each full match >
7488 :set wildmode=longest,list
7489< Complete longest common string, then list alternatives.
7490
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007491 *'wildoptions'* *'wop'*
7492'wildoptions' 'wop' string (default "")
7493 global
7494 {not in Vi}
7495 {not available when compiled without the |+wildignore|
7496 feature}
7497 A list of words that change how command line completion is done.
7498 Currently only one word is allowed:
7499 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007500 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007501 is displayed per line. Often used tag kinds are:
7502 d #define
7503 f function
7504 Also see |cmdline-completion|.
7505
Bram Moolenaar071d4272004-06-13 20:20:40 +00007506 *'winaltkeys'* *'wak'*
7507'winaltkeys' 'wak' string (default "menu")
7508 global
7509 {not in Vi}
7510 {only used in Win32, Motif, GTK and Photon GUI}
7511 Some GUI versions allow the access to menu entries by using the ALT
7512 key in combination with a character that appears underlined in the
7513 menu. This conflicts with the use of the ALT key for mappings and
7514 entering special characters. This option tells what to do:
7515 no Don't use ALT keys for menus. ALT key combinations can be
7516 mapped, but there is no automatic handling. This can then be
7517 done with the |:simalt| command.
7518 yes ALT key handling is done by the windowing system. ALT key
7519 combinations cannot be mapped.
7520 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007521 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 keys can be mapped.
7523 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7524 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007525 This option is not used for <F10>; on Win32 and with GTK <F10> will
7526 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007528 *'window'* *'wi'*
7529'window' 'wi' number (default screen height - 1)
7530 global
7531 Window height. Do not confuse this with the height of the Vim window,
7532 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007533 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7534 value is smaller than 'lines' minus one. The screen will scroll
7535 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007536 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7537 in a much smarter way, taking care of wrapping lines.
7538 When resizing the Vim window, the value is smaller than 1 or more than
7539 or equal to 'lines' it will be set to 'lines' minus 1.
7540 {Vi also uses the option to specify the number of displayed lines}
7541
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542 *'winheight'* *'wh'* *E591*
7543'winheight' 'wh' number (default 1)
7544 global
7545 {not in Vi}
7546 {not available when compiled without the +windows
7547 feature}
7548 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007549 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 current window is smaller, its size is increased, at the cost of the
7551 height of other windows. Set it to 999 to make the current window
7552 always fill the screen (although this has the drawback that ":all"
7553 will create only two windows). Set it to a small number for normal
7554 editing.
7555 Minimum value is 1.
7556 The height is not adjusted after one of the commands to change the
7557 height of the current window.
7558 'winheight' applies to the current window. Use 'winminheight' to set
7559 the minimal height for other windows.
7560
7561 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7562'winfixheight' 'wfh' boolean (default off)
7563 local to window
7564 {not in Vi}
7565 {not available when compiled without the +windows
7566 feature}
7567 Keep the window height when windows are opened or closed and
7568 'equalalways' is set. Set by default for the |preview-window| and
7569 |quickfix-window|.
7570 The height may be changed anyway when running out of room.
7571
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007572 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7573'winfixwidth' 'wfw' boolean (default off)
7574 local to window
7575 {not in Vi}
7576 {not available when compiled without the +windows
7577 feature}
7578 Keep the window width when windows are opened or closed and
7579 'equalalways' is set.
7580 The width may be changed anyway when running out of room.
7581
Bram Moolenaar071d4272004-06-13 20:20:40 +00007582 *'winminheight'* *'wmh'*
7583'winminheight' 'wmh' number (default 1)
7584 global
7585 {not in Vi}
7586 {not available when compiled without the +windows
7587 feature}
7588 The minimal height of a window, when it's not the current window.
7589 This is a hard minimum, windows will never become smaller.
7590 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7591 status bar) if necessary. They will return to at least one line when
7592 they become active (since the cursor has to have somewhere to go.)
7593 Use 'winheight' to set the minimal height of the current window.
7594 This option is only checked when making a window smaller. Don't use a
7595 large number, it will cause errors when opening more than a few
7596 windows. A value of 0 to 3 is reasonable.
7597
7598 *'winminwidth'* *'wmw'*
7599'winminwidth' 'wmw' number (default 1)
7600 global
7601 {not in Vi}
7602 {not available when compiled without the +vertsplit
7603 feature}
7604 The minimal width of a window, when it's not the current window.
7605 This is a hard minimum, windows will never become smaller.
7606 When set to zero, windows may be "squashed" to zero columns (i.e. just
7607 a vertical separator) if necessary. They will return to at least one
7608 line when they become active (since the cursor has to have somewhere
7609 to go.)
7610 Use 'winwidth' to set the minimal width of the current window.
7611 This option is only checked when making a window smaller. Don't use a
7612 large number, it will cause errors when opening more than a few
7613 windows. A value of 0 to 12 is reasonable.
7614
7615 *'winwidth'* *'wiw'* *E592*
7616'winwidth' 'wiw' number (default 20)
7617 global
7618 {not in Vi}
7619 {not available when compiled without the +vertsplit
7620 feature}
7621 Minimal number of columns for the current window. This is not a hard
7622 minimum, Vim will use fewer columns if there is not enough room. If
7623 the current window is smaller, its size is increased, at the cost of
7624 the width of other windows. Set it to 999 to make the current window
7625 always fill the screen. Set it to a small number for normal editing.
7626 The width is not adjusted after one of the commands to change the
7627 width of the current window.
7628 'winwidth' applies to the current window. Use 'winminwidth' to set
7629 the minimal width for other windows.
7630
7631 *'wrap'* *'nowrap'*
7632'wrap' boolean (default on)
7633 local to window
7634 {not in Vi}
7635 This option changes how text is displayed. It doesn't change the text
7636 in the buffer, see 'textwidth' for that.
7637 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007638 displaying continues on the next line. When off lines will not wrap
7639 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 moved to a part that is not shown, the screen will scroll
7641 horizontally.
7642 The line will be broken in the middle of a word if necessary. See
7643 'linebreak' to get the break at a word boundary.
7644 To make scrolling horizontally a bit more useful, try this: >
7645 :set sidescroll=5
7646 :set listchars+=precedes:<,extends:>
7647< See 'sidescroll', 'listchars' and |wrap-off|.
7648
7649 *'wrapmargin'* *'wm'*
7650'wrapmargin' 'wm' number (default 0)
7651 local to buffer
7652 Number of characters from the right window border where wrapping
7653 starts. When typing text beyond this limit, an <EOL> will be inserted
7654 and inserting continues on the next line.
7655 Options that add a margin, such as 'number' and 'foldcolumn', cause
7656 the text width to be further reduced. This is Vi compatible.
7657 When 'textwidth' is non-zero, this option is not used.
7658 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7659 and less usefully}
7660
7661 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7662'wrapscan' 'ws' boolean (default on) *E384* *E385*
7663 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007664 Searches wrap around the end of the file. Also applies to |]s| and
7665 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007666
7667 *'write'* *'nowrite'*
7668'write' boolean (default on)
7669 global
7670 {not in Vi}
7671 Allows writing files. When not set, writing a file is not allowed.
7672 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007673 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007674 argument. Filtering text is still possible, even though this requires
7675 writing a temporary file.
7676
7677 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7678'writeany' 'wa' boolean (default off)
7679 global
7680 Allows writing to any file with no need for "!" override.
7681
7682 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7683'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7684 otherwise)
7685 global
7686 {not in Vi}
7687 Make a backup before overwriting a file. The backup is removed after
7688 the file was successfully written, unless the 'backup' option is
7689 also on. Reset this option if your file system is almost full. See
7690 |backup-table| for another explanation.
7691 When the 'backupskip' pattern matches, a backup is not made anyway.
7692 NOTE: This option is set to the default value when 'compatible' is
7693 set.
7694
7695 *'writedelay'* *'wd'*
7696'writedelay' 'wd' number (default 0)
7697 global
7698 {not in Vi}
7699 The number of microseconds to wait for each character sent to the
7700 screen. When non-zero, characters are sent to the terminal one by
7701 one. For MS-DOS pcterm this does not work. For debugging purposes.
7702
7703 vim:tw=78:ts=8:ft=help:norl: