blob: f1785bb85413996f31ec07473a30506fd57f0006 [file] [log] [blame]
Bram Moolenaarfff2bee2010-05-15 13:56:02 +02001*options.txt* For Vim version 7.3a. Last change: 2010 May 13
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
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
45:se[t] inv{option} Toggle option: Invert value. {not in Vi}
46
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
49 current value of 'compatible'. {not in Vi}
50:se[t] {option}&vi Reset option to its Vi default value. {not in Vi}
51:se[t] {option}&vim Reset option to its Vim default value. {not in Vi}
52
53:se[t] all& Set all options, except terminal options, to their
Bram Moolenaarf4b8e572004-06-24 15:53:16 +000054 default value. The values of 'term', 'lines' and
Bram Moolenaar071d4272004-06-13 20:20:40 +000055 'columns' are not changed. {not in Vi}
56
57 *:set-args* *E487* *E521*
58:se[t] {option}={value} or
59:se[t] {option}:{value}
60 Set string or number option to {value}.
61 For numeric options the value can be given in decimal,
62 hex (preceded with 0x) or octal (preceded with '0')
63 (hex and octal are only available for machines which
64 have the strtol() function).
65 The old value can be inserted by typing 'wildchar' (by
66 default this is a <Tab> or CTRL-E if 'compatible' is
67 set). See |cmdline-completion|.
68 White space between {option} and '=' is allowed and
69 will be ignored. White space between '=' and {value}
70 is not allowed.
71 See |option-backslash| for using white space and
72 backslashes in {value}.
73
74:se[t] {option}+={value} *:set+=*
75 Add the {value} to a number option, or append the
76 {value} to a string option. When the option is a
77 comma separated list, a comma is added, unless the
78 value was empty.
79 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000080 are removed. When adding a flag that was already
81 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000082 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000083 {not in Vi}
84
85:se[t] {option}^={value} *:set^=*
86 Multiply the {value} to a number option, or prepend
87 the {value} to a string option. When the option is a
88 comma separated list, a comma is added, unless the
89 value was empty.
90 Also see |:set-args| above.
91 {not in Vi}
92
93:se[t] {option}-={value} *:set-=*
94 Subtract the {value} from a number option, or remove
95 the {value} from a string option, if it is there.
96 If the {value} is not found in a string option, there
97 is no error or warning. When the option is a comma
98 separated list, a comma is deleted, unless the option
99 becomes empty.
100 When the option is a list of flags, {value} must be
101 exactly as they appear in the option. Remove flags
102 one by one to avoid problems.
103 Also see |:set-args| above.
104 {not in Vi}
105
106The {option} arguments to ":set" may be repeated. For example: >
107 :set ai nosi sw=3 ts=3
108If you make an error in one of the arguments, an error message will be given
109and the following arguments will be ignored.
110
111 *:set-verbose*
112When 'verbose' is non-zero, displaying an option value will also tell where it
113was last set. Example: >
114 :verbose set shiftwidth cindent?
Bram Moolenaar446cb832008-06-24 21:56:24 +0000115< shiftwidth=4 ~
116 Last set from modeline ~
117 cindent ~
118 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim ~
119This is only done when specific option values are requested, not for ":verbose
120set all" or ":verbose set" without an argument.
121When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000122When the option was set while executing a function, user command or
123autocommand, the script in which it was defined is reported.
124Note that an option may also have been set as a side effect of setting
125'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000126A few special texts:
127 Last set from modeline ~
128 Option was set in a |modeline|.
129 Last set from --cmd argument ~
130 Option was set with command line argument |--cmd| or +.
131 Last set from -c argument ~
132 Option was set with command line argument |-c|, +, |-S| or
133 |-q|.
134 Last set from environment variable ~
135 Option was set from an environment variable, $VIMINIT,
136 $GVIMINIT or $EXINIT.
137 Last set from error handler ~
138 Option was cleared when evaluating it resulted in an error.
139
Bram Moolenaar071d4272004-06-13 20:20:40 +0000140{not available when compiled without the +eval feature}
141
142 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000143For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000144override the value from the termcap. You can then use it in a mapping. If
145the "xx" part contains special characters, use the <t_xx> form: >
146 :set <t_#4>=^[Ot
147This can also be used to translate a special code for a normal key. For
148example, if Alt-b produces <Esc>b, use this: >
149 :set <M-b>=^[b
150(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
151The advantage over a mapping is that it works in all situations.
152
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000153The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
154security reasons.
155
Bram Moolenaar071d4272004-06-13 20:20:40 +0000156The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000157at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000158"set all" probably does not fit on the screen, causing Vim to give the
159|more-prompt|.
160
161 *option-backslash*
162To include white space in a string option value it has to be preceded with a
163backslash. To include a backslash you have to use two. Effectively this
164means that the number of backslashes in an option value is halved (rounded
165down).
166A few examples: >
167 :set tags=tags\ /usr/tags results in "tags /usr/tags"
168 :set tags=tags\\,file results in "tags\,file"
169 :set tags=tags\\\ file results in "tags\ file"
170
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000171The "|" character separates a ":set" command from a following command. To
172include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000173'titlestring' option to "hi|there": >
174 :set titlestring=hi\|there
175This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
176 :set titlestring=hi|set iconstring=there
177
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000178Similarly, the double quote character starts a comment. To include the '"' in
179the option value, use '\"' instead. This example sets the 'titlestring'
180option to 'hi "there"': >
181 :set titlestring=hi\ \"there\"
182
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000183For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000184precise: For options that expect a file name (those where environment
185variables are expanded) a backslash before a normal file name character is not
186removed. But a backslash before a special character (space, backslash, comma,
187etc.) is used like explained above.
188There is one special situation, when the value starts with "\\": >
189 :set dir=\\machine\path results in "\\machine\path"
190 :set dir=\\\\machine\\path results in "\\machine\path"
191 :set dir=\\path\\file results in "\\path\file" (wrong!)
192For the first one the start is kept, but for the second one the backslashes
193are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000194halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000195result which is probably not what you want. Avoid it.
196
197 *add-option-flags* *remove-option-flags*
198 *E539* *E550* *E551* *E552*
199Some options are a list of flags. When you want to add a flag to such an
200option, without changing the existing ones, you can do it like this: >
201 :set guioptions+=a
202Remove a flag from an option like this: >
203 :set guioptions-=a
204This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000205Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000206the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
207doesn't appear.
208
209 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000210Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211environment variable exists the '$' and the following environment variable
212name is replaced with its value. If it does not exist the '$' and the name
213are not modified. Any non-id character (not a letter, digit or '_') may
214follow the environment variable name. That character and what follows is
215appended to the value of the environment variable. Examples: >
216 :set term=$TERM.new
217 :set path=/usr/$INCLUDE,$HOME/include,.
218When adding or removing a string from an option with ":set opt-=val" or ":set
219opt+=val" the expansion is done before the adding or removing.
220
221
222Handling of local options *local-options*
223
224Some of the options only apply to a window or buffer. Each window or buffer
225has its own copy of this option, thus can each have their own value. This
226allows you to set 'list' in one window but not in another. And set
227'shiftwidth' to 3 in one buffer and 4 in another.
228
229The following explains what happens to these local options in specific
230situations. You don't really need to know all of this, since Vim mostly uses
231the option values you would expect. Unfortunately, doing what the user
232expects is a bit complicated...
233
234When splitting a window, the local options are copied to the new window. Thus
235right after the split the contents of the two windows look the same.
236
237When editing a new buffer, its local option values must be initialized. Since
238the local options of the current buffer might be specifically for that buffer,
239these are not used. Instead, for each buffer-local option there also is a
240global value, which is used for new buffers. With ":set" both the local and
241global value is changed. With "setlocal" only the local value is changed,
242thus this value is not used when editing a new buffer.
243
244When editing a buffer that has been edited before, the last used window
245options are used again. If this buffer has been edited in this window, the
246values from back then are used. Otherwise the values from the window where
247the buffer was edited last are used.
248
249It's possible to set a local window option specifically for a type of buffer.
250When you edit another buffer in the same window, you don't want to keep
251using these local window options. Therefore Vim keeps a global value of the
252local window options, which is used when editing another buffer. Each window
253has its own copy of these values. Thus these are local to the window, but
254global to all buffers in the window. With this you can do: >
255 :e one
256 :set list
257 :e two
258Now the 'list' option will also be set in "two", since with the ":set list"
259command you have also set the global value. >
260 :set nolist
261 :e one
262 :setlocal list
263 :e two
264Now the 'list' option is not set, because ":set nolist" resets the global
265value, ":setlocal list" only changes the local value and ":e two" gets the
266global value. Note that if you do this next: >
267 :e one
268You will not get back the 'list' value as it was the last time you edited
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000269"one". The options local to a window are not remembered for each buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000270
271 *:setl* *:setlocal*
272:setl[ocal] ... Like ":set" but set only the value local to the
273 current buffer or window. Not all options have a
274 local value. If the option does not have a local
275 value the global value is set.
276 With the "all" argument: display all local option's
277 local values.
278 Without argument: Display all local option's local
279 values which are different from the default.
280 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000281 local value. For a global/local boolean option, when
282 the global value is being used, "--" is displayed
283 before the option name.
284 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000285 shown (but that might change in the future).
286 {not in Vi}
287
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000288:setl[ocal] {option}< Set the local value of {option} to its global value by
289 copying the value.
290 {not in Vi}
291
292:se[t] {option}< Set the local value of {option} to its global value by
293 making it empty. Only makes sense for |global-local|
294 options.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000295 {not in Vi}
296
297 *:setg* *:setglobal*
298:setg[lobal] ... Like ":set" but set only the global value for a local
299 option without changing the local value.
300 When displaying an option, the global value is shown.
301 With the "all" argument: display all local option's
302 global values.
303 Without argument: display all local option's global
304 values which are different from the default.
305 {not in Vi}
306
307For buffer-local and window-local options:
308 Command global value local value ~
309 :set option=value set set
310 :setlocal option=value - set
311:setglobal option=value set -
312 :set option? - display
313 :setlocal option? - display
314:setglobal option? display -
315
316
317Global options with a local value *global-local*
318
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000319Options are global when you mostly use one value for all buffers and windows.
320For some global options it's useful to sometimes have a different local value.
321You can set the local value with ":setlocal". That buffer or window will then
322use the local value, while other buffers and windows continue using the global
323value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000324
325For example, you have two windows, both on C source code. They use the global
326'makeprg' option. If you do this in one of the two windows: >
327 :set makeprg=gmake
328then the other window will switch to the same value. There is no need to set
329the 'makeprg' option in the other C source window too.
330However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000331another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000332files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000333 :setlocal makeprg=perlmake
334You can switch back to using the global value by making the local value empty: >
335 :setlocal makeprg=
336This only works for a string option. For a boolean option you need to use the
337"<" flag, like this: >
338 :setlocal autoread<
339Note that for non-boolean options using "<" copies the global value to the
340local value, it doesn't switch back to using the global value (that matters
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000341when the global value changes later). You can also use: >
342 :set path<
343This will make the local value of 'path' empty, so that the global value is
344used. Thus it does the same as: >
345 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346Note: In the future more global options can be made global-local. Using
347":setlocal" on a global option might work differently then.
348
349
350Setting the filetype
351
352:setf[iletype] {filetype} *:setf* *:setfiletype*
353 Set the 'filetype' option to {filetype}, but only if
354 not done yet in a sequence of (nested) autocommands.
355 This is short for: >
356 :if !did_filetype()
357 : setlocal filetype={filetype}
358 :endif
359< This command is used in a filetype.vim file to avoid
360 setting the 'filetype' option twice, causing different
361 settings and syntax files to be loaded.
362 {not in Vi}
363
364:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
365:opt[ions] Open a window for viewing and setting all options.
366 Options are grouped by function.
367 Offers short help for each option. Hit <CR> on the
368 short help to open a help window with more help for
369 the option.
370 Modify the value of the option and hit <CR> on the
371 "set" line to set the new value. For window and
372 buffer specific options, the last accessed window is
373 used to set the option value in, unless this is a help
374 window, in which case the window below help window is
375 used (skipping the option-window).
376 {not available when compiled without the |+eval| or
377 |+autocmd| features}
378
379 *$HOME*
380Using "~" is like using "$HOME", but it is only recognized at the start of an
381option and after a space or comma.
382
383On Unix systems "~user" can be used too. It is replaced by the home directory
384of user "user". Example: >
385 :set path=~mool/include,/usr/include,.
386
387On Unix systems the form "${HOME}" can be used too. The name between {} can
388contain non-id characters then. Note that if you want to use this for the
389"gf" command, you need to add the '{' and '}' characters to 'isfname'.
390
391NOTE: expanding environment variables and "~/" is only done with the ":set"
392command, not when assigning a value to an option with ":let".
393
394
395Note the maximum length of an expanded option is limited. How much depends on
396the system, mostly it is something like 256 or 1024 characters.
397
398 *:fix* *:fixdel*
399:fix[del] Set the value of 't_kD':
400 't_kb' is 't_kD' becomes ~
401 CTRL-? CTRL-H
402 not CTRL-? CTRL-?
403
404 (CTRL-? is 0177 octal, 0x7f hex) {not in Vi}
405
406 If your delete key terminal code is wrong, but the
407 code for backspace is alright, you can put this in
408 your .vimrc: >
409 :fixdel
410< This works no matter what the actual code for
411 backspace is.
412
413 If the backspace key terminal code is wrong you can
414 use this: >
415 :if &term == "termname"
416 : set t_kb=^V<BS>
417 : fixdel
418 :endif
419< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000420 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000421 with your terminal name.
422
423 If your <Delete> key sends a strange key sequence (not
424 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
425 :if &term == "termname"
426 : set t_kD=^V<Delete>
427 :endif
428< Where "^V" is CTRL-V and "<Delete>" is the delete key
429 (don't type eight characters!). Replace "termname"
430 with your terminal name.
431
432 *Linux-backspace*
433 Note about Linux: By default the backspace key
434 produces CTRL-?, which is wrong. You can fix it by
435 putting this line in your rc.local: >
436 echo "keycode 14 = BackSpace" | loadkeys
437<
438 *NetBSD-backspace*
439 Note about NetBSD: If your backspace doesn't produce
440 the right code, try this: >
441 xmodmap -e "keycode 22 = BackSpace"
442< If this works, add this in your .Xmodmap file: >
443 keysym 22 = BackSpace
444< You need to restart for this to take effect.
445
446==============================================================================
4472. Automatically setting options *auto-setting*
448
449Besides changing options with the ":set" command, there are three alternatives
450to set options automatically for one or more files:
451
4521. When starting Vim initializations are read from various places. See
453 |initialization|. Most of them are performed for all editing sessions,
454 and some of them depend on the directory where Vim is started.
455 You can create an initialization file with |:mkvimrc|, |:mkview| and
456 |:mksession|.
4572. If you start editing a new file, the automatic commands are executed.
458 This can be used to set options for files matching a particular pattern and
459 many other things. See |autocommand|.
4603. If you start editing a new file, and the 'modeline' option is on, a
461 number of lines at the beginning and end of the file are checked for
462 modelines. This is explained here.
463
464 *modeline* *vim:* *vi:* *ex:* *E520*
465There are two forms of modelines. The first form:
466 [text]{white}{vi:|vim:|ex:}[white]{options}
467
468[text] any text or empty
469{white} at least one blank character (<Space> or <Tab>)
470{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
471[white] optional white space
472{options} a list of option settings, separated with white space or ':',
473 where each part between ':' is the argument for a ":set"
Bram Moolenaar02467872007-05-06 13:22:01 +0000474 command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000475
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000476Example:
477 vi:noai:sw=3 ts=6 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000478
479The second form (this is compatible with some versions of Vi):
480
481 [text]{white}{vi:|vim:|ex:}[white]se[t] {options}:[text]
482
483[text] any text or empty
484{white} at least one blank character (<Space> or <Tab>)
485{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
486[white] optional white space
487se[t] the string "set " or "se " (note the space)
488{options} a list of options, separated with white space, which is the
489 argument for a ":set" command
490: a colon
491[text] any text or empty
492
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000493Example:
494 /* vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000495
496The white space before {vi:|vim:|ex:} is required. This minimizes the chance
497that a normal word like "lex:" is caught. There is one exception: "vi:" and
498"vim:" can also be at the start of the line (for compatibility with version
4993.0). Using "ex:" at the start of the line will be ignored (this could be
500short for "example:").
501
502 *modeline-local*
503The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000504buffer and window that contain the file. Although it's possible to set global
505options from a modeline, this is unusual. If you have two windows open and
506the files in it set the same global option to a different value, the result
507depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000509When editing a file that was already loaded, only the window-local options
510from the modeline are used. Thus if you manually changed a buffer-local
511option after opening the file, it won't be changed if you edit the same buffer
512in another window. But window-local options will be set.
513
Bram Moolenaar071d4272004-06-13 20:20:40 +0000514 *modeline-version*
515If the modeline is only to be used for some versions of Vim, the version
516number can be specified where "vim:" is used:
517 vim{vers}: version {vers} or later
518 vim<{vers}: version before {vers}
519 vim={vers}: version {vers}
520 vim>{vers}: version after {vers}
521{vers} is 600 for Vim 6.0 (hundred times the major version plus minor).
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000522For example, to use a modeline only for Vim 6.0 and later:
523 /* vim600: set foldmethod=marker: */ ~
524To use a modeline for Vim before version 5.7:
525 /* vim<570: set sw=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000526There can be no blanks between "vim" and the ":".
527
528
529The number of lines that are checked can be set with the 'modelines' option.
530If 'modeline' is off or 'modelines' is 0 no lines are checked.
531
532Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000533like:
534 /* vi:ts=4: */ ~
535will give an error message for the trailing "*/". This line is OK:
536 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538If an error is detected the rest of the line is skipped.
539
540If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000541backslash in front of the ':' will be removed. Example:
542 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000543This sets the 'dir' option to "c:\tmp". Only a single backslash before the
544':' is removed. Thus to include "\:" you have to specify "\\:".
545
546No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000547might create a Trojan horse text file with modelines). And not all options
548can be set. For some options a flag is set, so that when it's used the
Bram Moolenaar02467872007-05-06 13:22:01 +0000549|sandbox| is effective. Still, there is always a small risk that a modeline
Bram Moolenaar8243a792007-05-01 17:05:03 +0000550causes trouble. E.g., when some joker sets 'textwidth' to 5 all your lines
551are wrapped unexpectedly. So disable modelines before editing untrusted text.
552The mail ftplugin does this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553
554Hint: If you would like to do something else than setting an option, you could
555define an autocommand that checks the file for a specific string. For
556example: >
557 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
558And define a function SetVar() that does something with the line containing
559"VAR".
560
561==============================================================================
5623. Options summary *option-summary*
563
564In the list below all the options are mentioned with their full name and with
565an abbreviation if there is one. Both forms may be used.
566
567In this document when a boolean option is "set" that means that ":set option"
568is entered. When an option is "reset", ":set nooption" is used.
569
570For some options there are two default values: The "Vim default", which is
571used when 'compatible' is not set, and the "Vi default", which is used when
572'compatible' is set.
573
574Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000575are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000576different value in each window. For example the 'list' option can be set in
577one window and reset in another for the same text, giving both types of view
578at the same time. There are a few options that are specific to a certain
579file. These can have a different value for each file or buffer. For example
580the 'textwidth' option can be 78 for a normal text file and 0 for a C
581program.
582
583 global one option for all buffers and windows
584 local to window each window has its own copy of this option
585 local to buffer each buffer has its own copy of this option
586
587When creating a new window the option values from the currently active window
588are used as a default value for the window-specific options. For the
589buffer-specific options this depends on the 's' and 'S' flags in the
590'cpoptions' option. If 's' is included (which is the default) the values for
591buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000592first entered. If 'S' is present the options are copied each time the buffer
593is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000594present, the options are copied from the currently active buffer when the
595buffer is created.
596
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000597Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000598
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000599Not all options are supported in all versions. This depends on the supported
600features and sometimes on the system. A remark about this is in curly braces
601below. When an option is not supported it may still be set without getting an
602error, this is called a hidden option. You can't get the value of a hidden
603option though, it is not stored.
604
605To test if option "foo" can be used with ":set" use something like this: >
606 if exists('&foo')
607This also returns true for a hidden option. To test if option "foo" is really
608supported use something like this: >
609 if exists('+foo')
610<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000611 *E355*
612A jump table for the options with a short description can be found at |Q_op|.
613
614 *'aleph'* *'al'* *aleph* *Aleph*
615'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
616 global
617 {not in Vi}
618 {only available when compiled with the |+rightleft|
619 feature}
620 The ASCII code for the first letter of the Hebrew alphabet. The
621 routine that maps the keyboard in Hebrew mode, both in Insert mode
622 (when hkmap is set) and on the command-line (when hitting CTRL-_)
623 outputs the Hebrew characters in the range [aleph..aleph+26].
624 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
625 See |rileft.txt|.
626
627 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
628'allowrevins' 'ari' boolean (default off)
629 global
630 {not in Vi}
631 {only available when compiled with the |+rightleft|
632 feature}
633 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
634 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
635 into reverse Insert mode, and don't know how to get out. See
636 'revins'.
637 NOTE: This option is reset when 'compatible' is set.
638
639 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
640'altkeymap' 'akm' boolean (default off)
641 global
642 {not in Vi}
643 {only available when compiled with the |+farsi|
644 feature}
Bram Moolenaar582fd852005-03-28 20:58:01 +0000645 When on, the second language is Farsi. In editing mode CTRL-_ toggles
Bram Moolenaar071d4272004-06-13 20:20:40 +0000646 the keyboard map between Farsi and English, when 'allowrevins' set.
647
Bram Moolenaar582fd852005-03-28 20:58:01 +0000648 When off, the keyboard map toggles between Hebrew and English. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000649 is useful to start the Vim in native mode i.e. English (left-to-right
650 mode) and have default second language Farsi or Hebrew (right-to-left
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000651 mode). See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000652
653 *'ambiwidth'* *'ambw'*
654'ambiwidth' 'ambw' string (default: "single")
655 global
656 {not in Vi}
657 {only available when compiled with the |+multi_byte|
658 feature}
659 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
660 Tells Vim what to do with characters with East Asian Width Class
661 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
662 letters, Cyrillic letters).
663
664 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000665 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000666 expected by most users.
667 "double": Use twice the width of ASCII characters.
668
669 There are a number of CJK fonts for which the width of glyphs for
670 those characters are solely based on how many octets they take in
671 legacy/traditional CJK encodings. In those encodings, Euro,
672 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000673 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000674 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000675 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000676 Vim is running inside a terminal (emulators) that uses a CJK font
677 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
678 this option should be set to "double" to match the width perceived
679 by Vim with the width of glyphs in the font. Perhaps it also has
680 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
681 when the system locale is set to one of CJK locales. See Unicode
682 Standard Annex #11 (http://www.unicode.org/reports/tr11).
683
684 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
685'antialias' 'anti' boolean (default: off)
686 global
687 {not in Vi}
688 {only available when compiled with GUI enabled
689 on Mac OS X}
690 This option only has an effect in the GUI version of Vim on Mac OS X
691 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
692 which can be easier to read at certain sizes on certain displays.
693 Setting this option can sometimes cause problems if 'guifont' is set
694 to its default (empty string).
695
696 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
697'autochdir' 'acd' boolean (default off)
698 global
699 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200700 {only available when compiled with it, use
701 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000702 When on, Vim will change the current working directory whenever you
703 open a file, switch buffers, delete a buffer or open/close a window.
704 It will change to the directory containing the file which was opened
705 or selected.
706 This option is provided for backward compatibility with the Vim
707 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000708 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000709
710 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
711'arabic' 'arab' boolean (default off)
712 local to window
713 {not in Vi}
714 {only available when compiled with the |+arabic|
715 feature}
716 This option can be set to start editing Arabic text.
717 Setting this option will:
718 - Set the 'rightleft' option, unless 'termbidi' is set.
719 - Set the 'arabicshape' option, unless 'termbidi' is set.
720 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
721 between typing English and Arabic key mapping.
722 - Set the 'delcombine' option
723 Note that 'encoding' must be "utf-8" for working with Arabic text.
724
725 Resetting this option will:
726 - Reset the 'rightleft' option.
727 - Disable the use of 'keymap' (without changing its value).
728 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
729 option.
730 Also see |arabic.txt|.
731
732 *'arabicshape'* *'arshape'*
733 *'noarabicshape'* *'noarshape'*
734'arabicshape' 'arshape' boolean (default on)
735 global
736 {not in Vi}
737 {only available when compiled with the |+arabic|
738 feature}
739 When on and 'termbidi' is off, the required visual character
740 corrections that need to take place for displaying the Arabic language
741 take affect. Shaping, in essence, gets enabled; the term is a broad
742 one which encompasses:
743 a) the changing/morphing of characters based on their location
744 within a word (initial, medial, final and stand-alone).
745 b) the enabling of the ability to compose characters
746 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100747 When disabled the display shows each character's true stand-alone
748 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000749 Arabic is a complex language which requires other settings, for
750 further details see |arabic.txt|.
751
752 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
753'autoindent' 'ai' boolean (default off)
754 local to buffer
755 Copy indent from current line when starting a new line (typing <CR>
756 in Insert mode or when using the "o" or "O" command). If you do not
757 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000758 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
759 to another line has the same effect, unless the 'I' flag is included
760 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000761 When autoindent is on, formatting (with the "gq" command or when you
762 reach 'textwidth' in Insert mode) uses the indentation of the first
763 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 When 'smartindent' or 'cindent' is on the indent is changed in
765 a different way.
766 The 'autoindent' option is reset when the 'paste' option is set.
767 {small difference from Vi: After the indent is deleted when typing
768 <Esc> or <CR>, the cursor position when moving up or down is after the
769 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
770
771 *'autoread'* *'ar'* *'noautoread'* *'noar'*
772'autoread' 'ar' boolean (default off)
773 global or local to buffer |global-local|
774 {not in Vi}
775 When a file has been detected to have been changed outside of Vim and
776 it has not been changed inside of Vim, automatically read it again.
777 When the file has been deleted this is not done. |timestamp|
778 If this option has a local value, use this command to switch back to
779 using the global value: >
780 :set autoread<
781<
782 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
783'autowrite' 'aw' boolean (default off)
784 global
785 Write the contents of the file, if it has been modified, on each
786 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000787 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000788 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
789 Note that for some commands the 'autowrite' option is not used, see
790 'autowriteall' for that.
791
792 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
793'autowriteall' 'awa' boolean (default off)
794 global
795 {not in Vi}
796 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
797 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
798 Setting this option also implies that Vim behaves like 'autowrite' has
799 been set.
800
801 *'background'* *'bg'*
802'background' 'bg' string (default "dark" or "light")
803 global
804 {not in Vi}
805 When set to "dark", Vim will try to use colors that look good on a
806 dark background. When set to "light", Vim will try to use colors that
807 look good on a light background. Any other value is illegal.
808 Vim tries to set the default value according to the terminal used.
809 This will not always be correct.
810 Setting this option does not change the background color, it tells Vim
811 what the background color looks like. For changing the background
812 color, see |:hi-normal|.
813
814 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000815 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000816 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100817 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000818 setting 'background' will cause the color scheme to be reloaded. If
819 the color scheme adjusts to the value of 'background' this will work.
820 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100821 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000822
823 When setting 'background' to the default value with: >
824 :set background&
825< Vim will guess the value. In the GUI this should work correctly,
826 in other cases Vim might not be able to guess the right value.
827
828 When starting the GUI, the default value for 'background' will be
829 "light". When the value is not set in the .gvimrc, and Vim detects
830 that the background is actually quite dark, 'background' is set to
831 "dark". But this happens only AFTER the .gvimrc file has been read
832 (because the window needs to be opened to find the actual background
833 color). To get around this, force the GUI window to be opened by
834 putting a ":gui" command in the .gvimrc file, before where the value
835 of 'background' is used (e.g., before ":syntax on").
836 Normally this option would be set in the .vimrc file. Possibly
837 depending on the terminal name. Example: >
838 :if &term == "pcterm"
839 : set background=dark
840 :endif
841< When this option is set, the default settings for the highlight groups
842 will change. To use other settings, place ":highlight" commands AFTER
843 the setting of the 'background' option.
844 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
845 to select the colors for syntax highlighting. After changing this
846 option, you must load syntax.vim again to see the result. This can be
847 done with ":syntax on".
848
849 *'backspace'* *'bs'*
850'backspace' 'bs' string (default "")
851 global
852 {not in Vi}
853 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
854 mode. This is a list of items, separated by commas. Each item allows
855 a way to backspace over something:
856 value effect ~
857 indent allow backspacing over autoindent
858 eol allow backspacing over line breaks (join lines)
859 start allow backspacing over the start of insert; CTRL-W and CTRL-U
860 stop once at the start of insert.
861
862 When the value is empty, Vi compatible backspacing is used.
863
864 For backwards compatibility with version 5.4 and earlier:
865 value effect ~
866 0 same as ":set backspace=" (Vi compatible)
867 1 same as ":set backspace=indent,eol"
868 2 same as ":set backspace=indent,eol,start"
869
870 See |:fixdel| if your <BS> or <Del> key does not do what you want.
871 NOTE: This option is set to "" when 'compatible' is set.
872
873 *'backup'* *'bk'* *'nobackup'* *'nobk'*
874'backup' 'bk' boolean (default off)
875 global
876 {not in Vi}
877 Make a backup before overwriting a file. Leave it around after the
878 file has been successfully written. If you do not want to keep the
879 backup file, but you do want a backup while the file is being
880 written, reset this option and set the 'writebackup' option (this is
881 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000882 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000883 |backup-table| for more explanations.
884 When the 'backupskip' pattern matches, a backup is not made anyway.
885 When 'patchmode' is set, the backup may be renamed to become the
886 oldest version of a file.
887 NOTE: This option is reset when 'compatible' is set.
888
889 *'backupcopy'* *'bkc'*
890'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
891 global
892 {not in Vi}
893 When writing a file and a backup is made, this option tells how it's
894 done. This is a comma separated list of words.
895
896 The main values are:
897 "yes" make a copy of the file and overwrite the original one
898 "no" rename the file and write a new one
899 "auto" one of the previous, what works best
900
901 Extra values that can be combined with the ones above are:
902 "breaksymlink" always break symlinks when writing
903 "breakhardlink" always break hardlinks when writing
904
905 Making a copy and overwriting the original file:
906 - Takes extra time to copy the file.
907 + When the file has special attributes, is a (hard/symbolic) link or
908 has a resource fork, all this is preserved.
909 - When the file is a link the backup will have the name of the link,
910 not of the real file.
911
912 Renaming the file and writing a new one:
913 + It's fast.
914 - Sometimes not all attributes of the file can be copied to the new
915 file.
916 - When the file is a link the new file will not be a link.
917
918 The "auto" value is the middle way: When Vim sees that renaming file
919 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000920 the file is not a link) that is used. When problems are expected, a
921 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000922
923 The "breaksymlink" and "breakhardlink" values can be used in
924 combination with any of "yes", "no" and "auto". When included, they
925 force Vim to always break either symbolic or hard links by doing
926 exactly what the "no" option does, renaming the original file to
927 become the backup and writing a new file in its place. This can be
928 useful for example in source trees where all the files are symbolic or
929 hard links and any changes should stay in the local source tree, not
930 be propagated back to the original source.
931 *crontab*
932 One situation where "no" and "auto" will cause problems: A program
933 that opens a file, invokes Vim to edit that file, and then tests if
934 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000935 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000936 example.
937
938 When a copy is made, the original file is truncated and then filled
939 with the new text. This means that protection bits, owner and
940 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000941 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 group of the backup is set to the group of the original file. If this
943 fails, the protection bits for the group are made the same as for
944 others.
945
946 When the file is renamed this is the other way around: The backup has
947 the same attributes of the original file, and the newly written file
948 is owned by the current user. When the file was a (hard/symbolic)
949 link, the new file will not! That's why the "auto" value doesn't
950 rename when the file is a link. The owner and group of the newly
951 written file will be set to the same ones as the original file, but
952 the system may refuse to do this. In that case the "auto" value will
953 again not rename the file.
954
955 *'backupdir'* *'bdir'*
956'backupdir' 'bdir' string (default for Amiga: ".,t:",
957 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
958 for Unix: ".,~/tmp,~/")
959 global
960 {not in Vi}
961 List of directories for the backup file, separated with commas.
962 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100963 where this is possible. The directory must exist, Vim will not
964 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000965 - Empty means that no backup file will be created ('patchmode' is
966 impossible!). Writing may fail because of this.
967 - A directory "." means to put the backup file in the same directory
968 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000969 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000970 put the backup file relative to where the edited file is. The
971 leading "." is replaced with the path name of the edited file.
972 ("." inside a directory name has no special meaning).
973 - Spaces after the comma are ignored, other spaces are considered part
974 of the directory name. To have a space at the start of a directory
975 name, precede it with a backslash.
976 - To include a comma in a directory name precede it with a backslash.
977 - A directory name may end in an '/'.
978 - Environment variables are expanded |:set_env|.
979 - Careful with '\' characters, type one before a space, type two to
980 get one in the option (see |option-backslash|), for example: >
981 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
982< - For backwards compatibility with Vim version 3.0 a '>' at the start
983 of the option is removed.
984 See also 'backup' and 'writebackup' options.
985 If you want to hide your backup files on Unix, consider this value: >
986 :set backupdir=./.backup,~/.backup,.,/tmp
987< You must create a ".backup" directory in each directory and in your
988 home directory for this to work properly.
989 The use of |:set+=| and |:set-=| is preferred when adding or removing
990 directories from the list. This avoids problems when a future version
991 uses another default.
992 This option cannot be set from a |modeline| or in the |sandbox|, for
993 security reasons.
994
995 *'backupext'* *'bex'* *E589*
996'backupext' 'bex' string (default "~", for VMS: "_")
997 global
998 {not in Vi}
999 String which is appended to a file name to make the name of the
1000 backup file. The default is quite unusual, because this avoids
1001 accidentally overwriting existing files with a backup file. You might
1002 prefer using ".bak", but make sure that you don't have files with
1003 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001004 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001006 If you like to keep a lot of backups, you could use a BufWritePre
1007 autocommand to change 'backupext' just before writing the file to
1008 include a timestamp. >
1009 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1010< Use 'backupdir' to put the backup in a different directory.
1011
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 *'backupskip'* *'bsk'*
1013'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1014 global
1015 {not in Vi}
1016 {not available when compiled without the |+wildignore|
1017 feature}
1018 A list of file patterns. When one of the patterns matches with the
1019 name of the file which is written, no backup file is created. Both
1020 the specified file name and the full path name of the file are used.
1021 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1022 Watch out for special characters, see |option-backslash|.
1023 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001024 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001025
1026 Note that environment variables are not expanded. If you want to use
1027 $HOME you must expand it explicitly, e.g.: >
1028 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1029
1030< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001031 backup would be made by renaming the original file crontab won't see
1032 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001033
1034 *'balloondelay'* *'bdlay'*
1035'balloondelay' 'bdlay' number (default: 600)
1036 global
1037 {not in Vi}
1038 {only available when compiled with the |+balloon_eval|
1039 feature}
1040 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1041
1042 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1043'ballooneval' 'beval' boolean (default off)
1044 global
1045 {not in Vi}
1046 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001047 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001048 Switch on the |balloon-eval| functionality.
1049
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 *'balloonexpr'* *'bexpr'*
1051'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001052 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 {not in Vi}
1054 {only available when compiled with the |+balloon_eval|
1055 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001056 Expression for text to show in evaluation balloon. It is only used
1057 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001058
1059 v:beval_bufnr number of the buffer in which balloon is going to show
1060 v:beval_winnr number of the window
1061 v:beval_lnum line number
1062 v:beval_col column number (byte index)
1063 v:beval_text word under or after the mouse pointer
1064
1065 The evaluation of the expression must not have side effects!
1066 Example: >
1067 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001068 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001069 \', column ' . v:beval_col .
1070 \ ' of file ' . bufname(v:beval_bufnr) .
1071 \ ' on word "' . v:beval_text . '"'
1072 endfunction
1073 set bexpr=MyBalloonExpr()
1074 set ballooneval
1075<
1076 NOTE: The balloon is displayed only if the cursor is on a text
1077 character. If the result of evaluating 'balloonexpr' is not empty,
1078 Vim does not try to send a message to an external debugger (Netbeans
1079 or Sun Workshop).
1080
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001081 The expression may be evaluated in the |sandbox|, see
1082 |sandbox-option|.
1083
1084 It is not allowed to change text or jump to another window while
1085 evaluating 'balloonexpr' |textlock|.
1086
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001087 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001088 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001089< When they are supported "\n" characters will start a new line. If the
1090 expression evaluates to a |List| this is equal to using each List item
1091 as a string and putting "\n" in between them.
1092
Bram Moolenaar071d4272004-06-13 20:20:40 +00001093 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1094'binary' 'bin' boolean (default off)
1095 local to buffer
1096 {not in Vi}
1097 This option should be set before editing a binary file. You can also
1098 use the |-b| Vim argument. When this option is switched on a few
1099 options will be changed (also when it already was on):
1100 'textwidth' will be set to 0
1101 'wrapmargin' will be set to 0
1102 'modeline' will be off
1103 'expandtab' will be off
1104 Also, 'fileformat' and 'fileformats' options will not be used, the
1105 file is read and written like 'fileformat' was "unix" (a single <NL>
1106 separates lines).
1107 The 'fileencoding' and 'fileencodings' options will not be used, the
1108 file is read without conversion.
1109 NOTE: When you start editing a(nother) file while the 'bin' option is
1110 on, settings from autocommands may change the settings again (e.g.,
1111 'textwidth'), causing trouble when editing. You might want to set
1112 'bin' again when the file has been loaded.
1113 The previous values of these options are remembered and restored when
1114 'bin' is switched from on to off. Each buffer has its own set of
1115 saved option values.
1116 To edit a file with 'binary' set you can use the |++bin| argument.
1117 This avoids you have to do ":set bin", which would have effect for all
1118 files you edit.
1119 When writing a file the <EOL> for the last line is only written if
1120 there was one in the original file (normally Vim appends an <EOL> to
1121 the last line if there is none; this would make the file longer). See
1122 the 'endofline' option.
1123
1124 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1125'bioskey' 'biosk' boolean (default on)
1126 global
1127 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001128 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001129 better to detect CTRL-C, but only works for the console. When using a
1130 terminal over a serial port reset this option.
1131 Also see |'conskey'|.
1132
1133 *'bomb'* *'nobomb'*
1134'bomb' boolean (default off)
1135 local to buffer
1136 {not in Vi}
1137 {only available when compiled with the |+multi_byte|
1138 feature}
1139 When writing a file and the following conditions are met, a BOM (Byte
1140 Order Mark) is prepended to the file:
1141 - this option is on
1142 - the 'binary' option is off
1143 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1144 endian variants.
1145 Some applications use the BOM to recognize the encoding of the file.
1146 Often used for UCS-2 files on MS-Windows. For other applications it
1147 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001148 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001149 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1150 check for the presence of the BOM is done and 'bomb' set accordingly.
1151 Unless 'binary' is set, it is removed from the first line, so that you
1152 don't see it when editing. When you don't change the options, the BOM
1153 will be restored when writing the file.
1154
1155 *'breakat'* *'brk'*
1156'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1157 global
1158 {not in Vi}
1159 {not available when compiled without the |+linebreak|
1160 feature}
1161 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001162 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1163 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001164
1165 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001166'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001168 {not in Vi} {only for Motif, Athena, GTK, Mac and
1169 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 last Use same directory as with last file browser, where a
1172 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 buffer Use the directory of the related buffer.
1174 current Use the current directory.
1175 {path} Use the specified directory
1176
1177 *'bufhidden'* *'bh'*
1178'bufhidden' 'bh' string (default: "")
1179 local to buffer
1180 {not in Vi}
1181 {not available when compiled without the |+quickfix|
1182 feature}
1183 This option specifies what happens when a buffer is no longer
1184 displayed in a window:
1185 <empty> follow the global 'hidden' option
1186 hide hide the buffer (don't unload it), also when 'hidden'
1187 is not set
1188 unload unload the buffer, also when 'hidden' is set or using
1189 |:hide|
1190 delete delete the buffer from the buffer list, also when
1191 'hidden' is set or using |:hide|, like using
1192 |:bdelete|
1193 wipe wipe out the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bwipeout|
1196
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001197 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1198 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001199 This option is used together with 'buftype' and 'swapfile' to specify
1200 special kinds of buffers. See |special-buffers|.
1201
1202 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1203'buflisted' 'bl' boolean (default: on)
1204 local to buffer
1205 {not in Vi}
1206 When this option is set, the buffer shows up in the buffer list. If
1207 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1208 This option is reset by Vim for buffers that are only used to remember
1209 a file name or marks. Vim sets it when starting to edit a buffer.
1210 But not when moving to a buffer with ":buffer".
1211
1212 *'buftype'* *'bt'* *E382*
1213'buftype' 'bt' string (default: "")
1214 local to buffer
1215 {not in Vi}
1216 {not available when compiled without the |+quickfix|
1217 feature}
1218 The value of this option specifies the type of a buffer:
1219 <empty> normal buffer
1220 nofile buffer which is not related to a file and will not be
1221 written
1222 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001223 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001224 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001225 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001226 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001227 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001228 help help buffer (you are not supposed to set this
1229 manually)
1230
1231 This option is used together with 'bufhidden' and 'swapfile' to
1232 specify special kinds of buffers. See |special-buffers|.
1233
1234 Be careful with changing this option, it can have many side effects!
1235
Bram Moolenaar280f1262006-01-30 00:14:18 +00001236 A "quickfix" buffer is only used for the error list and the location
1237 list. This value is set by the |:cwindow| and |:lwindow| commands and
1238 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001239
1240 "nofile" and "nowrite" buffers are similar:
1241 both: The buffer is not to be written to disk, ":w" doesn't
1242 work (":w filename" does work though).
1243 both: The buffer is never considered to be |'modified'|.
1244 There is no warning when the changes will be lost, for
1245 example when you quit Vim.
1246 both: A swap file is only created when using too much memory
1247 (when 'swapfile' has been reset there is never a swap
1248 file).
1249 nofile only: The buffer name is fixed, it is not handled like a
1250 file name. It is not modified in response to a |:cd|
1251 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001252 *E676*
1253 "acwrite" implies that the buffer name is not related to a file, like
1254 "nofile", but it will be written. Thus, in contrast to "nofile" and
1255 "nowrite", ":w" does work and a modified buffer can't be abandoned
1256 without saving. For writing there must be matching |BufWriteCmd|,
1257 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001258
1259 *'casemap'* *'cmp'*
1260'casemap' 'cmp' string (default: "internal,keepascii")
1261 global
1262 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001263 {only available when compiled with the |+multi_byte|
1264 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 Specifies details about changing the case of letters. It may contain
1266 these words, separated by a comma:
1267 internal Use internal case mapping functions, the current
1268 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001269 matters when 'encoding' is a Unicode encoding,
1270 "latin1" or "iso-8859-15". When "internal" is
1271 omitted, the towupper() and towlower() system library
1272 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001273 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1274 case mapping, the current locale is not effective.
1275 This probably only matters for Turkish.
1276
1277 *'cdpath'* *'cd'* *E344* *E346*
1278'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1279 global
1280 {not in Vi}
1281 {not available when compiled without the
1282 |+file_in_path| feature}
1283 This is a list of directories which will be searched when using the
1284 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001285 for has a relative path, not an absolute part starting with "/", "./"
1286 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001287 The 'cdpath' option's value has the same form and semantics as
1288 |'path'|. Also see |file-searching|.
1289 The default value is taken from $CDPATH, with a "," prepended to look
1290 in the current directory first.
1291 If the default value taken from $CDPATH is not what you want, include
1292 a modified version of the following command in your vimrc file to
1293 override it: >
1294 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1295< This option cannot be set from a |modeline| or in the |sandbox|, for
1296 security reasons.
1297 (parts of 'cdpath' can be passed to the shell to expand file names).
1298
1299 *'cedit'*
1300'cedit' string (Vi default: "", Vim default: CTRL-F)
1301 global
1302 {not in Vi}
1303 {not available when compiled without the |+vertsplit|
1304 feature}
1305 The key used in Command-line Mode to open the command-line window.
1306 The default is CTRL-F when 'compatible' is off.
1307 Only non-printable keys are allowed.
1308 The key can be specified as a single character, but it is difficult to
1309 type. The preferred way is to use the <> notation. Examples: >
1310 :set cedit=<C-Y>
1311 :set cedit=<Esc>
1312< |Nvi| also has this option, but it only uses the first character.
1313 See |cmdwin|.
1314
1315 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1316'charconvert' 'ccv' string (default "")
1317 global
1318 {only available when compiled with the |+multi_byte|
1319 feature and the |+eval| feature}
1320 {not in Vi}
1321 An expression that is used for character encoding conversion. It is
1322 evaluated when a file that is to be read or has been written has a
1323 different encoding from what is desired.
1324 'charconvert' is not used when the internal iconv() function is
1325 supported and is able to do the conversion. Using iconv() is
1326 preferred, because it is much faster.
1327 'charconvert' is not used when reading stdin |--|, because there is no
1328 file to convert from. You will have to save the text in a file first.
1329 The expression must return zero or an empty string for success,
1330 non-zero for failure.
1331 The possible encoding names encountered are in 'encoding'.
1332 Additionally, names given in 'fileencodings' and 'fileencoding' are
1333 used.
1334 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1335 is done internally by Vim, 'charconvert' is not used for this.
1336 'charconvert' is also used to convert the viminfo file, if the 'c'
1337 flag is present in 'viminfo'. Also used for Unicode conversion.
1338 Example: >
1339 set charconvert=CharConvert()
1340 fun CharConvert()
1341 system("recode "
1342 \ . v:charconvert_from . ".." . v:charconvert_to
1343 \ . " <" . v:fname_in . " >" v:fname_out)
1344 return v:shell_error
1345 endfun
1346< The related Vim variables are:
1347 v:charconvert_from name of the current encoding
1348 v:charconvert_to name of the desired encoding
1349 v:fname_in name of the input file
1350 v:fname_out name of the output file
1351 Note that v:fname_in and v:fname_out will never be the same.
1352 Note that v:charconvert_from and v:charconvert_to may be different
1353 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1354 Encryption is not done by Vim when using 'charconvert'. If you want
1355 to encrypt the file after conversion, 'charconvert' should take care
1356 of this.
1357 This option cannot be set from a |modeline| or in the |sandbox|, for
1358 security reasons.
1359
1360 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1361'cindent' 'cin' boolean (default off)
1362 local to buffer
1363 {not in Vi}
1364 {not available when compiled without the |+cindent|
1365 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001366 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001367 that trigger reindenting in insert mode and 'cinoptions' to set your
1368 preferred indent style.
1369 If 'indentexpr' is not empty, it overrules 'cindent'.
1370 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1371 the "=" operator indents using this algorithm rather than calling an
1372 external program.
1373 See |C-indenting|.
1374 When you don't like the way 'cindent' works, try the 'smartindent'
1375 option or 'indentexpr'.
1376 This option is not used when 'paste' is set.
1377 NOTE: This option is reset when 'compatible' is set.
1378
1379 *'cinkeys'* *'cink'*
1380'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1381 local to buffer
1382 {not in Vi}
1383 {not available when compiled without the |+cindent|
1384 feature}
1385 A list of keys that, when typed in Insert mode, cause reindenting of
1386 the current line. Only used if 'cindent' is on and 'indentexpr' is
1387 empty.
1388 For the format of this option see |cinkeys-format|.
1389 See |C-indenting|.
1390
1391 *'cinoptions'* *'cino'*
1392'cinoptions' 'cino' string (default "")
1393 local to buffer
1394 {not in Vi}
1395 {not available when compiled without the |+cindent|
1396 feature}
1397 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1398 program. See |cinoptions-values| for the values of this option, and
1399 |C-indenting| for info on C indenting in general.
1400
1401
1402 *'cinwords'* *'cinw'*
1403'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1404 local to buffer
1405 {not in Vi}
1406 {not available when compiled without both the
1407 |+cindent| and the |+smartindent| features}
1408 These keywords start an extra indent in the next line when
1409 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1410 an appropriate place (inside {}).
1411 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1412 matter, include the keyword both the uppercase and lowercase:
1413 "if,If,IF".
1414
1415 *'clipboard'* *'cb'*
1416'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1417 for X-windows, "" otherwise)
1418 global
1419 {not in Vi}
1420 {only in GUI versions or when the |+xterm_clipboard|
1421 feature is included}
1422 This option is a list of comma separated names.
1423 These names are recognized:
1424
1425 unnamed When included, Vim will use the clipboard register '*'
1426 for all yank, delete, change and put operations which
1427 would normally go to the unnamed register. When a
1428 register is explicitly specified, it will always be
1429 used regardless of whether "unnamed" is in 'clipboard'
1430 or not. The clipboard register can always be
1431 explicitly accessed using the "* notation. Also see
1432 |gui-clipboard|.
1433
1434 autoselect Works like the 'a' flag in 'guioptions': If present,
1435 then whenever Visual mode is started, or the Visual
1436 area extended, Vim tries to become the owner of the
1437 windowing system's global selection or put the
1438 selected text on the clipboard used by the selection
1439 register "*. See |guioptions_a| and |quotestar| for
1440 details. When the GUI is active, the 'a' flag in
1441 'guioptions' is used, when the GUI is not active, this
1442 "autoselect" flag is used.
1443 Also applies to the modeless selection.
1444
1445 autoselectml Like "autoselect", but for the modeless selection
1446 only. Compare to the 'A' flag in 'guioptions'.
1447
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001448 html When the clipboard contains HTML, use this when
1449 pasting. When putting text on the clipboard, mark it
1450 as HTML. This works to copy rendered HTML from
1451 Firefox, paste it as raw HTML in Vim, select the HTML
1452 in Vim and paste it in a rich edit box in Firefox.
1453 Only supported for GTK version 2 and later.
1454 Only available with the |+multi_byte| feature.
1455
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456 exclude:{pattern}
1457 Defines a pattern that is matched against the name of
1458 the terminal 'term'. If there is a match, no
1459 connection will be made to the X server. This is
1460 useful in this situation:
1461 - Running Vim in a console.
1462 - $DISPLAY is set to start applications on another
1463 display.
1464 - You do not want to connect to the X server in the
1465 console, but do want this in a terminal emulator.
1466 To never connect to the X server use: >
1467 exclude:.*
1468< This has the same effect as using the |-X| argument.
1469 Note that when there is no connection to the X server
1470 the window title won't be restored and the clipboard
1471 cannot be accessed.
1472 The value of 'magic' is ignored, {pattern} is
1473 interpreted as if 'magic' was on.
1474 The rest of the option value will be used for
1475 {pattern}, this must be the last entry.
1476
1477 *'cmdheight'* *'ch'*
1478'cmdheight' 'ch' number (default 1)
1479 global
1480 {not in Vi}
1481 Number of screen lines to use for the command-line. Helps avoiding
1482 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001483 The value of this option is stored with the tab page, so that each tab
1484 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001485
1486 *'cmdwinheight'* *'cwh'*
1487'cmdwinheight' 'cwh' number (default 7)
1488 global
1489 {not in Vi}
1490 {not available when compiled without the |+vertsplit|
1491 feature}
1492 Number of screen lines to use for the command-line window. |cmdwin|
1493
1494 *'columns'* *'co'* *E594*
1495'columns' 'co' number (default 80 or terminal width)
1496 global
1497 {not in Vi}
1498 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001499 initialization and does not have to be set by hand. Also see
1500 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 When Vim is running in the GUI or in a resizable window, setting this
1502 option will cause the window size to be changed. When you only want
1503 to use the size for the GUI, put the command in your |gvimrc| file.
1504 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001505 number of columns of the display, the display may be messed up. For
1506 the GUI it is always possible and Vim limits the number of columns to
1507 what fits on the screen. You can use this command to get the widest
1508 window possible: >
1509 :set columns=9999
1510< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001511
1512 *'comments'* *'com'* *E524* *E525*
1513'comments' 'com' string (default
1514 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1515 local to buffer
1516 {not in Vi}
1517 {not available when compiled without the |+comments|
1518 feature}
1519 A comma separated list of strings that can start a comment line. See
1520 |format-comments|. See |option-backslash| about using backslashes to
1521 insert a space.
1522
1523 *'commentstring'* *'cms'* *E537*
1524'commentstring' 'cms' string (default "/*%s*/")
1525 local to buffer
1526 {not in Vi}
1527 {not available when compiled without the |+folding|
1528 feature}
1529 A template for a comment. The "%s" in the value is replaced with the
1530 comment text. Currently only used to add markers for folding, see
1531 |fold-marker|.
1532
1533 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001534'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1535 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001536 global
1537 {not in Vi}
1538 This option has the effect of making Vim either more Vi-compatible, or
1539 make Vim behave in a more useful way.
1540 This is a special kind of option, because when it's set or reset,
1541 other options are also changed as a side effect. CAREFUL: Setting or
1542 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001543 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544 set this option in your vimrc file, you should probably put it at the
1545 very start.
1546 By default this option is on and the Vi defaults are used for the
1547 options. This default was chosen for those people who want to use Vim
1548 just like Vi, and don't even (want to) know about the 'compatible'
1549 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001550 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001551 this option is switched off, and all options that have not been
1552 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001553 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001554 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001555 happen for the system-wide vimrc or gvimrc file, nor for a file given
1556 with the |-u| argument). Also see |compatible-default| and
1557 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001558 You can also set this option with the "-C" argument, and reset it with
1559 "-N". See |-C| and |-N|.
1560 Switching this option off makes the Vim defaults be used for options
1561 that have a different Vi and Vim default value. See the options
1562 marked with a '+' below. Other options are not modified.
1563 At the moment this option is set, several other options will be set
1564 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001565 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001566 editing.
1567 See also 'cpoptions'.
1568
1569 option + set value effect ~
1570
1571 'allowrevins' off no CTRL-_ command
1572 'backupcopy' Unix: "yes" backup file is a copy
1573 others: "auto" copy or rename backup file
1574 'backspace' "" normal backspace
1575 'backup' off no backup file
1576 'cindent' off no C code indentation
1577 'cedit' + "" no key to open the |cmdwin|
1578 'cpoptions' + (all flags) Vi-compatible flags
1579 'cscopetag' off don't use cscope for ":tag"
1580 'cscopetagorder' 0 see |cscopetagorder|
1581 'cscopeverbose' off see |cscopeverbose|
1582 'digraph' off no digraphs
1583 'esckeys' + off no <Esc>-keys in Insert mode
1584 'expandtab' off tabs not expanded to spaces
1585 'fileformats' + "" no automatic file format detection,
1586 "dos,unix" except for DOS, Windows and OS/2
1587 'formatoptions' + "vt" Vi compatible formatting
1588 'gdefault' off no default 'g' flag for ":s"
1589 'history' + 0 no commandline history
1590 'hkmap' off no Hebrew keyboard mapping
1591 'hkmapp' off no phonetic Hebrew keyboard mapping
1592 'hlsearch' off no highlighting of search matches
1593 'incsearch' off no incremental searching
1594 'indentexpr' "" no indenting by expression
1595 'insertmode' off do not start in Insert mode
1596 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1597 characters and '_'
1598 'joinspaces' on insert 2 spaces after period
1599 'modeline' + off no modelines
1600 'more' + off no pauses in listings
1601 'revins' off no reverse insert
1602 'ruler' off no ruler
1603 'scrolljump' 1 no jump scroll
1604 'scrolloff' 0 no scroll offset
1605 'shiftround' off indent not rounded to shiftwidth
1606 'shortmess' + "" no shortening of messages
1607 'showcmd' + off command characters not shown
1608 'showmode' + off current mode not shown
1609 'smartcase' off no automatic ignore case switch
1610 'smartindent' off no smart indentation
1611 'smarttab' off no smart tab size
1612 'softtabstop' 0 tabs are always 'tabstop' positions
1613 'startofline' on goto startofline with some commands
1614 'tagrelative' + off tag file names are not relative
1615 'textauto' + off no automatic textmode detection
1616 'textwidth' 0 no automatic line wrap
1617 'tildeop' off tilde is not an operator
1618 'ttimeout' off no terminal timeout
1619 'whichwrap' + "" left-right movements don't wrap
1620 'wildchar' + CTRL-E only when the current value is <Tab>
1621 use CTRL-E for cmdline completion
1622 'writebackup' on or off depends on +writebackup feature
1623
1624 *'complete'* *'cpt'* *E535*
1625'complete' 'cpt' string (default: ".,w,b,u,t,i")
1626 local to buffer
1627 {not in Vi}
1628 This option specifies how keyword completion |ins-completion| works
1629 when CTRL-P or CTRL-N are used. It is also used for whole-line
1630 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1631 and the places to scan. It is a comma separated list of flags:
1632 . scan the current buffer ('wrapscan' is ignored)
1633 w scan buffers from other windows
1634 b scan other loaded buffers that are in the buffer list
1635 u scan the unloaded buffers that are in the buffer list
1636 U scan the buffers that are not in the buffer list
1637 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001638 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 k{dict} scan the file {dict}. Several "k" flags can be given,
1640 patterns are valid too. For example: >
1641 :set cpt=k/usr/dict/*,k~/spanish
1642< s scan the files given with the 'thesaurus' option
1643 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1644 are valid too.
1645 i scan current and included files
1646 d scan current and included files for defined name or macro
1647 |i_CTRL-X_CTRL-D|
1648 ] tag completion
1649 t same as "]"
1650
1651 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1652 not executed, this may lead to unexpected completions from some files
1653 (gzipped files for example). Unloaded buffers are not scanned for
1654 whole-line completion.
1655
1656 The default is ".,w,b,u,t,i", which means to scan:
1657 1. the current buffer
1658 2. buffers in other windows
1659 3. other loaded buffers
1660 4. unloaded buffers
1661 5. tags
1662 6. included files
1663
1664 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001665 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1666 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001668 *'completefunc'* *'cfu'*
1669'completefunc' 'cfu' string (default: empty)
1670 local to buffer
1671 {not in Vi}
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001672 {not available when compiled without the +eval
1673 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001674 This option specifies a function to be used for Insert mode completion
1675 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001676 See |complete-functions| for an explanation of how the function is
1677 invoked and what it should return.
Bram Moolenaar5a8684e2005-07-30 22:43:24 +00001678
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001679
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001680 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001681'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001682 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001683 {not available when compiled without the
1684 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001685 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001686 A comma separated list of options for Insert mode completion
1687 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001688
1689 menu Use a popup menu to show the possible completions. The
1690 menu is only shown when there is more than one match and
1691 sufficient colors are available. |ins-completion-menu|
1692
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001693 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001694 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001695 match, e.g., what file it comes from.
1696
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001697 longest Only insert the longest common text of the matches. If
1698 the menu is displayed you can use CTRL-L to add more
1699 characters. Whether case is ignored depends on the kind
1700 of completion. For buffer text the 'ignorecase' option is
1701 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001702
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001703 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001704 completion in the preview window. Only works in
1705 combination with "menu" or "menuone".
1706
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1709'confirm' 'cf' boolean (default off)
1710 global
1711 {not in Vi}
1712 When 'confirm' is on, certain operations that would normally
1713 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1714 instead raise a |dialog| asking if you wish to save the current
1715 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1716 If 'confirm' is off you can still activate confirmation for one
1717 command only (this is most useful in mappings) with the |:confirm|
1718 command.
1719 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1720
1721 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1722'conskey' 'consk' boolean (default off)
1723 global
1724 {not in Vi} {only for MS-DOS}
1725 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001726 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 three methods of console input are available:
1728 'conskey' 'bioskey' action ~
1729 on on or off direct console input
1730 off on BIOS
1731 off off STDIN
1732
1733 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1734'copyindent' 'ci' boolean (default off)
1735 local to buffer
1736 {not in Vi}
1737 Copy the structure of the existing lines indent when autoindenting a
1738 new line. Normally the new indent is reconstructed by a series of
1739 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1740 in which case only spaces are used). Enabling this option makes the
1741 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001742 existing line. 'expandtab' has no effect on these characters, a Tab
1743 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744 line, the remaining space is filled in the normal manner.
1745 NOTE: 'copyindent' is reset when 'compatible' is set.
1746 Also see 'preserveindent'.
1747
1748 *'cpoptions'* *'cpo'*
1749'cpoptions' 'cpo' string (Vim default: "aABceFs",
1750 Vi default: all flags)
1751 global
1752 {not in Vi}
1753 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001754 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001755 not being vi-compatible is mostly or sometimes preferred.
1756 'cpoptions' stands for "compatible-options".
1757 Commas can be added for readability.
1758 To avoid problems with flags that are added in the future, use the
1759 "+=" and "-=" feature of ":set" |add-option-flags|.
1760 NOTE: This option is set to the Vi default value when 'compatible' is
1761 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001762 NOTE: This option is set to the POSIX default value at startup when
1763 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001764 variable exists |posix|. This means Vim tries to behave like the
1765 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001766
1767 contains behavior ~
1768 *cpo-a*
1769 a When included, a ":read" command with a file name
1770 argument will set the alternate file name for the
1771 current window.
1772 *cpo-A*
1773 A When included, a ":write" command with a file name
1774 argument will set the alternate file name for the
1775 current window.
1776 *cpo-b*
1777 b "\|" in a ":map" command is recognized as the end of
1778 the map command. The '\' is included in the mapping,
1779 the text after the '|' is interpreted as the next
1780 command. Use a CTRL-V instead of a backslash to
1781 include the '|' in the mapping. Applies to all
1782 mapping, abbreviation, menu and autocmd commands.
1783 See also |map_bar|.
1784 *cpo-B*
1785 B A backslash has no special meaning in mappings,
1786 abbreviations and the "to" part of the menu commands.
1787 Remove this flag to be able to use a backslash like a
1788 CTRL-V. For example, the command ":map X \<Esc>"
1789 results in X being mapped to:
1790 'B' included: "\^[" (^[ is a real <Esc>)
1791 'B' excluded: "<Esc>" (5 characters)
1792 ('<' excluded in both cases)
1793 *cpo-c*
1794 c Searching continues at the end of any match at the
1795 cursor position, but not further than the start of the
1796 next line. When not present searching continues
1797 one character from the cursor position. With 'c'
1798 "abababababab" only gets three matches when repeating
1799 "/abab", without 'c' there are five matches.
1800 *cpo-C*
1801 C Do not concatenate sourced lines that start with a
1802 backslash. See |line-continuation|.
1803 *cpo-d*
1804 d Using "./" in the 'tags' option doesn't mean to use
1805 the tags file relative to the current file, but the
1806 tags file in the current directory.
1807 *cpo-D*
1808 D Can't use CTRL-K to enter a digraph after Normal mode
1809 commands with a character argument, like |r|, |f| and
1810 |t|.
1811 *cpo-e*
1812 e When executing a register with ":@r", always add a
1813 <CR> to the last line, also when the register is not
1814 linewise. If this flag is not present, the register
1815 is not linewise and the last line does not end in a
1816 <CR>, then the last line is put on the command-line
1817 and can be edited before hitting <CR>.
1818 *cpo-E*
1819 E It is an error when using "y", "d", "c", "g~", "gu" or
1820 "gU" on an Empty region. The operators only work when
1821 at least one character is to be operate on. Example:
1822 This makes "y0" fail in the first column.
1823 *cpo-f*
1824 f When included, a ":read" command with a file name
1825 argument will set the file name for the current buffer,
1826 if the current buffer doesn't have a file name yet.
1827 *cpo-F*
1828 F When included, a ":write" command with a file name
1829 argument will set the file name for the current
1830 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001831 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 *cpo-g*
1833 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001834 *cpo-H*
1835 H When using "I" on a line with only blanks, insert
1836 before the last blank. Without this flag insert after
1837 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 *cpo-i*
1839 i When included, interrupting the reading of a file will
1840 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001841 *cpo-I*
1842 I When moving the cursor up or down just after inserting
1843 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001844 *cpo-j*
1845 j When joining lines, only add two spaces after a '.',
1846 not after '!' or '?'. Also see 'joinspaces'.
1847 *cpo-J*
1848 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001849 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001850 white space.
1851 *cpo-k*
1852 k Disable the recognition of raw key codes in
1853 mappings, abbreviations, and the "to" part of menu
1854 commands. For example, if <Key> sends ^[OA (where ^[
1855 is <Esc>), the command ":map X ^[OA" results in X
1856 being mapped to:
1857 'k' included: "^[OA" (3 characters)
1858 'k' excluded: "<Key>" (one key code)
1859 Also see the '<' flag below.
1860 *cpo-K*
1861 K Don't wait for a key code to complete when it is
1862 halfway a mapping. This breaks mapping <F1><F1> when
1863 only part of the second <F1> has been read. It
1864 enables cancelling the mapping by typing <F1><Esc>.
1865 *cpo-l*
1866 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001867 literally, only "\]", "\^", "\-" and "\\" are special.
1868 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001869 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1870 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001871 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001872 *cpo-L*
1873 L When the 'list' option is set, 'wrapmargin',
1874 'textwidth', 'softtabstop' and Virtual Replace mode
1875 (see |gR|) count a <Tab> as two characters, instead of
1876 the normal behavior of a <Tab>.
1877 *cpo-m*
1878 m When included, a showmatch will always wait half a
1879 second. When not included, a showmatch will wait half
1880 a second or until a character is typed. |'showmatch'|
1881 *cpo-M*
1882 M When excluded, "%" matching will take backslashes into
1883 account. Thus in "( \( )" and "\( ( \)" the outer
1884 parenthesis match. When included "%" ignores
1885 backslashes, which is Vi compatible.
1886 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001887 n When included, the column used for 'number' and
1888 'relativenumber' will also be used for text of wrapped
1889 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001890 *cpo-o*
1891 o Line offset to search command is not remembered for
1892 next search.
1893 *cpo-O*
1894 O Don't complain if a file is being overwritten, even
1895 when it didn't exist when editing it. This is a
1896 protection against a file unexpectedly created by
1897 someone else. Vi didn't complain about this.
1898 *cpo-p*
1899 p Vi compatible Lisp indenting. When not present, a
1900 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001901 *cpo-P*
1902 P When included, a ":write" command that appends to a
1903 file will set the file name for the current buffer, if
1904 the current buffer doesn't have a file name yet and
1905 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001906 *cpo-q*
1907 q When joining multiple lines leave the cursor at the
1908 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001909 *cpo-r*
1910 r Redo ("." command) uses "/" to repeat a search
1911 command, instead of the actually used search string.
1912 *cpo-R*
1913 R Remove marks from filtered lines. Without this flag
1914 marks are kept like |:keepmarks| was used.
1915 *cpo-s*
1916 s Set buffer options when entering the buffer for the
1917 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001918 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001919 set when the buffer is created.
1920 *cpo-S*
1921 S Set buffer options always when entering a buffer
1922 (except 'readonly', 'fileformat', 'filetype' and
1923 'syntax'). This is the (most) Vi compatible setting.
1924 The options are set to the values in the current
1925 buffer. When you change an option and go to another
1926 buffer, the value is copied. Effectively makes the
1927 buffer options global to all buffers.
1928
1929 's' 'S' copy buffer options
1930 no no when buffer created
1931 yes no when buffer first entered (default)
1932 X yes each time when buffer entered (vi comp.)
1933 *cpo-t*
1934 t Search pattern for the tag command is remembered for
1935 "n" command. Otherwise Vim only puts the pattern in
1936 the history for search pattern, but doesn't change the
1937 last used search pattern.
1938 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001939 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001940 *cpo-v*
1941 v Backspaced characters remain visible on the screen in
1942 Insert mode. Without this flag the characters are
1943 erased from the screen right away. With this flag the
1944 screen newly typed text overwrites backspaced
1945 characters.
1946 *cpo-w*
1947 w When using "cw" on a blank character, only change one
1948 character and not all blanks until the start of the
1949 next word.
1950 *cpo-W*
1951 W Don't overwrite a readonly file. When omitted, ":w!"
1952 overwrites a readonly file, if possible.
1953 *cpo-x*
1954 x <Esc> on the command-line executes the command-line.
1955 The default in Vim is to abandon the command-line,
1956 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001957 *cpo-X*
1958 X When using a count with "R" the replaced text is
1959 deleted only once. Also when repeating "R" with "."
1960 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001961 *cpo-y*
1962 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001963 *cpo-Z*
1964 Z When using "w!" while the 'readonly' option is set,
1965 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001966 *cpo-!*
1967 ! When redoing a filter command, use the last used
1968 external command, whatever it was. Otherwise the last
1969 used -filter- command is used.
1970 *cpo-$*
1971 $ When making a change to one line, don't redisplay the
1972 line, but put a '$' at the end of the changed text.
1973 The changed text will be overwritten when you type the
1974 new text. The line is redisplayed if you type any
1975 command that moves the cursor from the insertion
1976 point.
1977 *cpo-%*
1978 % Vi-compatible matching is done for the "%" command.
1979 Does not recognize "#if", "#endif", etc.
1980 Does not recognize "/*" and "*/".
1981 Parens inside single and double quotes are also
1982 counted, causing a string that contains a paren to
1983 disturb the matching. For example, in a line like
1984 "if (strcmp("foo(", s))" the first paren does not
1985 match the last one. When this flag is not included,
1986 parens inside single and double quotes are treated
1987 specially. When matching a paren outside of quotes,
1988 everything inside quotes is ignored. When matching a
1989 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001990 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001991 This flag is also used for other features, such as
1992 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001993 *cpo--*
1994 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001995 it would go above the first line or below the last
1996 line. Without it the cursor moves to the first or
1997 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00001998 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00001999 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002000 *cpo-+*
2001 + When included, a ":write file" command will reset the
2002 'modified' flag of the buffer, even though the buffer
2003 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002004 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005 * Use ":*" in the same way as ":@". When not included,
2006 ":*" is an alias for ":'<,'>", select the Visual area.
2007 *cpo-<*
2008 < Disable the recognition of special key codes in |<>|
2009 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002010 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 ":map X <Tab>" results in X being mapped to:
2012 '<' included: "<Tab>" (5 characters)
2013 '<' excluded: "^I" (^I is a real <Tab>)
2014 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002015 *cpo->*
2016 > When appending to a register, put a line break before
2017 the appended text.
2018
2019 POSIX flags. These are not included in the Vi default value, except
2020 when $VIM_POSIX was set on startup. |posix|
2021
2022 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002023 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002024 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002025 *cpo-&*
2026 & When ":preserve" was used keep the swap file when
2027 exiting normally while this buffer is still loaded.
2028 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002029 *cpo-\*
2030 \ Backslash in a [] range in a search pattern is taken
2031 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002032 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2033 '\' excluded: "/[ \-]" finds <Space> and '-'
2034 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002035 *cpo-/*
2036 / When "%" is used as the replacement string in a |:s|
2037 command, use the previous replacement string. |:s%|
2038 *cpo-{*
2039 { The |{| and |}| commands also stop at a "{" character
2040 at the start of a line.
2041 *cpo-.*
2042 . The ":chdir" and ":cd" commands fail if the current
2043 buffer is modified, unless ! is used. Vim doesn't
2044 need this, since it remembers the full path of an
2045 opened file.
2046 *cpo-bar*
2047 | The value of the $LINES and $COLUMNS environment
2048 variables overrule the terminal size values obtained
2049 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002050
Bram Moolenaar071d4272004-06-13 20:20:40 +00002051
2052 *'cscopepathcomp'* *'cspc'*
2053'cscopepathcomp' 'cspc' number (default 0)
2054 global
2055 {not available when compiled without the |+cscope|
2056 feature}
2057 {not in Vi}
2058 Determines how many components of the path to show in a list of tags.
2059 See |cscopepathcomp|.
2060
2061 *'cscopeprg'* *'csprg'*
2062'cscopeprg' 'csprg' string (default "cscope")
2063 global
2064 {not available when compiled without the |+cscope|
2065 feature}
2066 {not in Vi}
2067 Specifies the command to execute cscope. See |cscopeprg|.
2068 This option cannot be set from a |modeline| or in the |sandbox|, for
2069 security reasons.
2070
2071 *'cscopequickfix'* *'csqf'*
2072'cscopequickfix' 'csqf' string (default "")
2073 global
2074 {not available when compiled without the |+cscope|
2075 or |+quickfix| features}
2076 {not in Vi}
2077 Specifies whether to use quickfix window to show cscope results.
2078 See |cscopequickfix|.
2079
2080 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2081'cscopetag' 'cst' boolean (default off)
2082 global
2083 {not available when compiled without the |+cscope|
2084 feature}
2085 {not in Vi}
2086 Use cscope for tag commands. See |cscope-options|.
2087 NOTE: This option is reset when 'compatible' is set.
2088
2089 *'cscopetagorder'* *'csto'*
2090'cscopetagorder' 'csto' number (default 0)
2091 global
2092 {not available when compiled without the |+cscope|
2093 feature}
2094 {not in Vi}
2095 Determines the order in which ":cstag" performs a search. See
2096 |cscopetagorder|.
2097 NOTE: This option is set to 0 when 'compatible' is set.
2098
2099 *'cscopeverbose'* *'csverb'*
2100 *'nocscopeverbose'* *'nocsverb'*
2101'cscopeverbose' 'csverb' boolean (default off)
2102 global
2103 {not available when compiled without the |+cscope|
2104 feature}
2105 {not in Vi}
2106 Give messages when adding a cscope database. See |cscopeverbose|.
2107 NOTE: This option is reset when 'compatible' is set.
2108
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002109
2110 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2111'cursorcolumn' 'cuc' boolean (default off)
2112 local to window
2113 {not in Vi}
2114 {not available when compiled without the |+syntax|
2115 feature}
2116 Highlight the screen column of the cursor with CursorColumn
2117 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2118 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002119 If you only want the highlighting in the current window you can use
2120 these autocommands: >
2121 au WinLeave * set nocursorline nocursorcolumn
2122 au WinEnter * set cursorline cursorcolumn
2123<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002124
2125 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2126'cursorline' 'cul' boolean (default off)
2127 local to window
2128 {not in Vi}
2129 {not available when compiled without the |+syntax|
2130 feature}
2131 Highlight the screen line of the cursor with CursorLine
2132 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2133 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002134 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002135 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002136
2137
Bram Moolenaar071d4272004-06-13 20:20:40 +00002138 *'debug'*
2139'debug' string (default "")
2140 global
2141 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002142 These values can be used:
2143 msg Error messages that would otherwise be omitted will be given
2144 anyway.
2145 throw Error messages that would otherwise be omitted will be given
2146 anyway and also throw an exception and set |v:errmsg|.
2147 beep A message will be given when otherwise only a beep would be
2148 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002149 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002150 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2151 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002152
2153 *'define'* *'def'*
2154'define' 'def' string (default "^\s*#\s*define")
2155 global or local to buffer |global-local|
2156 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002157 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002158 pattern, just like for the "/" command. This option is used for the
2159 commands like "[i" and "[d" |include-search|. The 'isident' option is
2160 used to recognize the defined name after the match:
2161 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2162 See |option-backslash| about inserting backslashes to include a space
2163 or backslash.
2164 The default value is for C programs. For C++ this value would be
2165 useful, to include const type declarations: >
2166 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2167< When using the ":set" command, you need to double the backslashes!
2168
2169 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2170'delcombine' 'deco' boolean (default off)
2171 global
2172 {not in Vi}
2173 {only available when compiled with the |+multi_byte|
2174 feature}
2175 If editing Unicode and this option is set, backspace and Normal mode
2176 "x" delete each combining character on its own. When it is off (the
2177 default) the character along with its combining characters are
2178 deleted.
2179 Note: When 'delcombine' is set "xx" may work different from "2x"!
2180
2181 This is useful for Arabic, Hebrew and many other languages where one
2182 may have combining characters overtop of base characters, and want
2183 to remove only the combining ones.
2184
2185 *'dictionary'* *'dict'*
2186'dictionary' 'dict' string (default "")
2187 global or local to buffer |global-local|
2188 {not in Vi}
2189 List of file names, separated by commas, that are used to lookup words
2190 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2191 contain a list of words. This can be one word per line, or several
2192 words per line, separated by non-keyword characters (white space is
2193 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002194 When this option is empty, or an entry "spell" is present, spell
2195 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002196 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 after a comma are ignored, otherwise spaces are included in the file
2198 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002199 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002200 Where to find a list of words?
2201 - On FreeBSD, there is the file "/usr/share/dict/words".
2202 - In the Simtel archive, look in the "msdos/linguist" directory.
2203 - In "miscfiles" of the GNU collection.
2204 The use of |:set+=| and |:set-=| is preferred when adding or removing
2205 directories from the list. This avoids problems when a future version
2206 uses another default.
2207 Backticks cannot be used in this option for security reasons.
2208
2209 *'diff'* *'nodiff'*
2210'diff' boolean (default off)
2211 local to window
2212 {not in Vi}
2213 {not available when compiled without the |+diff|
2214 feature}
2215 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002216 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002217
2218 *'dex'* *'diffexpr'*
2219'diffexpr' 'dex' string (default "")
2220 global
2221 {not in Vi}
2222 {not available when compiled without the |+diff|
2223 feature}
2224 Expression which is evaluated to obtain an ed-style diff file from two
2225 versions of a file. See |diff-diffexpr|.
2226 This option cannot be set from a |modeline| or in the |sandbox|, for
2227 security reasons.
2228
2229 *'dip'* *'diffopt'*
2230'diffopt' 'dip' string (default "filler")
2231 global
2232 {not in Vi}
2233 {not available when compiled without the |+diff|
2234 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002235 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002236 All are optional. Items must be separated by a comma.
2237
2238 filler Show filler lines, to keep the text
2239 synchronized with a window that has inserted
2240 lines at the same position. Mostly useful
2241 when windows are side-by-side and 'scrollbind'
2242 is set.
2243
2244 context:{n} Use a context of {n} lines between a change
2245 and a fold that contains unchanged lines.
2246 When omitted a context of six lines is used.
2247 See |fold-diff|.
2248
2249 icase Ignore changes in case of text. "a" and "A"
2250 are considered the same. Adds the "-i" flag
2251 to the "diff" command if 'diffexpr' is empty.
2252
2253 iwhite Ignore changes in amount of white space. Adds
2254 the "-b" flag to the "diff" command if
2255 'diffexpr' is empty. Check the documentation
2256 of the "diff" command for what this does
2257 exactly. It should ignore adding trailing
2258 white space, but not leading white space.
2259
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002260 horizontal Start diff mode with horizontal splits (unless
2261 explicitly specified otherwise).
2262
2263 vertical Start diff mode with vertical splits (unless
2264 explicitly specified otherwise).
2265
2266 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2267 starting diff mode. Without this 2 is used.
2268
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269 Examples: >
2270
2271 :set diffopt=filler,context:4
2272 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002273 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002274<
2275 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2276'digraph' 'dg' boolean (default off)
2277 global
2278 {not in Vi}
2279 {not available when compiled without the |+digraphs|
2280 feature}
2281 Enable the entering of digraphs in Insert mode with {char1} <BS>
2282 {char2}. See |digraphs|.
2283 NOTE: This option is reset when 'compatible' is set.
2284
2285 *'directory'* *'dir'*
2286'directory' 'dir' string (default for Amiga: ".,t:",
2287 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2288 for Unix: ".,~/tmp,/var/tmp,/tmp")
2289 global
2290 List of directory names for the swap file, separated with commas.
2291 - The swap file will be created in the first directory where this is
2292 possible.
2293 - Empty means that no swap file will be used (recovery is
2294 impossible!).
2295 - A directory "." means to put the swap file in the same directory as
2296 the edited file. On Unix, a dot is prepended to the file name, so
2297 it doesn't show in a directory listing. On MS-Windows the "hidden"
2298 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002299 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002300 put the swap file relative to where the edited file is. The leading
2301 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002302 - For Unix and Win32, if a directory ends in two path separators "//"
2303 or "\\", the swap file name will be built from the complete path to
2304 the file with all path separators substituted to percent '%' signs.
2305 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002306 On Win32, when a separating comma is following, you must use "//",
2307 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002308 - Spaces after the comma are ignored, other spaces are considered part
2309 of the directory name. To have a space at the start of a directory
2310 name, precede it with a backslash.
2311 - To include a comma in a directory name precede it with a backslash.
2312 - A directory name may end in an ':' or '/'.
2313 - Environment variables are expanded |:set_env|.
2314 - Careful with '\' characters, type one before a space, type two to
2315 get one in the option (see |option-backslash|), for example: >
2316 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2317< - For backwards compatibility with Vim version 3.0 a '>' at the start
2318 of the option is removed.
2319 Using "." first in the list is recommended. This means that editing
2320 the same file twice will result in a warning. Using "/tmp" on Unix is
2321 discouraged: When the system crashes you lose the swap file.
2322 "/var/tmp" is often not cleared when rebooting, thus is a better
2323 choice than "/tmp". But it can contain a lot of files, your swap
2324 files get lost in the crowd. That is why a "tmp" directory in your
2325 home directory is tried first.
2326 The use of |:set+=| and |:set-=| is preferred when adding or removing
2327 directories from the list. This avoids problems when a future version
2328 uses another default.
2329 This option cannot be set from a |modeline| or in the |sandbox|, for
2330 security reasons.
2331 {Vi: directory to put temp file in, defaults to "/tmp"}
2332
2333 *'display'* *'dy'*
2334'display' 'dy' string (default "")
2335 global
2336 {not in Vi}
2337 Change the way text is displayed. This is comma separated list of
2338 flags:
2339 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002340 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002341 last line that doesn't fit is replaced with "@" lines.
2342 uhex Show unprintable characters hexadecimal as <xx>
2343 instead of using ^C and ~C.
2344
2345 *'eadirection'* *'ead'*
2346'eadirection' 'ead' string (default "both")
2347 global
2348 {not in Vi}
2349 {not available when compiled without the +vertsplit
2350 feature}
2351 Tells when the 'equalalways' option applies:
2352 ver vertically, width of windows is not affected
2353 hor horizontally, height of windows is not affected
2354 both width and height of windows is affected
2355
2356 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2357'edcompatible' 'ed' boolean (default off)
2358 global
2359 Makes the 'g' and 'c' flags of the ":substitute" command to be
2360 toggled each time the flag is given. See |complex-change|. See
2361 also 'gdefault' option.
2362 Switching this option on is discouraged!
2363
2364 *'encoding'* *'enc'* *E543*
2365'encoding' 'enc' string (default: "latin1" or value from $LANG)
2366 global
2367 {only available when compiled with the |+multi_byte|
2368 feature}
2369 {not in Vi}
2370 Sets the character encoding used inside Vim. It applies to text in
2371 the buffers, registers, Strings in expressions, text stored in the
2372 viminfo file, etc. It sets the kind of characters which Vim can work
2373 with. See |encoding-names| for the possible values.
2374
2375 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002376 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002377 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002378 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379
2380 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2381 "utf-8". Although care has been taken to allow different values of
2382 'encoding', "utf-8" is the natural choice for the environment and
2383 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002384 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 versions, and to avoid changing the encoding of newly created files
2386 without your knowledge (in case 'fileencodings' is empty).
2387
2388 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002389 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002390 iconv() or as specified with 'charconvert'.
2391
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002392 If you need to know whether 'encoding' is a multi-byte encoding, you
2393 can use: >
2394 if has("multi_byte_encoding")
2395<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 Normally 'encoding' will be equal to your current locale. This will
2397 be the default if Vim recognizes your environment settings. If
2398 'encoding' is not set to the current locale, 'termencoding' must be
2399 set to convert typed and displayed text. See |encoding-table|.
2400
2401 When you set this option, it fires the |EncodingChanged| autocommand
2402 event so that you can set up fonts if necessary.
2403
2404 When the option is set, the value is converted to lowercase. Thus
2405 you can set it with uppercase values too. Underscores are translated
2406 to '-' signs.
2407 When the encoding is recognized, it is changed to the standard name.
2408 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2409 "iso-8859-2" and "utf8" becomes "utf-8".
2410
2411 Note: "latin1" is also used when the encoding could not be detected.
2412 This only works when editing files in the same encoding! When the
2413 actual character set is not latin1, make sure 'fileencoding' and
2414 'fileencodings' are empty. When conversion is needed, switch to using
2415 utf-8.
2416
2417 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2418 You don't notice this while editing, but it does matter for the
2419 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2420 setting 'encoding' to one of these values instead of utf-8 only has
2421 effect for encoding used for files when 'fileencoding' is empty.
2422
Bram Moolenaar661b1822005-07-28 22:36:45 +00002423 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2424 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425
2426 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2427'endofline' 'eol' boolean (default on)
2428 local to buffer
2429 {not in Vi}
2430 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002431 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 option is automatically set when starting to edit a new file, unless
2433 the file does not have an <EOL> for the last line in the file, in
2434 which case it is reset. Normally you don't have to set or reset this
2435 option. When 'binary' is off the value is not used when writing the
2436 file. When 'binary' is on it is used to remember the presence of a
2437 <EOL> for the last line in the file, so that when you write the file
2438 the situation from the original file can be kept. But you can change
2439 it if you want to.
2440
2441 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2442'equalalways' 'ea' boolean (default on)
2443 global
2444 {not in Vi}
2445 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002446 splitting or closing a window. This also happens the moment the
2447 option is switched on. When off, splitting a window will reduce the
2448 size of the current window and leave the other windows the same. When
2449 closing a window the extra lines are given to the window next to it
2450 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002451 When mixing vertically and horizontally split windows, a minimal size
2452 is computed and some windows may be larger if there is room. The
2453 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002454 Changing the height and width of a window can be avoided by setting
2455 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002456 If a window size is specified when creating a new window sizes are
2457 currently not equalized (it's complicated, but may be implemented in
2458 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459
2460 *'equalprg'* *'ep'*
2461'equalprg' 'ep' string (default "")
2462 global or local to buffer |global-local|
2463 {not in Vi}
2464 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002465 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002466 or 'indentexpr'. When Vim was compiled without internal formatting,
2467 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002468 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002469 about including spaces and backslashes.
2470 This option cannot be set from a |modeline| or in the |sandbox|, for
2471 security reasons.
2472
2473 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2474'errorbells' 'eb' boolean (default off)
2475 global
2476 Ring the bell (beep or screen flash) for error messages. This only
2477 makes a difference for error messages, the bell will be used always
2478 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002479 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002480 screen flash or do nothing.
2481
2482 *'errorfile'* *'ef'*
2483'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2484 others: "errors.err")
2485 global
2486 {not in Vi}
2487 {not available when compiled without the |+quickfix|
2488 feature}
2489 Name of the errorfile for the QuickFix mode (see |:cf|).
2490 When the "-q" command-line argument is used, 'errorfile' is set to the
2491 following argument. See |-q|.
2492 NOT used for the ":make" command. See 'makeef' for that.
2493 Environment variables are expanded |:set_env|.
2494 See |option-backslash| about including spaces and backslashes.
2495 This option cannot be set from a |modeline| or in the |sandbox|, for
2496 security reasons.
2497
2498 *'errorformat'* *'efm'*
2499'errorformat' 'efm' string (default is very long)
2500 global or local to buffer |global-local|
2501 {not in Vi}
2502 {not available when compiled without the |+quickfix|
2503 feature}
2504 Scanf-like description of the format for the lines in the error file
2505 (see |errorformat|).
2506
2507 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2508'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2509 global
2510 {not in Vi}
2511 Function keys that start with an <Esc> are recognized in Insert
2512 mode. When this option is off, the cursor and function keys cannot be
2513 used in Insert mode if they start with an <Esc>. The advantage of
2514 this is that the single <Esc> is recognized immediately, instead of
2515 after one second. Instead of resetting this option, you might want to
2516 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2517 when 'esckeys' is off, you can still map anything, but the cursor keys
2518 won't work by default.
2519 NOTE: This option is set to the Vi default value when 'compatible' is
2520 set and to the Vim default value when 'compatible' is reset.
2521
2522 *'eventignore'* *'ei'*
2523'eventignore' 'ei' string (default "")
2524 global
2525 {not in Vi}
2526 {not available when compiled without the |+autocmd|
2527 feature}
2528 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002529 When set to "all" or when "all" is one of the items, all autocommand
2530 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531 Otherwise this is a comma separated list of event names. Example: >
2532 :set ei=WinEnter,WinLeave
2533<
2534 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2535'expandtab' 'et' boolean (default off)
2536 local to buffer
2537 {not in Vi}
2538 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002539 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002540 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2541 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2542 NOTE: This option is reset when 'compatible' is set.
2543
2544 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2545'exrc' 'ex' boolean (default off)
2546 global
2547 {not in Vi}
2548 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2549 directory. If you switch this option on you should also consider
2550 setting the 'secure' option (see |initialization|). Using a local
2551 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2552 also see |.vimrc| and |gui-init|.
2553 This option cannot be set from a |modeline| or in the |sandbox|, for
2554 security reasons.
2555
2556 *'fileencoding'* *'fenc'* *E213*
2557'fileencoding' 'fenc' string (default: "")
2558 local to buffer
2559 {only available when compiled with the |+multi_byte|
2560 feature}
2561 {not in Vi}
2562 Sets the character encoding for the file of this buffer.
2563 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002564 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 When 'fileencoding' is empty, the same value as 'encoding' will be
2566 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002567 Conversion will also be done when 'encoding' and 'fileencoding' are
2568 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2569 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002570 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002571 'encoding' is "utf-8" or another Unicode encoding, conversion
2572 is most likely done in a way that the reverse conversion
2573 results in the same text. When 'encoding' is not "utf-8" some
2574 characters may be lost!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002575 See 'encoding' for the possible values. Additionally, values may be
2576 specified that can be handled by the converter, see
2577 |mbyte-conversion|.
2578 When reading a file 'fileencoding' will be set from 'fileencodings'.
2579 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002580 'fileencoding', use the |++enc| argument. One exception: when
2581 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002582 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2584 When the option is set, the value is converted to lowercase. Thus
2585 you can set it with uppercase values too. '_' characters are
2586 replaced with '-'. If a name is recognized from the list for
2587 'encoding', it is replaced by the standard name. For example
2588 "ISO8859-2" becomes "iso-8859-2".
2589 When this option is set, after starting to edit a file, the 'modified'
2590 option is set, because the file would be different when written.
2591 If you do this in a modeline, you might want to set 'nomodified' to
2592 avoid this.
2593 This option can not be changed when 'modifiable' is off.
2594
2595 *'fe'*
2596 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002597 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002598 old short name was 'fe', which is no longer used.
2599
2600 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002601'fileencodings' 'fencs' string (default: "ucs-bom",
2602 "ucs-bom,utf-8,default,latin1" when
2603 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002604 global
2605 {only available when compiled with the |+multi_byte|
2606 feature}
2607 {not in Vi}
2608 This is a list of character encodings considered when starting to edit
2609 an existing file. When a file is read, Vim tries to use the first
2610 mentioned character encoding. If an error is detected, the next one
2611 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002612 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 an empty string, which means the value of 'encoding' is used.
2614 WARNING: Conversion can cause loss of information! When
2615 'encoding' is "utf-8" (or one of the other Unicode variants)
2616 conversion is most likely done in a way that the reverse
2617 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002618 "utf-8" some non-ASCII characters may be lost! You can use
2619 the |++bad| argument to specify what is done with characters
2620 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002621 For an empty file or a file with only ASCII characters most encodings
2622 will work and the first entry of 'fileencodings' will be used (except
2623 "ucs-bom", which requires the BOM to be present). If you prefer
2624 another encoding use an BufReadPost autocommand event to test if your
2625 preferred encoding is to be used. Example: >
2626 au BufReadPost * if search('\S', 'w') == 0 |
2627 \ set fenc=iso-2022-jp | endif
2628< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2629 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002630 When the |++enc| argument is used then the value of 'fileencodings' is
2631 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002632 Note that 'fileencodings' is not used for a new file, the global value
2633 of 'fileencoding' is used instead. You can set it with: >
2634 :setglobal fenc=iso-8859-2
2635< This means that a non-existing file may get a different encoding than
2636 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002637 The special value "ucs-bom" can be used to check for a Unicode BOM
2638 (Byte Order Mark) at the start of the file. It must not be preceded
2639 by "utf-8" or another Unicode encoding for this to work properly.
2640 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2641 because Vim cannot detect an error, thus the encoding is always
2642 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002643 The special value "default" can be used for the encoding from the
2644 environment. This is the default value for 'encoding'. It is useful
2645 when 'encoding' is set to "utf-8" and your environment uses a
2646 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002647 When 'encoding' is "utf-8" and a file contains an illegal byte
2648 sequence it won't be recognized as UTF-8. You can use the |8g8|
2649 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002650 WRONG VALUES: WHAT'S WRONG:
2651 latin1,utf-8 "latin1" will always be used
2652 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2653 file
2654 cp1250,latin1 "cp1250" will always be used
2655 If 'fileencodings' is empty, 'fileencoding' is not modified.
2656 See 'fileencoding' for the possible values.
2657 Setting this option does not have an effect until the next time a file
2658 is read.
2659
2660 *'fileformat'* *'ff'*
2661'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2662 Unix default: "unix",
2663 Macintosh default: "mac")
2664 local to buffer
2665 {not in Vi}
2666 This gives the <EOL> of the current buffer, which is used for
2667 reading/writing the buffer from/to a file:
2668 dos <CR> <NL>
2669 unix <NL>
2670 mac <CR>
2671 When "dos" is used, CTRL-Z at the end of a file is ignored.
2672 See |file-formats| and |file-read|.
2673 For the character encoding of the file see 'fileencoding'.
2674 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2675 works like it was set to "unix'.
2676 This option is set automatically when starting to edit a file and
2677 'fileformats' is not empty and 'binary' is off.
2678 When this option is set, after starting to edit a file, the 'modified'
2679 option is set, because the file would be different when written.
2680 This option can not be changed when 'modifiable' is off.
2681 For backwards compatibility: When this option is set to "dos",
2682 'textmode' is set, otherwise 'textmode' is reset.
2683
2684 *'fileformats'* *'ffs'*
2685'fileformats' 'ffs' string (default:
2686 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2687 Vim Unix: "unix,dos",
2688 Vim Mac: "mac,unix,dos",
2689 Vi Cygwin: "unix,dos",
2690 Vi others: "")
2691 global
2692 {not in Vi}
2693 This gives the end-of-line (<EOL>) formats that will be tried when
2694 starting to edit a new buffer and when reading a file into an existing
2695 buffer:
2696 - When empty, the format defined with 'fileformat' will be used
2697 always. It is not set automatically.
2698 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002699 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002700 'fileformats' name will be used when a file is read into an existing
2701 buffer, no matter what 'fileformat' for that buffer is set to.
2702 - When more than one name is present, separated by commas, automatic
2703 <EOL> detection will be done when reading a file. When starting to
2704 edit a file, a check is done for the <EOL>:
2705 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2706 'fileformat' is set to "dos".
2707 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002708 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 preceding <CR>, "unix" is preferred over "dos".
2710 3. If 'fileformats' includes "mac", 'fileformat' is set to "mac".
2711 This means that "mac" is only chosen when "unix" is not present,
2712 or when no <NL> is found in the file, and when "dos" is not
2713 present, or no <CR><NL> is present in the file.
2714 Also if "unix" was first chosen, but the first <CR> is before
2715 the first <NL> and there appears to be more <CR>'s than <NL>'s in
2716 the file, then 'fileformat' is set to "mac".
2717 4. If 'fileformat' is still not set, the first name from
2718 'fileformats' is used.
2719 When reading a file into an existing buffer, the same is done, but
2720 this happens like 'fileformat' has been set appropriately for that
2721 file only, the option is not changed.
2722 When 'binary' is set, the value of 'fileformats' is not used.
2723
2724 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2725 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2726 done:
2727 - When 'fileformats' is empty, there is no automatic detection. Dos
2728 format will be used.
2729 - When 'fileformats' is set to one or more names, automatic detection
2730 is done. This is based on the first <NL> in the file: If there is a
2731 <CR> in front of it, Dos format is used, otherwise Unix format is
2732 used.
2733 Also see |file-formats|.
2734 For backwards compatibility: When this option is set to an empty
2735 string or one format (no comma is included), 'textauto' is reset,
2736 otherwise 'textauto' is set.
2737 NOTE: This option is set to the Vi default value when 'compatible' is
2738 set and to the Vim default value when 'compatible' is reset.
2739
2740 *'filetype'* *'ft'*
2741'filetype' 'ft' string (default: "")
2742 local to buffer
2743 {not in Vi}
2744 {not available when compiled without the |+autocmd|
2745 feature}
2746 When this option is set, the FileType autocommand event is triggered.
2747 All autocommands that match with the value of this option will be
2748 executed. Thus the value of 'filetype' is used in place of the file
2749 name.
2750 Otherwise this option does not always reflect the current file type.
2751 This option is normally set when the file type is detected. To enable
2752 this use the ":filetype on" command. |:filetype|
2753 Setting this option to a different value is most useful in a modeline,
2754 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002755 Example, for in an IDL file:
2756 /* vim: set filetype=idl : */ ~
2757 |FileType| |filetypes|
2758 When a dot appears in the value then this separates two filetype
2759 names. Example:
2760 /* vim: set filetype=c.doxygen : */ ~
2761 This will use the "c" filetype first, then the "doxygen" filetype.
2762 This works both for filetype plugins and for syntax files. More than
2763 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 Do not confuse this option with 'osfiletype', which is for the file
2765 type that is actually stored with the file.
2766 This option is not copied to another buffer, independent of the 's' or
2767 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002768 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002769
2770 *'fillchars'* *'fcs'*
2771'fillchars' 'fcs' string (default "vert:|,fold:-")
2772 global
2773 {not in Vi}
2774 {not available when compiled without the |+windows|
2775 and |+folding| features}
2776 Characters to fill the statuslines and vertical separators.
2777 It is a comma separated list of items:
2778
2779 item default Used for ~
2780 stl:c ' ' or '^' statusline of the current window
2781 stlnc:c ' ' or '-' statusline of the non-current windows
2782 vert:c '|' vertical separators |:vsplit|
2783 fold:c '-' filling 'foldtext'
2784 diff:c '-' deleted lines of the 'diff' option
2785
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002786 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002787 "stlnc" the space will be used when there is highlighting, '^' or '-'
2788 otherwise.
2789
2790 Example: >
2791 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2792< This is similar to the default, except that these characters will also
2793 be used when there is highlighting.
2794
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002795 for "stl" and "stlnc" only single-byte values are supported.
2796
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 The highlighting used for these items:
2798 item highlight group ~
2799 stl:c StatusLine |hl-StatusLine|
2800 stlnc:c StatusLineNC |hl-StatusLineNC|
2801 vert:c VertSplit |hl-VertSplit|
2802 fold:c Folded |hl-Folded|
2803 diff:c DiffDelete |hl-DiffDelete|
2804
2805 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2806'fkmap' 'fk' boolean (default off) *E198*
2807 global
2808 {not in Vi}
2809 {only available when compiled with the |+rightleft|
2810 feature}
2811 When on, the keyboard is mapped for the Farsi character set.
2812 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002813 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002814
2815 *'foldclose'* *'fcl'*
2816'foldclose' 'fcl' string (default "")
2817 global
2818 {not in Vi}
2819 {not available when compiled without the |+folding|
2820 feature}
2821 When set to "all", a fold is closed when the cursor isn't in it and
2822 its level is higher than 'foldlevel'. Useful if you want folds to
2823 automatically close when moving out of them.
2824
2825 *'foldcolumn'* *'fdc'*
2826'foldcolumn' 'fdc' number (default 0)
2827 local to window
2828 {not in Vi}
2829 {not available when compiled without the |+folding|
2830 feature}
2831 When non-zero, a column with the specified width is shown at the side
2832 of the window which indicates open and closed folds. The maximum
2833 value is 12.
2834 See |folding|.
2835
2836 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2837'foldenable' 'fen' boolean (default on)
2838 local to window
2839 {not in Vi}
2840 {not available when compiled without the |+folding|
2841 feature}
2842 When off, all folds are open. This option can be used to quickly
2843 switch between showing all text unfolded and viewing the text with
2844 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002845 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 'foldenable' is off.
2847 This option is set by commands that create a new fold or close a fold.
2848 See |folding|.
2849
2850 *'foldexpr'* *'fde'*
2851'foldexpr' 'fde' string (default: "0")
2852 local to window
2853 {not in Vi}
2854 {not available when compiled without the |+folding|
2855 or |+eval| feature}
2856 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002857 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002858
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002859 The expression may be evaluated in the |sandbox|, see
2860 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002861 This option can't be set from a |modeline| when the 'diff' option is
2862 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002863
2864 It is not allowed to change text or jump to another window while
2865 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866
2867 *'foldignore'* *'fdi'*
2868'foldignore' 'fdi' string (default: "#")
2869 local to window
2870 {not in Vi}
2871 {not available when compiled without the |+folding|
2872 feature}
2873 Used only when 'foldmethod' is "indent". Lines starting with
2874 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002875 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 The default "#" works well for C programs. See |fold-indent|.
2877
2878 *'foldlevel'* *'fdl'*
2879'foldlevel' 'fdl' number (default: 0)
2880 local to window
2881 {not in Vi}
2882 {not available when compiled without the |+folding|
2883 feature}
2884 Sets the fold level: Folds with a higher level will be closed.
2885 Setting this option to zero will close all folds. Higher numbers will
2886 close fewer folds.
2887 This option is set by commands like |zm|, |zM| and |zR|.
2888 See |fold-foldlevel|.
2889
2890 *'foldlevelstart'* *'fdls'*
2891'foldlevelstart' 'fdls' number (default: -1)
2892 global
2893 {not in Vi}
2894 {not available when compiled without the |+folding|
2895 feature}
2896 Sets 'foldlevel' when starting to edit another buffer in a window.
2897 Useful to always start editing with all folds closed (value zero),
2898 some folds closed (one) or no folds closed (99).
2899 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002900 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00002901 ignores this option and closes all folds.
2902 It is also done before BufReadPre autocommands, to allow an autocmd to
2903 overrule the 'foldlevel' value for specific files.
2904 When the value is negative, it is not used.
2905
2906 *'foldmarker'* *'fmr'* *E536*
2907'foldmarker' 'fmr' string (default: "{{{,}}}")
2908 local to window
2909 {not in Vi}
2910 {not available when compiled without the |+folding|
2911 feature}
2912 The start and end marker used when 'foldmethod' is "marker". There
2913 must be one comma, which separates the start and end marker. The
2914 marker is a literal string (a regular expression would be too slow).
2915 See |fold-marker|.
2916
2917 *'foldmethod'* *'fdm'*
2918'foldmethod' 'fdm' string (default: "manual")
2919 local to window
2920 {not in Vi}
2921 {not available when compiled without the |+folding|
2922 feature}
2923 The kind of folding used for the current window. Possible values:
2924 |fold-manual| manual Folds are created manually.
2925 |fold-indent| indent Lines with equal indent form a fold.
2926 |fold-expr| expr 'foldexpr' gives the fold level of a line.
2927 |fold-marker| marker Markers are used to specify folds.
2928 |fold-syntax| syntax Syntax highlighting items specify folds.
2929 |fold-diff| diff Fold text that is not changed.
2930
2931 *'foldminlines'* *'fml'*
2932'foldminlines' 'fml' number (default: 1)
2933 local to window
2934 {not in Vi}
2935 {not available when compiled without the |+folding|
2936 feature}
2937 Sets the minimum number of screen lines for a fold to be displayed
2938 closed. Also for manually closed folds.
2939 Note that this only has an effect of what is displayed. After using
2940 "zc" to close a fold, which is displayed open because it's smaller
2941 than 'foldminlines', a following "zc" may close a containing fold.
2942
2943 *'foldnestmax'* *'fdn'*
2944'foldnestmax' 'fdn' number (default: 20)
2945 local to window
2946 {not in Vi}
2947 {not available when compiled without the |+folding|
2948 feature}
2949 Sets the maximum nesting of folds for the "indent" and "syntax"
2950 methods. This avoids that too many folds will be created. Using more
2951 than 20 doesn't work, because the internal limit is 20.
2952
2953 *'foldopen'* *'fdo'*
2954'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
2955 search,tag,undo")
2956 global
2957 {not in Vi}
2958 {not available when compiled without the |+folding|
2959 feature}
2960 Specifies for which type of commands folds will be opened, if the
2961 command moves the cursor into a closed fold. It is a comma separated
2962 list of items.
2963 item commands ~
2964 all any
2965 block "(", "{", "[[", "[{", etc.
2966 hor horizontal movements: "l", "w", "fx", etc.
2967 insert any command in Insert mode
2968 jump far jumps: "G", "gg", etc.
2969 mark jumping to a mark: "'m", CTRL-O, etc.
2970 percent "%"
2971 quickfix ":cn", ":crew", ":make", etc.
2972 search search for a pattern: "/", "n", "*", "gd", etc.
2973 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002974 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 tag jumping to a tag: ":ta", CTRL-T, etc.
2976 undo undo or redo: "u" and CTRL-R
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002977 When the command is part of a mapping this option is not used. Add
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 the |zv| command to the mapping to get the same effect.
2979 When a movement command is used for an operator (e.g., "dl" or "y%")
2980 this option is not used. This means the operator will include the
2981 whole closed fold.
2982 Note that vertical movements are not here, because it would make it
2983 very difficult to move onto a closed fold.
2984 In insert mode the folds containing the cursor will always be open
2985 when text is inserted.
2986 To close folds you can re-apply 'foldlevel' with the |zx| command or
2987 set the 'foldclose' option to "all".
2988
2989 *'foldtext'* *'fdt'*
2990'foldtext' 'fdt' string (default: "foldtext()")
2991 local to window
2992 {not in Vi}
2993 {not available when compiled without the |+folding|
2994 feature}
2995 An expression which is used to specify the text displayed for a closed
2996 fold. See |fold-foldtext|.
2997
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002998 The expression may be evaluated in the |sandbox|, see
2999 |sandbox-option|.
3000
3001 It is not allowed to change text or jump to another window while
3002 evaluating 'foldtext' |textlock|.
3003
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 *'formatoptions'* *'fo'*
3005'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3006 local to buffer
3007 {not in Vi}
3008 This is a sequence of letters which describes how automatic
3009 formatting is to be done. See |fo-table|. When the 'paste' option is
3010 on, no formatting is done (like 'formatoptions' is empty). Commas can
3011 be inserted for readability.
3012 To avoid problems with flags that are added in the future, use the
3013 "+=" and "-=" feature of ":set" |add-option-flags|.
3014 NOTE: This option is set to the Vi default value when 'compatible' is
3015 set and to the Vim default value when 'compatible' is reset.
3016
Bram Moolenaar86b68352004-12-27 21:59:20 +00003017 *'formatlistpat'* *'flp'*
3018'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3019 local to buffer
3020 {not in Vi}
3021 A pattern that is used to recognize a list header. This is used for
3022 the "n" flag in 'formatoptions'.
3023 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003024 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003025 while still checking more characters. There must be a character
3026 following the pattern, when it matches the whole line it is handled
3027 like there is no match.
3028 The default recognizes a number, followed by an optional punctuation
3029 character and white space.
3030
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 *'formatprg'* *'fp'*
3032'formatprg' 'fp' string (default "")
3033 global
3034 {not in Vi}
3035 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003036 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003038 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003039 If the 'formatexpr' option is not empty it will be used instead.
3040 Otherwise, if 'formatprg' option is an empty string, the internal
3041 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003042 Environment variables are expanded |:set_env|. See |option-backslash|
3043 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003044 The expression may be evaluated in the |sandbox|, see
3045 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003047 *'formatexpr'* *'fex'*
3048'formatexpr' 'fex' string (default "")
3049 local to buffer
3050 {not in Vi}
3051 {not available when compiled without the |+eval|
3052 feature}
3053 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003054 operator. When this option is empty 'formatprg' is used.
3055
3056 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003057 The |v:count| variable holds the number of lines to be formatted.
3058 The |v:char| variable holds the character that is going to be
3059 inserted. This can be empty. Don't insert it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003060
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003061 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003062 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003063< This will invoke the mylang#Format() function in the
3064 autoload/mylang.vim file in 'runtimepath'. |autoload|
3065
3066 The expression is also evaluated when 'textwidth' is set and adding
3067 text beyond that limit. This happens under the same conditions as
3068 when internal formatting is used. Make sure the cursor is kept in the
3069 same spot relative to the text then! The |mode()| function will
3070 return "i" or "R" in this situation. When the function returns
3071 non-zero Vim will fall back to using the internal format mechanism.
3072
3073 The expression may be evaluated in the |sandbox|, see
3074 |sandbox-option|.
3075
3076 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003077'fsync' 'fs' boolean (default on)
3078 global
3079 {not in Vi}
3080 When on, the library function fsync() will be called after writing a
3081 file. This will flush a file to disk, ensuring that it is safely
3082 written even on filesystems which do metadata-only journaling. This
3083 will force the harddrive to spin up on Linux systems running in laptop
3084 mode, so it may be undesirable in some situations. Be warned that
3085 turning this off increases the chances of data loss after a crash. On
3086 systems without an fsync() implementation, this variable is always
3087 off.
3088 Also see 'swapsync' for controlling fsync() on swap files.
3089
Bram Moolenaar071d4272004-06-13 20:20:40 +00003090 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3091'gdefault' 'gd' boolean (default off)
3092 global
3093 {not in Vi}
3094 When on, the ":substitute" flag 'g' is default on. This means that
3095 all matches in a line are substituted instead of one. When a 'g' flag
3096 is given to a ":substitute" command, this will toggle the substitution
3097 of all or one match. See |complex-change|.
3098
3099 command 'gdefault' on 'gdefault' off ~
3100 :s/// subst. all subst. one
3101 :s///g subst. one subst. all
3102 :s///gg subst. all subst. one
3103
3104 NOTE: This option is reset when 'compatible' is set.
3105
3106 *'grepformat'* *'gfm'*
3107'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3108 global
3109 {not in Vi}
3110 Format to recognize for the ":grep" command output.
3111 This is a scanf-like string that uses the same format as the
3112 'errorformat' option: see |errorformat|.
3113
3114 *'grepprg'* *'gp'*
3115'grepprg' 'gp' string (default "grep -n ",
3116 Unix: "grep -n $* /dev/null",
3117 Win32: "findstr /n" or "grep -n",
3118 VMS: "SEARCH/NUMBERS ")
3119 global or local to buffer |global-local|
3120 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003121 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 and '#' characters, which are expanded like when used in a command-
3123 line. The placeholder "$*" is allowed to specify where the arguments
3124 will be included. Environment variables are expanded |:set_env|. See
3125 |option-backslash| about including spaces and backslashes.
3126 When your "grep" accepts the "-H" argument, use this to make ":grep"
3127 also work well with a single file: >
3128 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003129< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003130 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3131 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003132 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003133 apply equally to 'grepprg'.
3134 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3135 otherwise it's "grep -n".
3136 This option cannot be set from a |modeline| or in the |sandbox|, for
3137 security reasons.
3138
3139 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3140'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3141 ve:ver35-Cursor,
3142 o:hor50-Cursor,
3143 i-ci:ver25-Cursor/lCursor,
3144 r-cr:hor20-Cursor/lCursor,
3145 sm:block-Cursor
3146 -blinkwait175-blinkoff150-blinkon175",
3147 for MS-DOS and Win32 console:
3148 "n-v-c:block,o:hor50,i-ci:hor15,
3149 r-cr:hor30,sm:block")
3150 global
3151 {not in Vi}
3152 {only available when compiled with GUI enabled, and
3153 for MS-DOS and Win32 console}
3154 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003155 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003156 the height of the cursor can be changed. This can be done by
3157 specifying a block cursor, or a percentage for a vertical or
3158 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003159 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003160
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003161 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 mode-list and an argument-list:
3163 mode-list:argument-list,mode-list:argument-list,..
3164 The mode-list is a dash separated list of these modes:
3165 n Normal mode
3166 v Visual mode
3167 ve Visual mode with 'selection' "exclusive" (same as 'v',
3168 if not specified)
3169 o Operator-pending mode
3170 i Insert mode
3171 r Replace mode
3172 c Command-line Normal (append) mode
3173 ci Command-line Insert mode
3174 cr Command-line Replace mode
3175 sm showmatch in Insert mode
3176 a all modes
3177 The argument-list is a dash separated list of these arguments:
3178 hor{N} horizontal bar, {N} percent of the character height
3179 ver{N} vertical bar, {N} percent of the character width
3180 block block cursor, fills the whole character
3181 [only one of the above three should be present]
3182 blinkwait{N} *cursor-blinking*
3183 blinkon{N}
3184 blinkoff{N}
3185 blink times for cursor: blinkwait is the delay before
3186 the cursor starts blinking, blinkon is the time that
3187 the cursor is shown and blinkoff is the time that the
3188 cursor is not shown. The times are in msec. When one
3189 of the numbers is zero, there is no blinking. The
3190 default is: "blinkwait700-blinkon400-blinkoff250".
3191 These numbers are used for a missing entry. This
3192 means that blinking is enabled by default. To switch
3193 blinking off you can use "blinkon0". The cursor only
3194 blinks when Vim is waiting for input, not while
3195 executing a command.
3196 To make the cursor blink in an xterm, see
3197 |xterm-blink|.
3198 {group-name}
3199 a highlight group name, that sets the color and font
3200 for the cursor
3201 {group-name}/{group-name}
3202 Two highlight group names, the first is used when
3203 no language mappings are used, the other when they
3204 are. |language-mapping|
3205
3206 Examples of parts:
3207 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3208 block cursor with colors from the "nCursor"
3209 highlight group
3210 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3211 In Insert and Command-line Insert mode, use a
3212 30% vertical bar cursor with colors from the
3213 "iCursor" highlight group. Blink a bit
3214 faster.
3215
3216 The 'a' mode is different. It will set the given argument-list for
3217 all modes. It does not reset anything to defaults. This can be used
3218 to do a common setting for all modes. For example, to switch off
3219 blinking: "a:blinkon0"
3220
3221 Examples of cursor highlighting: >
3222 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3223 :highlight Cursor gui=NONE guifg=bg guibg=fg
3224<
3225 *'guifont'* *'gfn'*
3226 *E235* *E596* *E610* *E611*
3227'guifont' 'gfn' string (default "")
3228 global
3229 {not in Vi}
3230 {only available when compiled with GUI enabled}
3231 This is a list of fonts which will be used for the GUI version of Vim.
3232 In its simplest form the value is just one font name. When
3233 the font cannot be found you will get an error message. To try other
3234 font names a list can be specified, font names separated with commas.
3235 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003236
Bram Moolenaar05159a02005-02-26 23:04:13 +00003237 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3238 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003239
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 Spaces after a comma are ignored. To include a comma in a font name
3241 precede it with a backslash. Setting an option requires an extra
3242 backslash before a space and a backslash. See also
3243 |option-backslash|. For example: >
3244 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003245< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003246 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003247
3248 If none of the fonts can be loaded, Vim will keep the current setting.
3249 If an empty font list is given, Vim will try using other resource
3250 settings (for X, it will use the Vim.font resource), and finally it
3251 will try some builtin default which should always be there ("7x13" in
3252 the case of X). The font names given should be "normal" fonts. Vim
3253 will try to find the related bold and italic fonts.
3254
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003255 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003256 :set guifont=*
3257< will bring up a font requester, where you can pick the font you want.
3258
3259 The font name depends on the GUI used. See |setting-guifont| for a
3260 way to set 'guifont' for various systems.
3261
Bram Moolenaar071d4272004-06-13 20:20:40 +00003262 For the GTK+ 2 GUI the font name looks like this: >
3263 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003264< That's all. XLFDs are not used. For Chinese this is reported to work
3265 well: >
3266 if has("gui_gtk2")
3267 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3268 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3269 endif
3270<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003271 For Mac OSX you can use something like this: >
3272 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003273< Also see 'macatsui', it can help fix display problems.
3274 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003275 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003276 width). An exception is GTK 2: all fonts are accepted, but
3277 mono-spaced fonts look best.
3278
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 To preview a font on X11, you might be able to use the "xfontsel"
3280 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003281
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282 For the Win32 GUI *E244* *E245*
3283 - takes these options in the font name:
3284 hXX - height is XX (points, can be floating-point)
3285 wXX - width is XX (points, can be floating-point)
3286 b - bold
3287 i - italic
3288 u - underline
3289 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003290 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3292 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3293 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003294 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 Use a ':' to separate the options.
3297 - A '_' can be used in the place of a space, so you don't need to use
3298 backslashes to escape the spaces.
3299 - Examples: >
3300 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3301 :set guifont=Andale_Mono:h7.5:w4.5
3302< See also |font-sizes|.
3303
3304 *'guifontset'* *'gfs'*
3305 *E250* *E252* *E234* *E597* *E598*
3306'guifontset' 'gfs' string (default "")
3307 global
3308 {not in Vi}
3309 {only available when compiled with GUI enabled and
3310 with the |+xfontset| feature}
3311 {not available in the GTK+ 2 GUI}
3312 When not empty, specifies two (or more) fonts to be used. The first
3313 one for normal English, the second one for your special language. See
3314 |xfontset|.
3315 Setting this option also means that all font names will be handled as
3316 a fontset name. Also the ones used for the "font" argument of the
3317 |:highlight| command.
3318 The fonts must match with the current locale. If fonts for the
3319 character sets that the current locale uses are not included, setting
3320 'guifontset' will fail.
3321 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3322 the comma-separated names are alternative names, one of which will be
3323 used. In 'guifontset' the whole string is one fontset name,
3324 including the commas. It is not possible to specify alternative
3325 fontset names.
3326 This example works on many X11 systems: >
3327 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3328<
3329 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3330'guifontwide' 'gfw' string (default "")
3331 global
3332 {not in Vi}
3333 {only available when compiled with GUI enabled}
3334 When not empty, specifies a comma-separated list of fonts to be used
3335 for double-width characters. The first font that can be loaded is
3336 used.
3337 Note: The size of these fonts must be exactly twice as wide as the one
3338 specified with 'guifont' and the same height.
3339
3340 All GUI versions but GTK+ 2:
3341
3342 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3343 'guifontset' is empty or invalid.
3344 When 'guifont' is set and a valid font is found in it and
3345 'guifontwide' is empty Vim will attempt to find a matching
3346 double-width font and set 'guifontwide' to it.
3347
3348 GTK+ 2 GUI only: *guifontwide_gtk2*
3349
3350 If set and valid, 'guifontwide' is always used for double width
3351 characters, even if 'encoding' is not set to "utf-8".
3352 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003353 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 font for characters not available in 'guifont'. Thus you do not need
3355 to set 'guifontwide' at all unless you want to override the choice
3356 made by Pango/Xft.
3357
3358 *'guiheadroom'* *'ghr'*
3359'guiheadroom' 'ghr' number (default 50)
3360 global
3361 {not in Vi} {only for GTK and X11 GUI}
3362 The number of pixels subtracted from the screen height when fitting
3363 the GUI window on the screen. Set this before the GUI is started,
3364 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003365 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003366 lines will be left for window decorations and other items on the
3367 screen. Set it to a negative value to allow windows taller than the
3368 screen.
3369
3370 *'guioptions'* *'go'*
3371'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003372 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003373 global
3374 {not in Vi}
3375 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003376 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 sequence of letters which describes what components and options of the
3378 GUI should be used.
3379 To avoid problems with flags that are added in the future, use the
3380 "+=" and "-=" feature of ":set" |add-option-flags|.
3381
3382 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003383 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 'a' Autoselect: If present, then whenever VISUAL mode is started,
3385 or the Visual area extended, Vim tries to become the owner of
3386 the windowing system's global selection. This means that the
3387 Visually highlighted text is available for pasting into other
3388 applications as well as into Vim itself. When the Visual mode
3389 ends, possibly due to an operation on the text, or when an
3390 application wants to paste the selection, the highlighted text
3391 is automatically yanked into the "* selection register.
3392 Thus the selection is still available for pasting into other
3393 applications after the VISUAL mode has ended.
3394 If not present, then Vim won't become the owner of the
3395 windowing system's global selection unless explicitly told to
3396 by a yank or delete operation for the "* register.
3397 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003398 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003399 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 applies to the modeless selection.
3401
3402 'guioptions' autoselect Visual autoselect modeless ~
3403 "" - -
3404 "a" yes yes
3405 "A" - yes
3406 "aA" yes yes
3407
Bram Moolenaar02467872007-05-06 13:22:01 +00003408 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003409 'c' Use console dialogs instead of popup dialogs for simple
3410 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003411 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003412 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003413 'guitablabel' can be used to change the text in the labels.
3414 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003415 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003416 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003417 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 'f' Foreground: Don't use fork() to detach the GUI from the shell
3419 where it was started. Use this for programs that wait for the
3420 editor to finish (e.g., an e-mail program). Alternatively you
3421 can use "gvim -f" or ":gui -f" to start the GUI in the
3422 foreground. |gui-fork|
3423 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003424 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003425 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3427 corner of the window. It's black&white on non-GTK, because of
3428 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar02467872007-05-06 13:22:01 +00003429 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 'm' Menu bar is present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003431 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003432 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003434 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003435 file is sourced the system menu has already been loaded; the
3436 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar02467872007-05-06 13:22:01 +00003437 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003438 'g' Grey menu items: Make menu items that are not active grey. If
3439 'g' is not included inactive menu items are not shown at all.
3440 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003441 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 't' Include tearoff menu items. Currently only works for Win32,
3443 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003444 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003445 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003446 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003447 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003448 'r' Right-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003449 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003450 'R' Right-hand scrollbar is present when there is a vertically
3451 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003452 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003453 'l' Left-hand scrollbar is always present.
Bram Moolenaar02467872007-05-06 13:22:01 +00003454 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003455 'L' Left-hand scrollbar is present when there is a vertically
3456 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003457 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003458 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3459 the longest visible line, or on the cursor line if the 'h'
3460 flag is included. |gui-horiz-scroll|
Bram Moolenaar02467872007-05-06 13:22:01 +00003461 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003462 'h' Limit horizontal scrollbar size to the length of the cursor
3463 line. Reduces computations. |gui-horiz-scroll|
3464
3465 And yes, you may even have scrollbars on the left AND the right if
3466 you really want to :-). See |gui-scrollbars| for more information.
3467
Bram Moolenaar02467872007-05-06 13:22:01 +00003468 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003469 'v' Use a vertical button layout for dialogs. When not included,
3470 a horizontal layout is preferred, but when it doesn't fit a
3471 vertical layout is used anyway.
Bram Moolenaar02467872007-05-06 13:22:01 +00003472 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003473 'p' Use Pointer callbacks for X11 GUI. This is required for some
3474 window managers. If the cursor is not blinking or hollow at
3475 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003476 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 removing it after the GUI has started has no effect.
Bram Moolenaar02467872007-05-06 13:22:01 +00003478 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003479 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480
Bram Moolenaar02467872007-05-06 13:22:01 +00003481
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 *'guipty'* *'noguipty'*
3483'guipty' boolean (default on)
3484 global
3485 {not in Vi}
3486 {only available when compiled with GUI enabled}
3487 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3488 I/O to/from shell commands. See |gui-pty|.
3489
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003490 *'guitablabel'* *'gtl'*
3491'guitablabel' 'gtl' string (default empty)
3492 global
3493 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003494 {only available when compiled with GUI enabled and
3495 with the +windows feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003496 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003497 pages line. When empty and when the result is empty Vim will use a
3498 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003499
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003500 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003501 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003502
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003503 Only used when the GUI tab pages line is displayed. 'e' must be
3504 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3505 used.
3506
Bram Moolenaar57657d82006-04-21 22:12:41 +00003507 *'guitabtooltip'* *'gtt'*
3508'guitabtooltip' 'gtt' string (default empty)
3509 global
3510 {not in Vi}
3511 {only available when compiled with GUI enabled and
3512 with the +windows feature}
3513 When nonempty describes the text to use in a tooltip for the GUI tab
3514 pages line. When empty Vim will use a default tooltip.
3515 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003516 You can include a line break. Simplest method is to use |:let|: >
3517 :let &guitabtooltip = "line one\nline two"
3518<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003519
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 *'helpfile'* *'hf'*
3521'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3522 (others) "$VIMRUNTIME/doc/help.txt")
3523 global
3524 {not in Vi}
3525 Name of the main help file. All distributed help files should be
3526 placed together in one directory. Additionally, all "doc" directories
3527 in 'runtimepath' will be used.
3528 Environment variables are expanded |:set_env|. For example:
3529 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003530 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 spaces and backslashes.
3532 This option cannot be set from a |modeline| or in the |sandbox|, for
3533 security reasons.
3534
3535 *'helpheight'* *'hh'*
3536'helpheight' 'hh' number (default 20)
3537 global
3538 {not in Vi}
3539 {not available when compiled without the +windows
3540 feature}
3541 Minimal initial height of the help window when it is opened with the
3542 ":help" command. The initial height of the help window is half of the
3543 current window, or (when the 'ea' option is on) the same as other
3544 windows. When the height is less than 'helpheight', the height is
3545 set to 'helpheight'. Set to zero to disable.
3546
3547 *'helplang'* *'hlg'*
3548'helplang' 'hlg' string (default: messages language or empty)
3549 global
3550 {only available when compiled with the |+multi_lang|
3551 feature}
3552 {not in Vi}
3553 Comma separated list of languages. Vim will use the first language
3554 for which the desired help can be found. The English help will always
3555 be used as a last resort. You can add "en" to prefer English over
3556 another language, but that will only find tags that exist in that
3557 language and not in the English help.
3558 Example: >
3559 :set helplang=de,it
3560< This will first search German, then Italian and finally English help
3561 files.
3562 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3563 try to find the tag in the current language before using this option.
3564 See |help-translated|.
3565
3566 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3567'hidden' 'hid' boolean (default off)
3568 global
3569 {not in Vi}
3570 When off a buffer is unloaded when it is |abandon|ed. When on a
3571 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3572 displayed in another window, it does not become hidden, of course.
3573 The commands that move through the buffer list sometimes make a buffer
3574 hidden although the 'hidden' option is off: When the buffer is
3575 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003576 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003577 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 This option is set for one command with ":hide {command}" |:hide|.
3579 WARNING: It's easy to forget that you have changes in hidden buffers.
3580 Think twice when using ":q!" or ":qa!".
3581
3582 *'highlight'* *'hl'*
3583'highlight' 'hl' string (default (as a single string):
3584 "8:SpecialKey,@:NonText,d:Directory,
3585 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3586 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003587 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3589 f:Folded,F:FoldColumn,A:DiffAdd,
3590 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003591 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003592 R:SpellRare,L:SpellLocal,
3593 +:Pmenu,=:PmenuSel,
3594 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003595 global
3596 {not in Vi}
3597 This option can be used to set highlighting mode for various
3598 occasions. It is a comma separated list of character pairs. The
3599 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003600 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3602 |hl-NonText| @ '~' and '@' at the end of the window and
3603 characters from 'showbreak'
3604 |hl-Directory| d directories in CTRL-D listing and other special
3605 things in listings
3606 |hl-ErrorMsg| e error messages
3607 h (obsolete, ignored)
3608 |hl-IncSearch| i 'incsearch' highlighting
3609 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3610 |hl-MoreMsg| m |more-prompt|
3611 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003612 |hl-LineNr| n line number for ":number" and ":#" commands, and
3613 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003614 |hl-Question| r |hit-enter| prompt and yes/no questions
3615 |hl-StatusLine| s status line of current window |status-line|
3616 |hl-StatusLineNC| S status lines of not-current windows
3617 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3618 |hl-VertSplit| c column used to separate vertically split windows
3619 |hl-Visual| v Visual mode
3620 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3621 Selection" Only X11 Gui's |gui-x11| and
3622 |xterm-clipboard|.
3623 |hl-WarningMsg| w warning messages
3624 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3625 |hl-Folded| f line used for closed folds
3626 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003627 |hl-DiffAdd| A added line in diff mode
3628 |hl-DiffChange| C changed line in diff mode
3629 |hl-DiffDelete| D deleted line in diff mode
3630 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003632 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003633 |hl-SpellCap| P word that should start with capital|spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003634 |hl-SpellRare| R rare word |spell|
3635 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003636 |hl-Pmenu| + popup menu normal line
3637 |hl-PmenuSel| = popup menu normal line
3638 |hl-PmenuSbar| x popup menu scrollbar
3639 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003640
3641 The display modes are:
3642 r reverse (termcap entry "mr" and "me")
3643 i italic (termcap entry "ZH" and "ZR")
3644 b bold (termcap entry "md" and "me")
3645 s standout (termcap entry "so" and "se")
3646 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003647 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 n no highlighting
3649 - no highlighting
3650 : use a highlight group
3651 The default is used for occasions that are not included.
3652 If you want to change what the display modes do, see |dos-colors|
3653 for an example.
3654 When using the ':' display mode, this must be followed by the name of
3655 a highlight group. A highlight group can be used to define any type
3656 of highlighting, including using color. See |:highlight| on how to
3657 define one. The default uses a different group for each occasion.
3658 See |highlight-default| for the default highlight groups.
3659
3660 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3661'hlsearch' 'hls' boolean (default off)
3662 global
3663 {not in Vi}
3664 {not available when compiled without the
3665 |+extra_search| feature}
3666 When there is a previous search pattern, highlight all its matches.
3667 The type of highlighting used can be set with the 'l' occasion in the
3668 'highlight' option. This uses the "Search" highlight group by
3669 default. Note that only the matching text is highlighted, any offsets
3670 are not applied.
3671 See also: 'incsearch' and |:match|.
3672 When you get bored looking at the highlighted matches, you can turn it
3673 off with |:nohlsearch|. As soon as you use a search command, the
3674 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003675 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 When the search pattern can match an end-of-line, Vim will try to
3677 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003678 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003680 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 NOTE: This option is reset when 'compatible' is set.
3682
3683 *'history'* *'hi'*
3684'history' 'hi' number (Vim default: 20, Vi default: 0)
3685 global
3686 {not in Vi}
3687 A history of ":" commands, and a history of previous search patterns
3688 are remembered. This option decides how many entries may be stored in
3689 each of these histories (see |cmdline-editing|).
3690 NOTE: This option is set to the Vi default value when 'compatible' is
3691 set and to the Vim default value when 'compatible' is reset.
3692
3693 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3694'hkmap' 'hk' boolean (default off)
3695 global
3696 {not in Vi}
3697 {only available when compiled with the |+rightleft|
3698 feature}
3699 When on, the keyboard is mapped for the Hebrew character set.
3700 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3701 toggle this option. See |rileft.txt|.
3702 NOTE: This option is reset when 'compatible' is set.
3703
3704 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3705'hkmapp' 'hkp' boolean (default off)
3706 global
3707 {not in Vi}
3708 {only available when compiled with the |+rightleft|
3709 feature}
3710 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3711 This is useful if you have a non-Hebrew keyboard.
3712 See |rileft.txt|.
3713 NOTE: This option is reset when 'compatible' is set.
3714
3715 *'icon'* *'noicon'*
3716'icon' boolean (default off, on when title can be restored)
3717 global
3718 {not in Vi}
3719 {not available when compiled without the |+title|
3720 feature}
3721 When on, the icon text of the window will be set to the value of
3722 'iconstring' (if it is not empty), or to the name of the file
3723 currently being edited. Only the last part of the name is used.
3724 Overridden by the 'iconstring' option.
3725 Only works if the terminal supports setting window icons (currently
3726 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3727 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3728 builtin termcap).
3729 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003730 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 X11.
3732
3733 *'iconstring'*
3734'iconstring' string (default "")
3735 global
3736 {not in Vi}
3737 {not available when compiled without the |+title|
3738 feature}
3739 When this option is not empty, it will be used for the icon text of
3740 the window. This happens only when the 'icon' option is on.
3741 Only works if the terminal supports setting window icon text
3742 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3743 Does not work for MS Windows.
3744 When Vim was compiled with HAVE_X11 defined, the original icon will be
3745 restored if possible |X11|.
3746 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003747 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 'titlestring' for example settings.
3749 {not available when compiled without the |+statusline| feature}
3750
3751 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3752'ignorecase' 'ic' boolean (default off)
3753 global
3754 Ignore case in search patterns. Also used when searching in the tags
3755 file.
3756 Also see 'smartcase'.
3757 Can be overruled by using "\c" or "\C" in the pattern, see
3758 |/ignorecase|.
3759
3760 *'imactivatekey'* *'imak'*
3761'imactivatekey' 'imak' string (default "")
3762 global
3763 {not in Vi}
3764 {only available when compiled with |+xim| and
3765 |+GUI_GTK|}
3766 Specifies the key that your Input Method in X-Windows uses for
3767 activation. When this is specified correctly, vim can fully control
3768 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3769 You can't use this option to change the activation key, the option
3770 tells Vim what the key is.
3771 Format:
3772 [MODIFIER_FLAG-]KEY_STRING
3773
3774 These characters can be used for MODIFIER_FLAG (case is ignored):
3775 S Shift key
3776 L Lock key
3777 C Control key
3778 1 Mod1 key
3779 2 Mod2 key
3780 3 Mod3 key
3781 4 Mod4 key
3782 5 Mod5 key
3783 Combinations are allowed, for example "S-C-space" or "SC-space" are
3784 both shift+ctrl+space.
3785 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3786
3787 Example: >
3788 :set imactivatekey=S-space
3789< "S-space" means shift+space. This is the activation key for kinput2 +
3790 canna (Japanese), and ami (Korean).
3791
3792 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3793'imcmdline' 'imc' boolean (default off)
3794 global
3795 {not in Vi}
3796 {only available when compiled with the |+xim|
3797 |+multi_byte_ime| or |global-ime| feature}
3798 When set the Input Method is always on when starting to edit a command
3799 line, unless entering a search pattern (see 'imsearch' for that).
3800 Setting this option is useful when your input method allows entering
3801 English characters directly, e.g., when it's used to type accented
3802 characters with dead keys.
3803
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003804 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3806 global
3807 {not in Vi}
3808 {only available when compiled with the |+xim|
3809 |+multi_byte_ime| or |global-ime| feature}
3810 When set the Input Method is never used. This is useful to disable
3811 the IM when it doesn't work properly.
3812 Currently this option is on by default for SGI/IRIX machines. This
3813 may change in later releases.
3814
3815 *'iminsert'* *'imi'*
3816'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3817 local to buffer
3818 {not in Vi}
3819 Specifies whether :lmap or an Input Method (IM) is to be used in
3820 Insert mode. Valid values:
3821 0 :lmap is off and IM is off
3822 1 :lmap is ON and IM is off
3823 2 :lmap is off and IM is ON
3824 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3825 or |global-ime|.
3826 To always reset the option to zero when leaving Insert mode with <Esc>
3827 this can be used: >
3828 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3829< This makes :lmap and IM turn off automatically when leaving Insert
3830 mode.
3831 Note that this option changes when using CTRL-^ in Insert mode
3832 |i_CTRL-^|.
3833 The value is set to 1 when setting 'keymap' to a valid keymap name.
3834 It is also used for the argument of commands like "r" and "f".
3835 The value 0 may not work correctly with Athena and Motif with some XIM
3836 methods. Use 'imdisable' to disable XIM then.
3837
3838 *'imsearch'* *'ims'*
3839'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3840 local to buffer
3841 {not in Vi}
3842 Specifies whether :lmap or an Input Method (IM) is to be used when
3843 entering a search pattern. Valid values:
3844 -1 the value of 'iminsert' is used, makes it look like
3845 'iminsert' is also used when typing a search pattern
3846 0 :lmap is off and IM is off
3847 1 :lmap is ON and IM is off
3848 2 :lmap is off and IM is ON
3849 Note that this option changes when using CTRL-^ in Command-line mode
3850 |c_CTRL-^|.
3851 The value is set to 1 when it is not -1 and setting the 'keymap'
3852 option to a valid keymap name.
3853 The value 0 may not work correctly with Athena and Motif with some XIM
3854 methods. Use 'imdisable' to disable XIM then.
3855
3856 *'include'* *'inc'*
3857'include' 'inc' string (default "^\s*#\s*include")
3858 global or local to buffer |global-local|
3859 {not in Vi}
3860 {not available when compiled without the
3861 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003862 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00003863 pattern, just like for the "/" command (See |pattern|). The default
3864 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00003865 "]I", "[d", etc.
3866 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003867 comes after the matched pattern. But if "\zs" appears in the pattern
3868 then the text matched from "\zs" to the end, or until "\ze" if it
3869 appears, is used as the file name. Use this to include characters
3870 that are not in 'isfname', such as a space. You can then use
3871 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00003872 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003873
3874 *'includeexpr'* *'inex'*
3875'includeexpr' 'inex' string (default "")
3876 local to buffer
3877 {not in Vi}
3878 {not available when compiled without the
3879 |+find_in_path| or |+eval| feature}
3880 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003881 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 :set includeexpr=substitute(v:fname,'\\.','/','g')
3883< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003884
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003886 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003887 Also used for |<cfile>|.
3888
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003889 The expression may be evaluated in the |sandbox|, see
3890 |sandbox-option|.
3891
3892 It is not allowed to change text or jump to another window while
3893 evaluating 'includeexpr' |textlock|.
3894
Bram Moolenaar071d4272004-06-13 20:20:40 +00003895 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
3896'incsearch' 'is' boolean (default off)
3897 global
3898 {not in Vi}
3899 {not available when compiled without the
3900 |+extra_search| feature}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003901 While typing a search command, show where the pattern, as it was typed
3902 so far, matches. The matched string is highlighted. If the pattern
3903 is invalid or not found, nothing is shown. The screen will be updated
3904 often, this is only useful on fast terminals.
3905 Note that the match will be shown, but the cursor will return to its
3906 original position when no match is found and when pressing <Esc>. You
3907 still need to finish the search command with <Enter> to move the
3908 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00003909 When compiled with the |+reltime| feature Vim only searches for about
3910 half a second. With a complicated pattern and/or a lot of text the
3911 match may not be found. This is to avoid that Vim hangs while you
3912 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00003913 The highlighting can be set with the 'i' flag in 'highlight'.
3914 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00003915 CTRL-L can be used to add one character from after the current match
3916 to the command line.
3917 CTRL-R CTRL-W can be used to add the word at the end of the current
3918 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 NOTE: This option is reset when 'compatible' is set.
3920
3921 *'indentexpr'* *'inde'*
3922'indentexpr' 'inde' string (default "")
3923 local to buffer
3924 {not in Vi}
3925 {not available when compiled without the |+cindent|
3926 or |+eval| features}
3927 Expression which is evaluated to obtain the proper indent for a line.
3928 It is used when a new line is created, for the |=| operator and
3929 in Insert mode as specified with the 'indentkeys' option.
3930 When this option is not empty, it overrules the 'cindent' and
3931 'smartindent' indenting.
3932 When 'paste' is set this option is not used for indenting.
3933 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00003934 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 when the expression is evaluated (but it may be moved around).
3936 The expression must return the number of spaces worth of indent. It
3937 can return "-1" to keep the current indent (this means 'autoindent' is
3938 used for the indent).
3939 Functions useful for computing the indent are |indent()|, |cindent()|
3940 and |lispindent()|.
3941 The evaluation of the expression must not have side effects! It must
3942 not change the text, jump to another window, etc. Afterwards the
3943 cursor position is always restored, thus the cursor may be moved.
3944 Normally this option would be set to call a function: >
3945 :set indentexpr=GetMyIndent()
3946< Error messages will be suppressed, unless the 'debug' option contains
3947 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003948 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 NOTE: This option is made empty when 'compatible' is set.
3950
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003951 The expression may be evaluated in the |sandbox|, see
3952 |sandbox-option|.
3953
3954 It is not allowed to change text or jump to another window while
3955 evaluating 'indentexpr' |textlock|.
3956
3957
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 *'indentkeys'* *'indk'*
3959'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
3960 local to buffer
3961 {not in Vi}
3962 {not available when compiled without the |+cindent|
3963 feature}
3964 A list of keys that, when typed in Insert mode, cause reindenting of
3965 the current line. Only happens if 'indentexpr' isn't empty.
3966 The format is identical to 'cinkeys', see |indentkeys-format|.
3967 See |C-indenting| and |indent-expression|.
3968
3969 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
3970'infercase' 'inf' boolean (default off)
3971 local to buffer
3972 {not in Vi}
3973 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00003974 'ignorecase' is also on, the case of the match is adjusted depending
3975 on the typed text. If the typed text contains a lowercase letter
3976 where the match has an upper case letter, the completed part is made
3977 lowercase. If the typed text has no lowercase letters and the match
3978 has a lowercase letter where the typed text has an uppercase letter,
3979 and there is a letter before it, the completed part is made uppercase.
3980 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003981
3982 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
3983'insertmode' 'im' boolean (default off)
3984 global
3985 {not in Vi}
3986 Makes Vim work in a way that Insert mode is the default mode. Useful
3987 if you want to use Vim as a modeless editor. Used for |evim|.
3988 These Insert mode commands will be useful:
3989 - Use the cursor keys to move around.
3990 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
3991 this is a mapping, it is executed as if 'insertmode' was off.
3992 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003993 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00003994 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
3995 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996
3997 These items change when 'insertmode' is set:
3998 - when starting to edit of a file, Vim goes to Insert mode.
3999 - <Esc> in Insert mode is a no-op and beeps.
4000 - <Esc> in Normal mode makes Vim go to Insert mode.
4001 - CTRL-L in Insert mode is a command, it is not inserted.
4002 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4003 However, when <Esc> is used inside a mapping, it behaves like
4004 'insertmode' was not set. This was done to be able to use the same
4005 mappings with 'insertmode' set or not set.
4006 When executing commands with |:normal| 'insertmode' is not used.
4007
4008 NOTE: This option is reset when 'compatible' is set.
4009
4010 *'isfname'* *'isf'*
4011'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4012 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4013 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4014 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4015 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4016 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4017 global
4018 {not in Vi}
4019 The characters specified by this option are included in file names and
4020 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004021 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 Multi-byte characters 256 and above are always included, only the
4023 characters up to 255 are specified with this option.
4024 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004025 Think twice before adding white space to this option. Although a
4026 space may appear inside a file name, the effect will be that Vim
4027 doesn't know where a file name starts or ends when doing completion.
4028 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029
4030 Note that on systems using a backslash as path separator, Vim tries to
4031 do its best to make it work as you would expect. That is a bit
4032 tricky, since Vi originally used the backslash to escape special
4033 characters. Vim will not remove a backslash in front of a normal file
4034 name character on these systems, but it will on Unix and alikes. The
4035 '&' and '^' are not included by default, because these are special for
4036 cmd.exe.
4037
4038 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004039 Each part can be a single character number or a range. A range is two
4040 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004041 decimal number between 0 and 255 or the ASCII character itself (does
4042 not work for digits). Example:
4043 "_,-,128-140,#-43" (include '_' and '-' and the range
4044 128 to 140 and '#' to 43)
4045 If a part starts with '^', the following character number or range
4046 will be excluded from the option. The option is interpreted from left
4047 to right. Put the excluded character after the range where it is
4048 included. To include '^' itself use it as the last character of the
4049 option or the end of a range. Example:
4050 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4051 If the character is '@', all characters where isalpha() returns TRUE
4052 are included. Normally these are the characters a to z and A to Z,
4053 plus accented characters. To include '@' itself use "@-@". Examples:
4054 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004055 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004056 "a-z,A-Z,@-@" All letters plus the '@' character.
4057 A comma can be included by using it where a character number is
4058 expected. Example:
4059 "48-57,,,_" Digits, comma and underscore.
4060 A comma can be excluded by prepending a '^'. Example:
4061 " -~,^,,9" All characters from space to '~', excluding
4062 comma, plus <Tab>.
4063 See |option-backslash| about including spaces and backslashes.
4064
4065 *'isident'* *'isi'*
4066'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4067 "@,48-57,_,128-167,224-235"
4068 otherwise: "@,48-57,_,192-255")
4069 global
4070 {not in Vi}
4071 The characters given by this option are included in identifiers.
4072 Identifiers are used in recognizing environment variables and after a
4073 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004074 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 option.
4076 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004077 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4079
4080 *'iskeyword'* *'isk'*
4081'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4082 "@,48-57,_,128-167,224-235"
4083 otherwise: "@,48-57,_,192-255"
4084 Vi default: "@,48-57,_")
4085 local to buffer
4086 {not in Vi}
4087 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004088 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 'isfname' for a description of the format of this option. For C
4090 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4091 For a help file it is set to all non-blank printable characters except
4092 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4093 command).
4094 When the 'lisp' option is on the '-' character is always included.
4095 NOTE: This option is set to the Vi default value when 'compatible' is
4096 set and to the Vim default value when 'compatible' is reset.
4097
4098 *'isprint'* *'isp'*
4099'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4100 "@,~-255"; otherwise: "@,161-255")
4101 global
4102 {not in Vi}
4103 The characters given by this option are displayed directly on the
4104 screen. It is also used for "\p" in a |pattern|. The characters from
4105 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4106 even when they are not included in 'isprint' or excluded. See
4107 'isfname' for a description of the format of this option.
4108
4109 Non-printable characters are displayed with two characters:
4110 0 - 31 "^@" - "^_"
4111 32 - 126 always single characters
4112 127 "^?"
4113 128 - 159 "~@" - "~_"
4114 160 - 254 "| " - "|~"
4115 255 "~?"
4116 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4117 displayed as <xx>, with the hexadecimal value of the byte.
4118 When 'display' contains "uhex" all unprintable characters are
4119 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004120 The SpecialKey highlighting will be used for unprintable characters.
4121 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004122
4123 Multi-byte characters 256 and above are always included, only the
4124 characters up to 255 are specified with this option. When a character
4125 is printable but it is not available in the current font, a
4126 replacement character will be shown.
4127 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4128 There is no option to specify these characters.
4129
4130 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4131'joinspaces' 'js' boolean (default on)
4132 global
4133 {not in Vi}
4134 Insert two spaces after a '.', '?' and '!' with a join command.
4135 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4136 Otherwise only one space is inserted.
4137 NOTE: This option is set when 'compatible' is set.
4138
4139 *'key'*
4140'key' string (default "")
4141 local to buffer
4142 {not in Vi}
4143 The key that is used for encrypting and decrypting the current buffer.
4144 See |encryption|.
4145 Careful: Do not set the key value by hand, someone might see the typed
4146 key. Use the |:X| command. But you can make 'key' empty: >
4147 :set key=
4148< It is not possible to get the value of this option with ":set key" or
4149 "echo &key". This is to avoid showing it to someone who shouldn't
4150 know. It also means you cannot see it yourself once you have set it,
4151 be careful not to make a typing error!
4152
4153 *'keymap'* *'kmp'* *E544*
4154'keymap' 'kmp' string (default "")
4155 local to buffer
4156 {not in Vi}
4157 {only available when compiled with the |+keymap|
4158 feature}
4159 Name of a keyboard mapping. See |mbyte-keymap|.
4160 Setting this option to a valid keymap name has the side effect of
4161 setting 'iminsert' to one, so that the keymap becomes effective.
4162 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004163 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164
4165 *'keymodel'* *'km'*
4166'keymodel' 'km' string (default "")
4167 global
4168 {not in Vi}
4169 List of comma separated words, which enable special things that keys
4170 can do. These values can be used:
4171 startsel Using a shifted special key starts selection (either
4172 Select mode or Visual mode, depending on "key" being
4173 present in 'selectmode').
4174 stopsel Using a not-shifted special key stops selection.
4175 Special keys in this context are the cursor keys, <End>, <Home>,
4176 <PageUp> and <PageDown>.
4177 The 'keymodel' option is set by the |:behave| command.
4178
4179 *'keywordprg'* *'kp'*
4180'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4181 OS/2: "view /", VMS: "help")
4182 global or local to buffer |global-local|
4183 {not in Vi}
4184 Program to use for the |K| command. Environment variables are
4185 expanded |:set_env|. ":help" may be used to access the Vim internal
4186 help. (Note that previously setting the global option to the empty
4187 value did this, which is now deprecated.)
4188 When "man" is used, Vim will automatically translate a count for the
4189 "K" command to a section number. Also for "man -s", in which case the
4190 "-s" is removed when there is no count.
4191 See |option-backslash| about including spaces and backslashes.
4192 Example: >
4193 :set keywordprg=man\ -s
4194< This option cannot be set from a |modeline| or in the |sandbox|, for
4195 security reasons.
4196
4197 *'langmap'* *'lmap'* *E357* *E358*
4198'langmap' 'lmap' string (default "")
4199 global
4200 {not in Vi}
4201 {only available when compiled with the |+langmap|
4202 feature}
4203 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004204 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004205 inserted directly. When in command mode the 'langmap' option takes
4206 care of translating these special characters to the original meaning
4207 of the key. This means you don't have to change the keyboard mode to
4208 be able to execute Normal mode commands.
4209 This is the opposite of the 'keymap' option, where characters are
4210 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004212 Example (for Greek, in UTF-8): *greek* >
4213 :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 +00004214< Example (exchanges meaning of z and y for commands): >
4215 :set langmap=zy,yz,ZY,YZ
4216<
4217 The 'langmap' option is a list of parts, separated with commas. Each
4218 part can be in one of two forms:
4219 1. A list of pairs. Each pair is a "from" character immediately
4220 followed by the "to" character. Examples: "aA", "aAbBcC".
4221 2. A list of "from" characters, a semi-colon and a list of "to"
4222 characters. Example: "abc;ABC"
4223 Example: "aA,fgh;FGH,cCdDeE"
4224 Special characters need to be preceded with a backslash. These are
4225 ";", ',' and backslash itself.
4226
4227 This will allow you to activate vim actions without having to switch
4228 back and forth between the languages. Your language characters will
4229 be understood as normal vim English characters (according to the
4230 langmap mappings) in the following cases:
4231 o Normal/Visual mode (commands, buffer/register names, user mappings)
4232 o Insert/Replace Mode: Register names after CTRL-R
4233 o Insert/Replace Mode: Mappings
4234 Characters entered in Command-line mode will NOT be affected by
4235 this option. Note that this option can be changed at any time
4236 allowing to switch between mappings for different languages/encodings.
4237 Use a mapping to avoid having to type it each time!
4238
4239 *'langmenu'* *'lm'*
4240'langmenu' 'lm' string (default "")
4241 global
4242 {not in Vi}
4243 {only available when compiled with the |+menu| and
4244 |+multi_lang| features}
4245 Language to use for menu translation. Tells which file is loaded
4246 from the "lang" directory in 'runtimepath': >
4247 "lang/menu_" . &langmenu . ".vim"
4248< (without the spaces). For example, to always use the Dutch menus, no
4249 matter what $LANG is set to: >
4250 :set langmenu=nl_NL.ISO_8859-1
4251< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004252 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 If your $LANG is set to a non-English language but you do want to use
4254 the English menus: >
4255 :set langmenu=none
4256< This option must be set before loading menus, switching on filetype
4257 detection or syntax highlighting. Once the menus are defined setting
4258 this option has no effect. But you could do this: >
4259 :source $VIMRUNTIME/delmenu.vim
4260 :set langmenu=de_DE.ISO_8859-1
4261 :source $VIMRUNTIME/menu.vim
4262< Warning: This deletes all menus that you defined yourself!
4263
4264 *'laststatus'* *'ls'*
4265'laststatus' 'ls' number (default 1)
4266 global
4267 {not in Vi}
4268 The value of this option influences when the last window will have a
4269 status line:
4270 0: never
4271 1: only if there are at least two windows
4272 2: always
4273 The screen looks nicer with a status line if you have several
4274 windows, but it takes another screen line. |status-line|
4275
4276 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4277'lazyredraw' 'lz' boolean (default off)
4278 global
4279 {not in Vi}
4280 When this option is set, the screen will not be redrawn while
4281 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004282 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283 update use |:redraw|.
4284
4285 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4286'linebreak' 'lbr' boolean (default off)
4287 local to window
4288 {not in Vi}
4289 {not available when compiled without the |+linebreak|
4290 feature}
4291 If on Vim will wrap long lines at a character in 'breakat' rather
4292 than at the last character that fits on the screen. Unlike
4293 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4294 it only affects the way the file is displayed, not its contents. The
4295 value of 'showbreak' is used to put in front of wrapped lines.
4296 This option is not used when the 'wrap' option is off or 'list' is on.
4297 Note that <Tab> characters after an <EOL> are mostly not displayed
4298 with the right amount of white space.
4299
4300 *'lines'* *E593*
4301'lines' number (default 24 or terminal height)
4302 global
4303 Number of lines of the Vim window.
4304 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004305 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 When Vim is running in the GUI or in a resizable window, setting this
4307 option will cause the window size to be changed. When you only want
4308 to use the size for the GUI, put the command in your |gvimrc| file.
4309 Vim limits the number of lines to what fits on the screen. You can
4310 use this command to get the tallest window possible: >
4311 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004312< Minimum value is 2, maximum value is 1000.
4313 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004314 When you set this option and Vim is unable to change the physical
4315 number of lines of the display, the display may be messed up.
4316
4317 *'linespace'* *'lsp'*
4318'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4319 global
4320 {not in Vi}
4321 {only in the GUI}
4322 Number of pixel lines inserted between characters. Useful if the font
4323 uses the full character cell height, making lines touch each other.
4324 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004325 With some fonts there can be too much room between lines (to have
4326 space for ascents and descents). Then it makes sense to set
4327 'linespace' to a negative value. This may cause display problems
4328 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329
4330 *'lisp'* *'nolisp'*
4331'lisp' boolean (default off)
4332 local to buffer
4333 {not available when compiled without the |+lispindent|
4334 feature}
4335 Lisp mode: When <Enter> is typed in insert mode set the indent for
4336 the next line to Lisp standards (well, sort of). Also happens with
4337 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4338 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4339 better. Also see 'lispwords'.
4340 The '-' character is included in keyword characters. Redefines the
4341 "=" operator to use this same indentation algorithm rather than
4342 calling an external program if 'equalprg' is empty.
4343 This option is not used when 'paste' is set.
4344 {Vi: Does it a little bit differently}
4345
4346 *'lispwords'* *'lw'*
4347'lispwords' 'lw' string (default is very long)
4348 global
4349 {not in Vi}
4350 {not available when compiled without the |+lispindent|
4351 feature}
4352 Comma separated list of words that influence the Lisp indenting.
4353 |'lisp'|
4354
4355 *'list'* *'nolist'*
4356'list' boolean (default off)
4357 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004358 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4359 line. Useful to see the difference between tabs and spaces and for
4360 trailing blanks. Further changed by the 'listchars' option.
4361
4362 The cursor is displayed at the start of the space a Tab character
4363 occupies, not at the end as usual in Normal mode. To get this cursor
4364 position while displaying Tabs with spaces, use: >
4365 :set list lcs=tab\ \
4366<
4367 Note that list mode will also affect formatting (set with 'textwidth'
4368 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004369 changing the way tabs are displayed.
4370
4371 *'listchars'* *'lcs'*
4372'listchars' 'lcs' string (default "eol:$")
4373 global
4374 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004375 Strings to use in 'list' mode. It is a comma separated list of string
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 settings.
4377 eol:c Character to show at the end of each line. When
4378 omitted, there is no extra character at the end of the
4379 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004380 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004381 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004382 fill the space that the tab normally occupies.
4383 "tab:>-" will show a tab that takes four spaces as
4384 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004385 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386 trailing spaces are blank.
4387 extends:c Character to show in the last column, when 'wrap' is
4388 off and the line continues beyond the right of the
4389 screen.
4390 precedes:c Character to show in the first column, when 'wrap'
4391 is off and there is text preceding the character
4392 visible in the first column.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004393 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004394 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004396 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004398 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399
4400 Examples: >
4401 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004402 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004403 :set lcs=extends:>,precedes:<
4404< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004405 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004406 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407
4408 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4409'loadplugins' 'lpl' boolean (default on)
4410 global
4411 {not in Vi}
4412 When on the plugin scripts are loaded when starting up |load-plugins|.
4413 This option can be reset in your |vimrc| file to disable the loading
4414 of plugins.
4415 Note that using the "-u NONE" and "--noplugin" command line arguments
4416 reset this option. |-u| |--noplugin|
4417
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004418 *'macatsui'* *'nomacatsui'*
4419'macatsui' boolean (default on)
4420 global
4421 {only available in Mac GUI version}
4422 This is a workaround for when drawing doesn't work properly. When set
4423 and compiled with multi-byte support ATSUI text drawing is used. When
4424 not set ATSUI text drawing is not used. Switch this option off when
4425 you experience drawing problems. In a future version the problems may
4426 be solved and this option becomes obsolete. Therefore use this method
4427 to unset it: >
4428 if exists('&macatsui')
4429 set nomacatsui
4430 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004431< Another option to check if you have drawing problems is
4432 'termencoding'.
4433
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 *'magic'* *'nomagic'*
4435'magic' boolean (default on)
4436 global
4437 Changes the special characters that can be used in search patterns.
4438 See |pattern|.
4439 NOTE: To avoid portability problems with using patterns, always keep
4440 this option at the default "on". Only switch it off when working with
4441 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004442 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
4444 *'makeef'* *'mef'*
4445'makeef' 'mef' string (default: "")
4446 global
4447 {not in Vi}
4448 {not available when compiled without the |+quickfix|
4449 feature}
4450 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4451 and the |:grep| command.
4452 When it is empty, an internally generated temp file will be used.
4453 When "##" is included, it is replaced by a number to make the name
4454 unique. This makes sure that the ":make" command doesn't overwrite an
4455 existing file.
4456 NOT used for the ":cf" command. See 'errorfile' for that.
4457 Environment variables are expanded |:set_env|.
4458 See |option-backslash| about including spaces and backslashes.
4459 This option cannot be set from a |modeline| or in the |sandbox|, for
4460 security reasons.
4461
4462 *'makeprg'* *'mp'*
4463'makeprg' 'mp' string (default "make", VMS: "MMS")
4464 global or local to buffer |global-local|
4465 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004466 Program to use for the ":make" command. See |:make_makeprg|.
4467 This option may contain '%' and '#' characters, which are expanded to
4468 the current and alternate file name. |:_%| |:_#|
4469 Environment variables are expanded |:set_env|. See |option-backslash|
4470 about including spaces and backslashes.
4471 Note that a '|' must be escaped twice: once for ":set" and once for
4472 the interpretation of a command. When you use a filter called
4473 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 :set makeprg=gmake\ \\\|\ myfilter
4475< The placeholder "$*" can be given (even multiple times) to specify
4476 where the arguments will be included, for example: >
4477 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4478< This option cannot be set from a |modeline| or in the |sandbox|, for
4479 security reasons.
4480
4481 *'matchpairs'* *'mps'*
4482'matchpairs' 'mps' string (default "(:),{:},[:]")
4483 local to buffer
4484 {not in Vi}
4485 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004486 other. Currently only single byte character pairs are allowed, and
4487 they must be different. The characters must be separated by a colon.
4488 The pairs must be separated by a comma. Example for including '<' and
4489 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004490 :set mps+=<:>
4491
4492< A more exotic example, to jump between the '=' and ';' in an
4493 assignment, useful for languages like C and Java: >
4494 :au FileType c,cpp,java set mps+==:;
4495
4496< For a more advanced way of using "%", see the matchit.vim plugin in
4497 the $VIMRUNTIME/macros directory. |add-local-help|
4498
4499 *'matchtime'* *'mat'*
4500'matchtime' 'mat' number (default 5)
4501 global
4502 {not in Vi}{in Nvi}
4503 Tenths of a second to show the matching paren, when 'showmatch' is
4504 set. Note that this is not in milliseconds, like other options that
4505 set a time. This is to be compatible with Nvi.
4506
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004507 *'maxcombine'* *'mco'*
4508'maxcombine' 'mco' number (default 2)
4509 global
4510 {not in Vi}
4511 {only available when compiled with the |+multi_byte|
4512 feature}
4513 The maximum number of combining characters supported for displaying.
4514 Only used when 'encoding' is "utf-8".
4515 The default is OK for most languages. Hebrew may require 4.
4516 Maximum value is 6.
4517 Even when this option is set to 2 you can still edit text with more
4518 combining characters, you just can't see them. Use |g8| or |ga|.
4519 See |mbyte-combining|.
4520
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 *'maxfuncdepth'* *'mfd'*
4522'maxfuncdepth' 'mfd' number (default 100)
4523 global
4524 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004525 {not available when compiled without the +eval
4526 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004527 Maximum depth of function calls for user functions. This normally
4528 catches endless recursion. When using a recursive function with
4529 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4530 more memory, there is the danger of failing when memory is exhausted.
4531 See also |:function|.
4532
4533 *'maxmapdepth'* *'mmd'* *E223*
4534'maxmapdepth' 'mmd' number (default 1000)
4535 global
4536 {not in Vi}
4537 Maximum number of times a mapping is done without resulting in a
4538 character to be used. This normally catches endless mappings, like
4539 ":map x y" with ":map y x". It still does not catch ":map g wg",
4540 because the 'w' is used before the next mapping is done. See also
4541 |key-mapping|.
4542
4543 *'maxmem'* *'mm'*
4544'maxmem' 'mm' number (default between 256 to 5120 (system
4545 dependent) or half the amount of memory
4546 available)
4547 global
4548 {not in Vi}
4549 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4550 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004551 other memory to be freed. The maximum usable value is about 2000000.
4552 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004554 *'maxmempattern'* *'mmp'*
4555'maxmempattern' 'mmp' number (default 1000)
4556 global
4557 {not in Vi}
4558 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004559 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004560 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004561 When Vim runs into the limit it gives an error message and mostly
4562 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004563 Running into the limit often means that the pattern is very
4564 inefficient or too complex. This may already happen with the pattern
4565 "\(.\)*" on a very long line. ".*" works much better.
4566 Vim may run out of memory before hitting the 'maxmempattern' limit.
4567
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568 *'maxmemtot'* *'mmt'*
4569'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4570 dependent) or half the amount of memory
4571 available)
4572 global
4573 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004574 Maximum amount of memory in Kbyte to use for all buffers together.
4575 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4576 without a limit. On 64 bit machines higher values might work. But
4577 hey, do you really need more than 2 Gbyte for text editing?
4578 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579
4580 *'menuitems'* *'mis'*
4581'menuitems' 'mis' number (default 25)
4582 global
4583 {not in Vi}
4584 {not available when compiled without the |+menu|
4585 feature}
4586 Maximum number of items to use in a menu. Used for menus that are
4587 generated from a list of items, e.g., the Buffers menu. Changing this
4588 option has no direct effect, the menu must be refreshed first.
4589
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004590 *'mkspellmem'* *'msm'*
4591'mkspellmem' 'msm' string (default "460000,2000,500")
4592 global
4593 {not in Vi}
4594 {not available when compiled without the |+syntax|
4595 feature}
4596 Parameters for |:mkspell|. This tunes when to start compressing the
4597 word tree. Compression can be slow when there are many words, but
4598 it's needed to avoid running out of memory. The amount of memory used
4599 per word depends very much on how similar the words are, that's why
4600 this tuning is complicated.
4601
4602 There are three numbers, separated by commas:
4603 {start},{inc},{added}
4604
4605 For most languages the uncompressed word tree fits in memory. {start}
4606 gives the amount of memory in Kbyte that can be used before any
4607 compression is done. It should be a bit smaller than the amount of
4608 memory that is available to Vim.
4609
4610 When going over the {start} limit the {inc} number specifies the
4611 amount of memory in Kbyte that can be allocated before another
4612 compression is done. A low number means compression is done after
4613 less words are added, which is slow. A high number means more memory
4614 will be allocated.
4615
4616 After doing compression, {added} times 1024 words can be added before
4617 the {inc} limit is ignored and compression is done when any extra
4618 amount of memory is needed. A low number means there is a smaller
4619 chance of hitting the {inc} limit, less memory is used but it's
4620 slower.
4621
4622 The languages for which these numbers are important are Italian and
4623 Hungarian. The default works for when you have about 512 Mbyte. If
4624 you have 1 Gbyte you could use: >
4625 :set mkspellmem=900000,3000,800
4626< If you have less than 512 Mbyte |:mkspell| may fail for some
4627 languages, no matter what you set 'mkspellmem' to.
4628
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004630'modeline' 'ml' boolean (Vim default: on (off for root),
4631 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004632 local to buffer
4633 *'modelines'* *'mls'*
4634'modelines' 'mls' number (default 5)
4635 global
4636 {not in Vi}
4637 If 'modeline' is on 'modelines' gives the number of lines that is
4638 checked for set commands. If 'modeline' is off or 'modelines' is zero
4639 no lines are checked. See |modeline|.
4640 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4641 set and to the Vim default value when 'compatible' is reset.
4642
4643 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4644'modifiable' 'ma' boolean (default on)
4645 local to buffer
4646 {not in Vi} *E21*
4647 When off the buffer contents cannot be changed. The 'fileformat' and
4648 'fileencoding' options also can't be changed.
4649 Can be reset with the |-M| command line argument.
4650
4651 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4652'modified' 'mod' boolean (default off)
4653 local to buffer
4654 {not in Vi}
4655 When on, the buffer is considered to be modified. This option is set
4656 when:
4657 1. A change was made to the text since it was last written. Using the
4658 |undo| command to go back to the original text will reset the
4659 option. But undoing changes that were made before writing the
4660 buffer will set the option again, since the text is different from
4661 when it was written.
4662 2. 'fileformat' or 'fileencoding' is different from its original
4663 value. The original value is set when the buffer is read or
4664 written. A ":set nomodified" command also resets the original
4665 values to the current values and the 'modified' option will be
4666 reset.
4667 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4668 will be ignored.
4669
4670 *'more'* *'nomore'*
4671'more' boolean (Vim default: on, Vi default: off)
4672 global
4673 {not in Vi}
4674 When on, listings pause when the whole screen is filled. You will get
4675 the |more-prompt|. When this option is off there are no pauses, the
4676 listing continues until finished.
4677 NOTE: This option is set to the Vi default value when 'compatible' is
4678 set and to the Vim default value when 'compatible' is reset.
4679
4680 *'mouse'* *E538*
4681'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4682 global
4683 {not in Vi}
4684 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004685 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4686 sysmouse and Linux console with gpm). For using the mouse in the
4687 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 The mouse can be enabled for different modes:
4689 n Normal mode
4690 v Visual mode
4691 i Insert mode
4692 c Command-line mode
4693 h all previous modes when editing a help file
4694 a all previous modes
4695 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004696 Normally you would enable the mouse in all four modes with: >
4697 :set mouse=a
4698< When the mouse is not enabled, the GUI will still use the mouse for
4699 modeless selection. This doesn't move the text cursor.
4700
4701 See |mouse-using|. Also see |'clipboard'|.
4702
4703 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004704 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 the mouse buttons can still be used by keeping the shift key pressed.
4706 Also see the 'clipboard' option.
4707
4708 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4709'mousefocus' 'mousef' boolean (default off)
4710 global
4711 {not in Vi}
4712 {only works in the GUI}
4713 The window that the mouse pointer is on is automatically activated.
4714 When changing the window layout or window focus in another way, the
4715 mouse pointer is moved to the window with keyboard focus. Off is the
4716 default because it makes using the pull down menus a little goofy, as
4717 a pointer transit may activate a window unintentionally.
4718
4719 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4720'mousehide' 'mh' boolean (default on)
4721 global
4722 {not in Vi}
4723 {only works in the GUI}
4724 When on, the mouse pointer is hidden when characters are typed.
4725 The mouse pointer is restored when the mouse is moved.
4726
4727 *'mousemodel'* *'mousem'*
4728'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4729 global
4730 {not in Vi}
4731 Sets the model to use for the mouse. The name mostly specifies what
4732 the right mouse button is used for:
4733 extend Right mouse button extends a selection. This works
4734 like in an xterm.
4735 popup Right mouse button pops up a menu. The shifted left
4736 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004737 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738 popup_setpos Like "popup", but the cursor will be moved to the
4739 position where the mouse was clicked, and thus the
4740 selected operation will act upon the clicked object.
4741 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004742 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 course, that right clicking outside a selection will
4744 end Visual mode.
4745 Overview of what button does what for each model:
4746 mouse extend popup(_setpos) ~
4747 left click place cursor place cursor
4748 left drag start selection start selection
4749 shift-left search word extend selection
4750 right click extend selection popup menu (place cursor)
4751 right drag extend selection -
4752 middle click paste paste
4753
4754 In the "popup" model the right mouse button produces a pop-up menu.
4755 You need to define this first, see |popup-menu|.
4756
4757 Note that you can further refine the meaning of buttons with mappings.
4758 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4759 selection (because that's handled in the GUI code directly).
4760
4761 The 'mousemodel' option is set by the |:behave| command.
4762
4763 *'mouseshape'* *'mouses'* *E547*
4764'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004765 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766 global
4767 {not in Vi}
4768 {only available when compiled with the |+mouseshape|
4769 feature}
4770 This option tells Vim what the mouse pointer should look like in
4771 different modes. The option is a comma separated list of parts, much
4772 like used for 'guicursor'. Each part consist of a mode/location-list
4773 and an argument-list:
4774 mode-list:shape,mode-list:shape,..
4775 The mode-list is a dash separated list of these modes/locations:
4776 In a normal window: ~
4777 n Normal mode
4778 v Visual mode
4779 ve Visual mode with 'selection' "exclusive" (same as 'v',
4780 if not specified)
4781 o Operator-pending mode
4782 i Insert mode
4783 r Replace mode
4784
4785 Others: ~
4786 c appending to the command-line
4787 ci inserting in the command-line
4788 cr replacing in the command-line
4789 m at the 'Hit ENTER' or 'More' prompts
4790 ml idem, but cursor in the last line
4791 e any mode, pointer below last window
4792 s any mode, pointer on a status line
4793 sd any mode, while dragging a status line
4794 vs any mode, pointer on a vertical separator line
4795 vd any mode, while dragging a vertical separator line
4796 a everywhere
4797
4798 The shape is one of the following:
4799 avail name looks like ~
4800 w x arrow Normal mouse pointer
4801 w x blank no pointer at all (use with care!)
4802 w x beam I-beam
4803 w x updown up-down sizing arrows
4804 w x leftright left-right sizing arrows
4805 w x busy The system's usual busy pointer
4806 w x no The system's usual 'no input' pointer
4807 x udsizing indicates up-down resizing
4808 x lrsizing indicates left-right resizing
4809 x crosshair like a big thin +
4810 x hand1 black hand
4811 x hand2 white hand
4812 x pencil what you write with
4813 x question big ?
4814 x rightup-arrow arrow pointing right-up
4815 w x up-arrow arrow pointing up
4816 x <number> any X11 pointer number (see X11/cursorfont.h)
4817
4818 The "avail" column contains a 'w' if the shape is available for Win32,
4819 x for X11.
4820 Any modes not specified or shapes not available use the normal mouse
4821 pointer.
4822
4823 Example: >
4824 :set mouseshape=s:udsizing,m:no
4825< will make the mouse turn to a sizing arrow over the status lines and
4826 indicate no input when the hit-enter prompt is displayed (since
4827 clicking the mouse has no effect in this state.)
4828
4829 *'mousetime'* *'mouset'*
4830'mousetime' 'mouset' number (default 500)
4831 global
4832 {not in Vi}
4833 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4834 time in msec between two mouse clicks for the second click to be
4835 recognized as a multi click.
4836
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004837 *'mzquantum'* *'mzq'*
4838'mzquantum' 'mzq' number (default 100)
4839 global
4840 {not in Vi}
4841 {not available when compiled without the |+mzscheme|
4842 feature}
4843 The number of milliseconds between polls for MzScheme threads.
4844 Negative or zero value means no thread scheduling.
4845
Bram Moolenaar071d4272004-06-13 20:20:40 +00004846 *'nrformats'* *'nf'*
4847'nrformats' 'nf' string (default "octal,hex")
4848 local to buffer
4849 {not in Vi}
4850 This defines what bases Vim will consider for numbers when using the
4851 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4852 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004853 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004854 incremented or decremented. This is useful for a list with a
4855 letter index a), b), etc.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004856 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00004858 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 considered to be hexadecimal. Example: Using CTRL-X on
4860 "0x100" results in "0x0ff".
4861 Numbers which simply begin with a digit in the range 1-9 are always
4862 considered decimal. This also happens for numbers that are not
4863 recognized as octal or hex.
4864
4865 *'number'* *'nu'* *'nonumber'* *'nonu'*
4866'number' 'nu' boolean (default off)
4867 local to window
4868 Print the line number in front of each line. When the 'n' option is
4869 excluded from 'cpoptions' a wrapped line will not use the column of
4870 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004871 The 'numberwidth' option can be used to set the room used for the line
4872 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873 When a long, wrapped line doesn't start with the first character, '-'
4874 characters are put before the number.
4875 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02004876 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004878 *'numberwidth'* *'nuw'*
4879'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
4880 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004881 {not in Vi}
4882 {only available when compiled with the |+linebreak|
4883 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004884 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02004885 when the 'number' or 'relativenumber' option is set or printing lines
4886 with a line number. Since one space is always between the number and
4887 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004888 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02004889 fit the highest line number in the buffer respectively the number of
4890 rows in the window, depending on whether 'number' or 'relativenumber'
4891 is set. Thus with the Vim default of 4 there is room for a line number
4892 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004893 The minimum value is 1, the maximum value is 10.
4894 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
4895
Bram Moolenaarf75a9632005-09-13 21:20:47 +00004896 *'omnifunc'* *'ofu'*
4897'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00004898 local to buffer
4899 {not in Vi}
4900 {not available when compiled without the +eval
4901 or +insert_expand feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00004902 This option specifies a function to be used for Insert mode omni
4903 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00004904 See |complete-functions| for an explanation of how the function is
4905 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00004906 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00004907 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00004908
4909
Bram Moolenaar02467872007-05-06 13:22:01 +00004910 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00004911'opendevice' 'odev' boolean (default off)
4912 global
4913 {not in Vi}
4914 {only for MS-DOS, MS-Windows and OS/2}
4915 Enable reading and writing from devices. This may get Vim stuck on a
4916 device that can be opened but doesn't actually do the I/O. Therefore
4917 it is off by default.
4918 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
4919 result in editing a device.
4920
4921
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00004922 *'operatorfunc'* *'opfunc'*
4923'operatorfunc' 'opfunc' string (default: empty)
4924 global
4925 {not in Vi}
4926 This option specifies a function to be called by the |g@| operator.
4927 See |:map-operator| for more info and an example.
4928
4929 This option cannot be set from a |modeline| or in the |sandbox|, for
4930 security reasons.
4931
4932
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933 *'osfiletype'* *'oft'* *E366*
4934'osfiletype' 'oft' string (RISC-OS default: "Text",
4935 others default: "")
4936 local to buffer
4937 {not in Vi}
4938 {only available when compiled with the |+osfiletype|
4939 feature}
4940 Some operating systems store extra information about files besides
4941 name, datestamp and permissions. This option contains the extra
4942 information, the nature of which will vary between systems.
4943 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00004944 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004945 It can affect the pattern matching of the automatic commands.
4946 |autocmd-osfiletypes|
4947
4948 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00004949'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004950 global
4951 Specifies the nroff macros that separate paragraphs. These are pairs
4952 of two letters (see |object-motions|).
4953
4954 *'paste'* *'nopaste'*
4955'paste' boolean (default off)
4956 global
4957 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004958 Put Vim in Paste mode. This is useful if you want to cut or copy
4959 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 unexpected effects.
4961 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004962 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00004963 knows about pasting and will mostly do the right thing without 'paste'
4964 being set. The same is true for a terminal where Vim handles the
4965 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00004966 This option is reset when starting the GUI. Thus if you set it in
4967 your .vimrc it will work in a terminal, but not in the GUI. Setting
4968 'paste' in the GUI has side effects: e.g., the Paste toolbar button
4969 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 When the 'paste' option is switched on (also when it was already on):
4971 - mapping in Insert mode and Command-line mode is disabled
4972 - abbreviations are disabled
4973 - 'textwidth' is set to 0
4974 - 'wrapmargin' is set to 0
4975 - 'autoindent' is reset
4976 - 'smartindent' is reset
4977 - 'softtabstop' is set to 0
4978 - 'revins' is reset
4979 - 'ruler' is reset
4980 - 'showmatch' is reset
4981 - 'formatoptions' is used like it is empty
4982 These options keep their value, but their effect is disabled:
4983 - 'lisp'
4984 - 'indentexpr'
4985 - 'cindent'
4986 NOTE: When you start editing another file while the 'paste' option is
4987 on, settings from the modelines or autocommands may change the
4988 settings again, causing trouble when pasting text. You might want to
4989 set the 'paste' option again.
4990 When the 'paste' option is reset the mentioned options are restored to
4991 the value before the moment 'paste' was switched from off to on.
4992 Resetting 'paste' before ever setting it does not have any effect.
4993 Since mapping doesn't work while 'paste' is active, you need to use
4994 the 'pastetoggle' option to toggle the 'paste' option with some key.
4995
4996 *'pastetoggle'* *'pt'*
4997'pastetoggle' 'pt' string (default "")
4998 global
4999 {not in Vi}
5000 When non-empty, specifies the key sequence that toggles the 'paste'
5001 option. This is like specifying a mapping: >
5002 :map {keys} :set invpaste<CR>
5003< Where {keys} is the value of 'pastetoggle'.
5004 The difference is that it will work even when 'paste' is set.
5005 'pastetoggle' works in Insert mode and Normal mode, but not in
5006 Command-line mode.
5007 Mappings are checked first, thus overrule 'pastetoggle'. However,
5008 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5009 this: >
5010 :map <F10> :set paste<CR>
5011 :map <F11> :set nopaste<CR>
5012 :imap <F10> <C-O>:set paste<CR>
5013 :imap <F11> <nop>
5014 :set pastetoggle=<F11>
5015< This will make <F10> start paste mode and <F11> stop paste mode.
5016 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5017 mode everything is inserted literally, except the 'pastetoggle' key
5018 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005019 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020
5021 *'pex'* *'patchexpr'*
5022'patchexpr' 'pex' string (default "")
5023 global
5024 {not in Vi}
5025 {not available when compiled without the |+diff|
5026 feature}
5027 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005028 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005029
5030 *'patchmode'* *'pm'* *E206*
5031'patchmode' 'pm' string (default "")
5032 global
5033 {not in Vi}
5034 When non-empty the oldest version of a file is kept. This can be used
5035 to keep the original version of a file if you are changing files in a
5036 source distribution. Only the first time that a file is written a
5037 copy of the original file will be kept. The name of the copy is the
5038 name of the original file with the string in the 'patchmode' option
5039 appended. This option should start with a dot. Use a string like
5040 ".org". 'backupdir' must not be empty for this to work (Detail: The
5041 backup file is renamed to the patchmode file after the new file has
5042 been successfully written, that's why it must be possible to write a
5043 backup file). If there was no file to be backed up, an empty file is
5044 created.
5045 When the 'backupskip' pattern matches, a patchmode file is not made.
5046 Using 'patchmode' for compressed files appends the extension at the
5047 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5048 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005049 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050
5051 *'path'* *'pa'* *E343* *E345* *E347*
5052'path' 'pa' string (default on Unix: ".,/usr/include,,"
5053 on OS/2: ".,/emx/include,,"
5054 other systems: ".,,")
5055 global or local to buffer |global-local|
5056 {not in Vi}
5057 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005058 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5059 provided that the file being searched for has a relative path (not
5060 starting with "/", "./" or "../"). The directories in the 'path'
5061 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 - Use commas to separate directory names: >
5063 :set path=.,/usr/local/include,/usr/include
5064< - Spaces can also be used to separate directory names (for backwards
5065 compatibility with version 3.0). To have a space in a directory
5066 name, precede it with an extra backslash, and escape the space: >
5067 :set path=.,/dir/with\\\ space
5068< - To include a comma in a directory name precede it with an extra
5069 backslash: >
5070 :set path=.,/dir/with\\,comma
5071< - To search relative to the directory of the current file, use: >
5072 :set path=.
5073< - To search in the current directory use an empty string between two
5074 commas: >
5075 :set path=,,
5076< - A directory name may end in a ':' or '/'.
5077 - Environment variables are expanded |:set_env|.
5078 - When using |netrw.vim| URLs can be used. For example, adding
5079 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005080 - Search upwards and downwards in a directory tree using "*", "**" and
5081 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005082 {not available when compiled without the |+path_extra| feature}
5083 - Careful with '\' characters, type two to get one in the option: >
5084 :set path=.,c:\\include
5085< Or just use '/' instead: >
5086 :set path=.,c:/include
5087< Don't forget "." or files won't even be found in the same directory as
5088 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005089 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005090 it is something like 256 or 1024 characters.
5091 You can check if all the include files are found, using the value of
5092 'path', see |:checkpath|.
5093 The use of |:set+=| and |:set-=| is preferred when adding or removing
5094 directories from the list. This avoids problems when a future version
5095 uses another default. To remove the current directory use: >
5096 :set path-=
5097< To add the current directory use: >
5098 :set path+=
5099< To use an environment variable, you probably need to replace the
5100 separator. Here is an example to append $INCL, in which directory
5101 names are separated with a semi-colon: >
5102 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5103< Replace the ';' with a ':' or whatever separator is used. Note that
5104 this doesn't work when $INCL contains a comma or white space.
5105
5106 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5107'preserveindent' 'pi' boolean (default off)
5108 local to buffer
5109 {not in Vi}
5110 When changing the indent of the current line, preserve as much of the
5111 indent structure as possible. Normally the indent is replaced by a
5112 series of tabs followed by spaces as required (unless |'expandtab'| is
5113 enabled, in which case only spaces are used). Enabling this option
5114 means the indent will preserve as many existing characters as possible
5115 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005116 'expandtab' does not apply to the preserved white space, a Tab remains
5117 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005118 NOTE: When using ">>" multiple times the resulting indent is a mix of
5119 tabs and spaces. You might not like this.
5120 NOTE: 'preserveindent' is reset when 'compatible' is set.
5121 Also see 'copyindent'.
5122 Use |:retab| to clean up white space.
5123
5124 *'previewheight'* *'pvh'*
5125'previewheight' 'pvh' number (default 12)
5126 global
5127 {not in Vi}
5128 {not available when compiled without the |+windows| or
5129 |+quickfix| feature}
5130 Default height for a preview window. Used for |:ptag| and associated
5131 commands. Used for |CTRL-W_}| when no count is given.
5132
5133 *'previewwindow'* *'nopreviewwindow'*
5134 *'pvw'* *'nopvw'* *E590*
5135'previewwindow' 'pvw' boolean (default off)
5136 local to window
5137 {not in Vi}
5138 {not available when compiled without the |+windows| or
5139 |+quickfix| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005140 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 set. It's normally not set directly, but by using one of the commands
5142 |:ptag|, |:pedit|, etc.
5143
5144 *'printdevice'* *'pdev'*
5145'printdevice' 'pdev' string (default empty)
5146 global
5147 {not in Vi}
5148 {only available when compiled with the |+printer|
5149 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005150 The name of the printer to be used for |:hardcopy|.
5151 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005152 This option cannot be set from a |modeline| or in the |sandbox|, for
5153 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154
Bram Moolenaar8299df92004-07-10 09:47:34 +00005155 *'printencoding'* *'penc'*
5156'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 global
5158 {not in Vi}
5159 {only available when compiled with the |+printer|
5160 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005161 Sets the character encoding used when printing.
5162 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005163
5164 *'printexpr'* *'pexpr'*
5165'printexpr' 'pexpr' String (default: see below)
5166 global
5167 {not in Vi}
5168 {only available when compiled with the |+printer|
5169 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005170 Expression used to print the PostScript produced with |:hardcopy|.
5171 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
Bram Moolenaar8299df92004-07-10 09:47:34 +00005173 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174'printfont' 'pfn' string (default "courier")
5175 global
5176 {not in Vi}
5177 {only available when compiled with the |+printer|
5178 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005179 The name of the font that will be used for |:hardcopy|.
5180 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005181
5182 *'printheader'* *'pheader'*
5183'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5184 global
5185 {not in Vi}
5186 {only available when compiled with the |+printer|
5187 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005188 The format of the header produced in |:hardcopy| output.
5189 See |pheader-option|.
5190
5191 *'printmbcharset'* *'pmbcs'*
5192'printmbcharset' 'pmbcs' string (default "")
5193 global
5194 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005195 {only available when compiled with the |+printer|,
5196 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005197 The CJK character set to be used for CJK output from |:hardcopy|.
5198 See |pmbcs-option|.
5199
5200 *'printmbfont'* *'pmbfn'*
5201'printmbfont' 'pmbfn' string (default "")
5202 global
5203 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005204 {only available when compiled with the |+printer|,
5205 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005206 List of font names to be used for CJK output from |:hardcopy|.
5207 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208
5209 *'printoptions'* *'popt'*
5210'printoptions' 'popt' string (default "")
5211 global
5212 {not in Vi}
5213 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005214 List of items that control the format of the output of |:hardcopy|.
5215 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005217 *'prompt'* *'noprompt'*
5218'prompt' boolean (default on)
5219 global
5220 When on a ":" prompt is used in Ex mode.
5221
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005222 *'pumheight'* *'ph'*
5223'pumheight' 'ph' number (default 0)
5224 global
5225 {not available when compiled without the
5226 |+insert_expand| feature}
5227 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005228 Determines the maximum number of items to show in the popup menu for
5229 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005230 |ins-completion-menu|.
5231
5232
Bram Moolenaar677ee682005-01-27 14:41:15 +00005233 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005234'quoteescape' 'qe' string (default "\")
5235 local to buffer
5236 {not in Vi}
5237 The characters that are used to escape quotes in a string. Used for
5238 objects like a', a" and a` |a'|.
5239 When one of the characters in this option is found inside a string,
5240 the following character will be skipped. The default value makes the
5241 text "foo\"bar\\" considered to be one string.
5242
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5244'readonly' 'ro' boolean (default off)
5245 local to buffer
5246 If on, writes fail unless you use a '!'. Protects you from
5247 accidentally overwriting a file. Default on when Vim is started
5248 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005249 When using ":w!" the 'readonly' option is reset for the current
5250 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005251 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005252 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005254 *'redrawtime'* *'rdt'*
5255'redrawtime' 'rdt' number (default 2000)
5256 global
5257 {not in Vi}
5258 {only available when compiled with the |+reltime|
5259 feature}
5260 The time in milliseconds for redrawing the display. This applies to
5261 searching for patterns for 'hlsearch' and |:match| highlighting.
5262 When redrawing takes more than this many milliseconds no further
5263 matches will be highlighted. This is used to avoid that Vim hangs
5264 when using a very complicated pattern.
5265
Bram Moolenaar64486672010-05-16 15:46:46 +02005266 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5267'relativenumber' 'rnu' boolean (default off)
5268 local to window
5269 {not in Vi}
5270 Show the line number relative to the line with the cursor in front of
5271 each line. Relative line numbers help you using the |count| you can
5272 precede some vertical motion commands (e.g. j k + -) with, without
5273 having to calculate it yourself. Especially useful in combination with
5274 other commands (e.g. y d c < > gq gw =).
5275 When the 'n' option is excluded from 'cpoptions' a wrapped
5276 line will not use the column of line numbers (this is the default when
5277 'compatible' isn't set).
5278 The 'numberwidth' option can be used to set the room used for the line
5279 number.
5280 When a long, wrapped line doesn't start with the first character, '-'
5281 characters are put before the number.
5282 See |hl-LineNr| for the highlighting used for the number.
5283 When setting this option, 'number' is reset.
5284
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 *'remap'* *'noremap'*
5286'remap' boolean (default on)
5287 global
5288 Allows for mappings to work recursively. If you do not want this for
5289 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005290 NOTE: To avoid portability problems with Vim scripts, always keep
5291 this option at the default "on". Only switch it off when working with
5292 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005293
5294 *'report'*
5295'report' number (default 2)
5296 global
5297 Threshold for reporting number of lines changed. When the number of
5298 changed lines is more than 'report' a message will be given for most
5299 ":" commands. If you want it always, set 'report' to 0.
5300 For the ":substitute" command the number of substitutions is used
5301 instead of the number of lines.
5302
5303 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5304'restorescreen' 'rs' boolean (default on)
5305 global
5306 {not in Vi} {only in Windows 95/NT console version}
5307 When set, the screen contents is restored when exiting Vim. This also
5308 happens when executing external commands.
5309
5310 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5311 options in your .vimrc. To disable restoring:
5312 set t_ti= t_te=
5313 To enable restoring (for an xterm):
5314 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5315 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5316
5317 *'revins'* *'ri'* *'norevins'* *'nori'*
5318'revins' 'ri' boolean (default off)
5319 global
5320 {not in Vi}
5321 {only available when compiled with the |+rightleft|
5322 feature}
5323 Inserting characters in Insert mode will work backwards. See "typing
5324 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5325 command in Insert mode, when 'allowrevins' is set.
5326 NOTE: This option is reset when 'compatible' or 'paste' is set.
5327
5328 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5329'rightleft' 'rl' boolean (default off)
5330 local to window
5331 {not in Vi}
5332 {only available when compiled with the |+rightleft|
5333 feature}
5334 When on, display orientation becomes right-to-left, i.e., characters
5335 that are stored in the file appear from the right to the left.
5336 Using this option, it is possible to edit files for languages that
5337 are written from the right to the left such as Hebrew and Arabic.
5338 This option is per window, so it is possible to edit mixed files
5339 simultaneously, or to view the same file in both ways (this is
5340 useful whenever you have a mixed text file with both right-to-left
5341 and left-to-right strings so that both sets are displayed properly
5342 in different windows). Also see |rileft.txt|.
5343
5344 *'rightleftcmd'* *'rlc'* *'norightleftcmd'* *'norlc'*
5345'rightleftcmd' 'rlc' string (default "search")
5346 local to window
5347 {not in Vi}
5348 {only available when compiled with the |+rightleft|
5349 feature}
5350 Each word in this option enables the command line editing to work in
5351 right-to-left mode for a group of commands:
5352
5353 search "/" and "?" commands
5354
5355 This is useful for languages such as Hebrew, Arabic and Farsi.
5356 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5357
5358 *'ruler'* *'ru'* *'noruler'* *'noru'*
5359'ruler' 'ru' boolean (default off)
5360 global
5361 {not in Vi}
5362 {not available when compiled without the
5363 |+cmdline_info| feature}
5364 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005365 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005366 text in the file is shown on the far right:
5367 Top first line is visible
5368 Bot last line is visible
5369 All first and last line are visible
5370 45% relative position in the file
5371 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005372 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005373 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005374 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 this option takes precedence over 'ruler' and 'rulerformat'
5376 If the number of characters displayed is different from the number of
5377 bytes in the text (e.g., for a TAB or a multi-byte character), both
5378 the text column (byte number) and the screen column are shown,
5379 separated with a dash.
5380 For an empty line "0-1" is shown.
5381 For an empty buffer the line number will also be zero: "0,0-1".
5382 This option is reset when the 'paste' option is set.
5383 If you don't want to see the ruler all the time but want to know where
5384 you are, use "g CTRL-G" |g_CTRL-G|.
5385 NOTE: This option is reset when 'compatible' is set.
5386
5387 *'rulerformat'* *'ruf'*
5388'rulerformat' 'ruf' string (default empty)
5389 global
5390 {not in Vi}
5391 {not available when compiled without the |+statusline|
5392 feature}
5393 When this option is not empty, it determines the content of the ruler
5394 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005395 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005396 The default ruler width is 17 characters. To make the ruler 15
5397 characters wide, put "%15(" at the start and "%)" at the end.
5398 Example: >
5399 :set rulerformat=%15(%c%V\ %p%%%)
5400<
5401 *'runtimepath'* *'rtp'* *vimfiles*
5402'runtimepath' 'rtp' string (default:
5403 Unix: "$HOME/.vim,
5404 $VIM/vimfiles,
5405 $VIMRUNTIME,
5406 $VIM/vimfiles/after,
5407 $HOME/.vim/after"
5408 Amiga: "home:vimfiles,
5409 $VIM/vimfiles,
5410 $VIMRUNTIME,
5411 $VIM/vimfiles/after,
5412 home:vimfiles/after"
5413 PC, OS/2: "$HOME/vimfiles,
5414 $VIM/vimfiles,
5415 $VIMRUNTIME,
5416 $VIM/vimfiles/after,
5417 $HOME/vimfiles/after"
5418 Macintosh: "$VIM:vimfiles,
5419 $VIMRUNTIME,
5420 $VIM:vimfiles:after"
5421 RISC-OS: "Choices:vimfiles,
5422 $VIMRUNTIME,
5423 Choices:vimfiles/after"
5424 VMS: "sys$login:vimfiles,
5425 $VIM/vimfiles,
5426 $VIMRUNTIME,
5427 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005428 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 global
5430 {not in Vi}
5431 This is a list of directories which will be searched for runtime
5432 files:
5433 filetype.vim filetypes by file name |new-filetype|
5434 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005435 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005436 colors/ color scheme files |:colorscheme|
5437 compiler/ compiler files |:compiler|
5438 doc/ documentation |write-local-help|
5439 ftplugin/ filetype plugins |write-filetype-plugin|
5440 indent/ indent scripts |indent-expression|
5441 keymap/ key mapping files |mbyte-keymap|
5442 lang/ menu translations |:menutrans|
5443 menu.vim GUI menus |menu.vim|
5444 plugin/ plugin scripts |write-plugin|
5445 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005446 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447 syntax/ syntax files |mysyntaxfile|
5448 tutor/ files for vimtutor |tutor|
5449
5450 And any other file searched for with the |:runtime| command.
5451
5452 The defaults for most systems are setup to search five locations:
5453 1. In your home directory, for your personal preferences.
5454 2. In a system-wide Vim directory, for preferences from the system
5455 administrator.
5456 3. In $VIMRUNTIME, for files distributed with Vim.
5457 *after-directory*
5458 4. In the "after" directory in the system-wide Vim directory. This is
5459 for the system administrator to overrule or add to the distributed
5460 defaults (rarely needed)
5461 5. In the "after" directory in your home directory. This is for
5462 personal preferences to overrule or add to the distributed defaults
5463 or system-wide settings (rarely needed).
5464
5465 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5466 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005467 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005468 wildcards.
5469 See |:runtime|.
5470 Example: >
5471 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5472< This will use the directory "~/vimruntime" first (containing your
5473 personal Vim runtime files), then "/mygroup/vim" (shared between a
5474 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5475 files).
5476 You probably should always include $VIMRUNTIME somewhere, to use the
5477 distributed runtime files. You can put a directory before $VIMRUNTIME
5478 to find files which replace a distributed runtime files. You can put
5479 a directory after $VIMRUNTIME to find files which add to distributed
5480 runtime files.
5481 This option cannot be set from a |modeline| or in the |sandbox|, for
5482 security reasons.
5483
5484 *'scroll'* *'scr'*
5485'scroll' 'scr' number (default: half the window height)
5486 local to window
5487 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5488 set to half the number of lines in the window when the window size
5489 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005490 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5492 the number of screen lines instead of file lines, makes a difference
5493 when lines wrap}
5494
5495 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5496'scrollbind' 'scb' boolean (default off)
5497 local to window
5498 {not in Vi}
5499 {not available when compiled without the |+scrollbind|
5500 feature}
5501 See also |scroll-binding|. When this option is set, the current
5502 window scrolls as other scrollbind windows (windows that also have
5503 this option set) scroll. This option is useful for viewing the
5504 differences between two versions of a file, see 'diff'.
5505 See |'scrollopt'| for options that determine how this option should be
5506 interpreted.
5507 This option is mostly reset when splitting a window to edit another
5508 file. This means that ":split | edit file" results in two windows
5509 with scroll-binding, but ":split file" does not.
5510
5511 *'scrolljump'* *'sj'*
5512'scrolljump' 'sj' number (default 1)
5513 global
5514 {not in Vi}
5515 Minimal number of lines to scroll when the cursor gets off the
5516 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5517 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005518 When set to a negative number from -1 to -100 this is used as the
5519 percentage of the window height. Thus -50 scrolls half the window
5520 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 NOTE: This option is set to 1 when 'compatible' is set.
5522
5523 *'scrolloff'* *'so'*
5524'scrolloff' 'so' number (default 0)
5525 global
5526 {not in Vi}
5527 Minimal number of screen lines to keep above and below the cursor.
5528 This will make some context visible around where you are working. If
5529 you set it to a very large value (999) the cursor line will always be
5530 in the middle of the window (except at the start or end of the file or
5531 when long lines wrap).
5532 For scrolling horizontally see 'sidescrolloff'.
5533 NOTE: This option is set to 0 when 'compatible' is set.
5534
5535 *'scrollopt'* *'sbo'*
5536'scrollopt' 'sbo' string (default "ver,jump")
5537 global
5538 {not available when compiled without the |+scrollbind|
5539 feature}
5540 {not in Vi}
5541 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005542 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5543 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 The following words are available:
5545 ver Bind vertical scrolling for 'scrollbind' windows
5546 hor Bind horizontal scrolling for 'scrollbind' windows
5547 jump Applies to the offset between two windows for vertical
5548 scrolling. This offset is the difference in the first
5549 displayed line of the bound windows. When moving
5550 around in a window, another 'scrollbind' window may
5551 reach a position before the start or after the end of
5552 the buffer. The offset is not changed though, when
5553 moving back the 'scrollbind' window will try to scroll
5554 to the desired position when possible.
5555 When now making that window the current one, two
5556 things can be done with the relative offset:
5557 1. When "jump" is not included, the relative offset is
5558 adjusted for the scroll position in the new current
5559 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005560 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005561 2. When "jump" is included, the other windows are
5562 scrolled to keep the same relative offset. When
5563 going back to the other window, it still uses the
5564 same relative offset.
5565 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005566 When 'diff' mode is active there always is vertical scroll binding,
5567 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568
5569 *'sections'* *'sect'*
5570'sections' 'sect' string (default "SHNHH HUnhsh")
5571 global
5572 Specifies the nroff macros that separate sections. These are pairs of
5573 two letters (See |object-motions|). The default makes a section start
5574 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5575
5576 *'secure'* *'nosecure'* *E523*
5577'secure' boolean (default off)
5578 global
5579 {not in Vi}
5580 When on, ":autocmd", shell and write commands are not allowed in
5581 ".vimrc" and ".exrc" in the current directory and map commands are
5582 displayed. Switch it off only if you know that you will not run into
5583 problems, or when the 'exrc' option is off. On Unix this option is
5584 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005585 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005586 'secure' at the end of your ~/.vimrc then.
5587 This option cannot be set from a |modeline| or in the |sandbox|, for
5588 security reasons.
5589
5590 *'selection'* *'sel'*
5591'selection' 'sel' string (default "inclusive")
5592 global
5593 {not in Vi}
5594 This option defines the behavior of the selection. It is only used
5595 in Visual and Select mode.
5596 Possible values:
5597 value past line inclusive ~
5598 old no yes
5599 inclusive yes yes
5600 exclusive yes no
5601 "past line" means that the cursor is allowed to be positioned one
5602 character past the line.
5603 "inclusive" means that the last character of the selection is included
5604 in an operation. For example, when "x" is used to delete the
5605 selection.
5606 Note that when "exclusive" is used and selecting from the end
5607 backwards, you cannot include the last character of a line, when
5608 starting in Normal mode and 'virtualedit' empty.
5609
5610 The 'selection' option is set by the |:behave| command.
5611
5612 *'selectmode'* *'slm'*
5613'selectmode' 'slm' string (default "")
5614 global
5615 {not in Vi}
5616 This is a comma separated list of words, which specifies when to start
5617 Select mode instead of Visual mode, when a selection is started.
5618 Possible values:
5619 mouse when using the mouse
5620 key when using shifted special keys
5621 cmd when using "v", "V" or CTRL-V
5622 See |Select-mode|.
5623 The 'selectmode' option is set by the |:behave| command.
5624
5625 *'sessionoptions'* *'ssop'*
5626'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005627 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005628 global
5629 {not in Vi}
5630 {not available when compiled without the +mksession
5631 feature}
5632 Changes the effect of the |:mksession| command. It is a comma
5633 separated list of words. Each word enables saving and restoring
5634 something:
5635 word save and restore ~
5636 blank empty windows
5637 buffers hidden and unloaded buffers, not just those in windows
5638 curdir the current directory
5639 folds manually created folds, opened/closed folds and local
5640 fold options
5641 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005642 and contain at least one lowercase letter. Only
5643 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 help the help window
5645 localoptions options and mappings local to a window or buffer (not
5646 global values for local options)
5647 options all options and mappings (also global values for local
5648 options)
5649 resize size of the Vim window: 'lines' and 'columns'
5650 sesdir the directory in which the session file is located
5651 will become the current directory (useful with
5652 projects accessed over a network from different
5653 systems)
5654 slash backslashes in file names replaced with forward
5655 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005656 tabpages all tab pages; without this only the current tab page
5657 is restored, so that you can make a session for each
5658 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005659 unix with Unix end-of-line format (single <NL>), even when
5660 on Windows or DOS
5661 winpos position of the whole Vim window
5662 winsize window sizes
5663
5664 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005665 When neither "curdir" nor "sesdir" is included, file names are stored
5666 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 "slash" and "unix" are useful on Windows when sharing session files
5668 with Unix. The Unix version of Vim cannot source dos format scripts,
5669 but the Windows version of Vim can source unix format scripts.
5670
5671 *'shell'* *'sh'* *E91*
5672'shell' 'sh' string (default $SHELL or "sh",
5673 MS-DOS and Win32: "command.com" or
5674 "cmd.exe", OS/2: "cmd")
5675 global
5676 Name of the shell to use for ! and :! commands. When changing the
5677 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5678 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005679 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 See |option-backslash| about including spaces and backslashes.
5681 Environment variables are expanded |:set_env|.
5682 If the name of the shell contains a space, you might need to enclose
5683 it in quotes. Example: >
5684 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5685< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005686 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005687 "-f" is not inside the quotes, because it is not part of the command
5688 name. And Vim automagically recognizes the backslashes that are path
5689 separators.
5690 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5691 variable to change the way external commands are executed. See the
5692 libc.inf file of DJGPP.
5693 Under MS-Windows, when the executable ends in ".com" it must be
5694 included. Thus setting the shell to "command.com" or "4dos.com"
5695 works, but "command" and "4dos" do not work for all commands (e.g.,
5696 filtering).
5697 For unknown reasons, when using "4dos.com" the current directory is
5698 changed to "C:\". To avoid this set 'shell' like this: >
5699 :set shell=command.com\ /c\ 4dos
5700< This option cannot be set from a |modeline| or in the |sandbox|, for
5701 security reasons.
5702
5703 *'shellcmdflag'* *'shcf'*
5704'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5705 does not contain "sh" somewhere: "/c")
5706 global
5707 {not in Vi}
5708 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5709 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5710 systems, the default is set according to the value of 'shell', to
5711 reduce the need to set this option by the user. It's not used for
5712 OS/2 (EMX figures this out itself). See |option-backslash| about
5713 including spaces and backslashes. See |dos-shell|.
5714 This option cannot be set from a |modeline| or in the |sandbox|, for
5715 security reasons.
5716
5717 *'shellpipe'* *'sp'*
5718'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5719 global
5720 {not in Vi}
5721 {not available when compiled without the |+quickfix|
5722 feature}
5723 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 including spaces and backslashes.
5726 The name of the temporary file can be represented by "%s" if necessary
5727 (the file name is appended automatically if no %s appears in the value
5728 of this option).
5729 For the Amiga and MS-DOS the default is ">". The output is directly
5730 saved in a file and not echoed to the screen.
5731 For Unix the default it "| tee". The stdout of the compiler is saved
5732 in a file and echoed to the screen. If the 'shell' option is "csh" or
5733 "tcsh" after initializations, the default becomes "|& tee". If the
5734 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005735 "2>&1| tee". This means that stderr is also included. Before using
5736 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 The initialization of this option is done after reading the ".vimrc"
5738 and the other initializations, so that when the 'shell' option is set
5739 there, the 'shellpipe' option changes automatically, unless it was
5740 explicitly set before.
5741 When 'shellpipe' is set to an empty string, no redirection of the
5742 ":make" output will be done. This is useful if you use a 'makeprg'
5743 that writes to 'makeef' by itself. If you want no piping, but do
5744 want to include the 'makeef', set 'shellpipe' to a single space.
5745 Don't forget to precede the space with a backslash: ":set sp=\ ".
5746 In the future pipes may be used for filtering and this option will
5747 become obsolete (at least for Unix).
5748 This option cannot be set from a |modeline| or in the |sandbox|, for
5749 security reasons.
5750
5751 *'shellquote'* *'shq'*
5752'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5753 contains "sh" somewhere: "\"")
5754 global
5755 {not in Vi}
5756 Quoting character(s), put around the command passed to the shell, for
5757 the "!" and ":!" commands. The redirection is kept outside of the
5758 quoting. See 'shellxquote' to include the redirection. It's
5759 probably not useful to set both options.
5760 This is an empty string by default. Only known to be useful for
5761 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5762 or bash, where it should be "\"". The default is adjusted according
5763 the value of 'shell', to reduce the need to set this option by the
5764 user. See |dos-shell|.
5765 This option cannot be set from a |modeline| or in the |sandbox|, for
5766 security reasons.
5767
5768 *'shellredir'* *'srr'*
5769'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5770 global
5771 {not in Vi}
5772 String to be used to put the output of a filter command in a temporary
5773 file. See also |:!|. See |option-backslash| about including spaces
5774 and backslashes.
5775 The name of the temporary file can be represented by "%s" if necessary
5776 (the file name is appended automatically if no %s appears in the value
5777 of this option).
5778 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5779 or "zsh" during initializations, the default becomes ">&". If the
5780 'shell' option is "sh", "ksh" or "bash" the default becomes
5781 ">%s 2>&1". This means that stderr is also included.
5782 For Win32, the Unix checks are done and additionally "cmd" is checked
5783 for, which makes the default ">%s 2>&1". Also, the same names with
5784 ".exe" appended are checked for.
5785 The initialization of this option is done after reading the ".vimrc"
5786 and the other initializations, so that when the 'shell' option is set
5787 there, the 'shellredir' option changes automatically unless it was
5788 explicitly set before.
5789 In the future pipes may be used for filtering and this option will
5790 become obsolete (at least for Unix).
5791 This option cannot be set from a |modeline| or in the |sandbox|, for
5792 security reasons.
5793
5794 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5795'shellslash' 'ssl' boolean (default off)
5796 global
5797 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5798 When set, a forward slash is used when expanding file names. This is
5799 useful when a Unix-like shell is used instead of command.com or
5800 cmd.exe. Backward slashes can still be typed, but they are changed to
5801 forward slashes by Vim.
5802 Note that setting or resetting this option has no effect for some
5803 existing file names, thus this option needs to be set before opening
5804 any file for best results. This might change in the future.
5805 'shellslash' only works when a backslash can be used as a path
5806 separator. To test if this is so use: >
5807 if exists('+shellslash')
5808<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005809 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5810'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5811 global
5812 {not in Vi}
5813 When on, use temp files for shell commands. When off use a pipe.
5814 When using a pipe is not possible temp files are used anyway.
5815 Currently a pipe is only supported on Unix. You can check it with: >
5816 :if has("filterpipe")
5817< The advantage of using a pipe is that nobody can read the temp file
5818 and the 'shell' command does not need to support redirection.
5819 The advantage of using a temp file is that the file type and encoding
5820 can be detected.
5821 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5822 |FilterWritePost| autocommands event are not triggered when
5823 'shelltemp' is off.
5824
Bram Moolenaar071d4272004-06-13 20:20:40 +00005825 *'shelltype'* *'st'*
5826'shelltype' 'st' number (default 0)
5827 global
5828 {not in Vi} {only for the Amiga}
5829 On the Amiga this option influences the way how the commands work
5830 which use a shell.
5831 0 and 1: always use the shell
5832 2 and 3: use the shell only to filter lines
5833 4 and 5: use shell only for ':sh' command
5834 When not using the shell, the command is executed directly.
5835
5836 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5837 1 and 3: use "shell cmd" to start external commands
5838
5839 *'shellxquote'* *'sxq'*
5840'shellxquote' 'sxq' string (default: "";
5841 for Win32, when 'shell' contains "sh"
5842 somewhere: "\""
5843 for Unix, when using system(): "\"")
5844 global
5845 {not in Vi}
5846 Quoting character(s), put around the command passed to the shell, for
5847 the "!" and ":!" commands. Includes the redirection. See
5848 'shellquote' to exclude the redirection. It's probably not useful
5849 to set both options.
5850 This is an empty string by default. Known to be useful for
5851 third-party shells when using the Win32 version, such as the MKS Korn
5852 Shell or bash, where it should be "\"". The default is adjusted
5853 according the value of 'shell', to reduce the need to set this option
5854 by the user. See |dos-shell|.
5855 This option cannot be set from a |modeline| or in the |sandbox|, for
5856 security reasons.
5857
5858 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
5859'shiftround' 'sr' boolean (default off)
5860 global
5861 {not in Vi}
5862 Round indent to multiple of 'shiftwidth'. Applies to > and <
5863 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
5864 a multiple of 'shiftwidth' (this is Vi compatible).
5865 NOTE: This option is reset when 'compatible' is set.
5866
5867 *'shiftwidth'* *'sw'*
5868'shiftwidth' 'sw' number (default 8)
5869 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005870 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 |'cindent'|, |>>|, |<<|, etc.
5872
5873 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005874'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
5875 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005876 global
5877 {not in Vi}
5878 This option helps to avoid all the |hit-enter| prompts caused by file
5879 messages, for example with CTRL-G, and to avoid some other messages.
5880 It is a list of flags:
5881 flag meaning when present ~
5882 f use "(3 of 5)" instead of "(file 3 of 5)"
5883 i use "[noeol]" instead of "[Incomplete last line]"
5884 l use "999L, 888C" instead of "999 lines, 888 characters"
5885 m use "[+]" instead of "[Modified]"
5886 n use "[New]" instead of "[New File]"
5887 r use "[RO]" instead of "[readonly]"
5888 w use "[w]" instead of "written" for file write message
5889 and "[a]" instead of "appended" for ':w >> file' command
5890 x use "[dos]" instead of "[dos format]", "[unix]" instead of
5891 "[unix format]" and "[mac]" instead of "[mac format]".
5892 a all of the above abbreviations
5893
5894 o overwrite message for writing a file with subsequent message
5895 for reading a file (useful for ":wn" or when 'autowrite' on)
5896 O message for reading a file overwrites any previous message.
5897 Also for quickfix message (e.g., ":cn").
5898 s don't give "search hit BOTTOM, continuing at TOP" or "search
5899 hit TOP, continuing at BOTTOM" messages
5900 t truncate file message at the start if it is too long to fit
5901 on the command-line, "<" will appear in the left most column.
5902 Ignored in Ex mode.
5903 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00005904 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905 Ignored in Ex mode.
5906 W don't give "written" or "[w]" when writing a file
5907 A don't give the "ATTENTION" message when an existing swap file
5908 is found.
5909 I don't give the intro message when starting Vim |:intro|.
5910
5911 This gives you the opportunity to avoid that a change between buffers
5912 requires you to hit <Enter>, but still gives as useful a message as
5913 possible for the space available. To get the whole message that you
5914 would have got with 'shm' empty, use ":file!"
5915 Useful values:
5916 shm= No abbreviation of message.
5917 shm=a Abbreviation, but no loss of information.
5918 shm=at Abbreviation, and truncate message when necessary.
5919
5920 NOTE: This option is set to the Vi default value when 'compatible' is
5921 set and to the Vim default value when 'compatible' is reset.
5922
5923 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
5924'shortname' 'sn' boolean (default off)
5925 local to buffer
5926 {not in Vi, not in MS-DOS versions}
5927 Filenames are assumed to be 8 characters plus one extension of 3
5928 characters. Multiple dots in file names are not allowed. When this
5929 option is on, dots in file names are replaced with underscores when
5930 adding an extension (".~" or ".swp"). This option is not available
5931 for MS-DOS, because then it would always be on. This option is useful
5932 when editing files on an MS-DOS compatible filesystem, e.g., messydos
5933 or crossdos. When running the Win32 GUI version under Win32s, this
5934 option is always on by default.
5935
5936 *'showbreak'* *'sbr'* *E595*
5937'showbreak' 'sbr' string (default "")
5938 global
5939 {not in Vi}
5940 {not available when compiled without the |+linebreak|
5941 feature}
5942 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005943 values are "> " or "+++ ": >
5944 :set showbreak=>\
5945< Note the backslash to escape the trailing space. It's easier like
5946 this: >
5947 :let &showbreak = '+++ '
5948< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00005949 comma (in a future version the comma might be used to separate the
5950 part that is shown at the end and at the start of a line).
5951 The characters are highlighted according to the '@' flag in
5952 'highlight'.
5953 Note that tabs after the showbreak will be displayed differently.
5954 If you want the 'showbreak' to appear in between line numbers, add the
5955 "n" flag to 'cpoptions'.
5956
5957 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
5958'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
5959 off)
5960 global
5961 {not in Vi}
5962 {not available when compiled without the
5963 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00005964 Show (partial) command in the last line of the screen. Set this
5965 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005966 In Visual mode the size of the selected area is shown:
5967 - When selecting characters within a line, the number of characters.
5968 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005969 - When selecting a block, the size in screen characters:
5970 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 NOTE: This option is set to the Vi default value when 'compatible' is
5972 set and to the Vim default value when 'compatible' is reset.
5973
5974 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
5975'showfulltag' 'sft' boolean (default off)
5976 global
5977 {not in Vi}
5978 When completing a word in insert mode (see |ins-completion|) from the
5979 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005980 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00005981 matched a C function, you can see a template for what arguments are
5982 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00005983 Note that this doesn't work well together with having "longest" in
5984 'completeopt', because the completion from the search pattern may not
5985 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005986
5987 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
5988'showmatch' 'sm' boolean (default off)
5989 global
5990 When a bracket is inserted, briefly jump to the matching one. The
5991 jump is only done if the match can be seen on the screen. The time to
5992 show the match can be set with 'matchtime'.
5993 A Beep is given if there is no match (no matter if the match can be
5994 seen or not). This option is reset when the 'paste' option is set.
5995 When the 'm' flag is not included in 'cpoptions', typing a character
5996 will immediately move the cursor back to where it belongs.
5997 See the "sm" field in 'guicursor' for setting the cursor shape and
5998 blinking when showing the match.
5999 The 'matchpairs' option can be used to specify the characters to show
6000 matches for. 'rightleft' and 'revins' are used to look for opposite
6001 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006002 Also see the matchparen plugin for highlighting the match when moving
6003 around |pi_paren.txt|.
6004 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006005
6006 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6007'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6008 global
6009 If in Insert, Replace or Visual mode put a message on the last line.
6010 Use the 'M' flag in 'highlight' to set the type of highlighting for
6011 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006012 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006013 doesn't mean XIM is really active, especially when 'imactivatekey' is
6014 not set.
6015 NOTE: This option is set to the Vi default value when 'compatible' is
6016 set and to the Vim default value when 'compatible' is reset.
6017
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006018 *'showtabline'* *'stal'*
6019'showtabline' 'stal' number (default 1)
6020 global
6021 {not in Vi}
6022 {not available when compiled without the +windows
6023 feature}
6024 The value of this option specifies when the line with tab page labels
6025 will be displayed:
6026 0: never
6027 1: only if there are at least two tab pages
6028 2: always
6029 This is both for the GUI and non-GUI implementation of the tab pages
6030 line.
6031 See |tab-page| for more information about tab pages.
6032
Bram Moolenaar071d4272004-06-13 20:20:40 +00006033 *'sidescroll'* *'ss'*
6034'sidescroll' 'ss' number (default 0)
6035 global
6036 {not in Vi}
6037 The minimal number of columns to scroll horizontally. Used only when
6038 the 'wrap' option is off and the cursor is moved off of the screen.
6039 When it is zero the cursor will be put in the middle of the screen.
6040 When using a slow terminal set it to a large number or 0. When using
6041 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6042 commands.
6043
6044 *'sidescrolloff'* *'siso'*
6045'sidescrolloff' 'siso' number (default 0)
6046 global
6047 {not in Vi}
6048 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006049 right of the cursor if 'nowrap' is set. Setting this option to a
6050 value greater than 0 while having |'sidescroll'| also at a non-zero
6051 value makes some context visible in the line you are scrolling in
6052 horizontally (except at beginning of the line). Setting this option
6053 to a large value (like 999) has the effect of keeping the cursor
6054 horizontally centered in the window, as long as one does not come too
6055 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006056 NOTE: This option is set to 0 when 'compatible' is set.
6057
6058 Example: Try this together with 'sidescroll' and 'listchars' as
6059 in the following example to never allow the cursor to move
6060 onto the "extends" character:
6061
6062 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6063 :set sidescrolloff=1
6064
6065
6066 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6067'smartcase' 'scs' boolean (default off)
6068 global
6069 {not in Vi}
6070 Override the 'ignorecase' option if the search pattern contains upper
6071 case characters. Only used when the search pattern is typed and
6072 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006073 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6075 recalling the search pattern from history and hitting <Enter>.
6076 NOTE: This option is reset when 'compatible' is set.
6077
6078 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6079'smartindent' 'si' boolean (default off)
6080 local to buffer
6081 {not in Vi}
6082 {not available when compiled without the
6083 |+smartindent| feature}
6084 Do smart autoindenting when starting a new line. Works for C-like
6085 programs, but can also be used for other languages. 'cindent' does
6086 something like this, works better in most cases, but is more strict,
6087 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6088 'indentexpr' is a more advanced alternative.
6089 Normally 'autoindent' should also be on when using 'smartindent'.
6090 An indent is automatically inserted:
6091 - After a line ending in '{'.
6092 - After a line starting with a keyword from 'cinwords'.
6093 - Before a line starting with '}' (only with the "O" command).
6094 When typing '}' as the first character in a new line, that line is
6095 given the same indent as the matching '{'.
6096 When typing '#' as the first character in a new line, the indent for
6097 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006098 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6100 When using the ">>" command, lines starting with '#' are not shifted
6101 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006102 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 is set smart indenting is disabled.
6104
6105 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6106'smarttab' 'sta' boolean (default off)
6107 global
6108 {not in Vi}
6109 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006110 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6111 <BS> will delete a 'shiftwidth' worth of space at the start of the
6112 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006113 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006114 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6115 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006116 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006118 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 NOTE: This option is reset when 'compatible' is set.
6120
6121 *'softtabstop'* *'sts'*
6122'softtabstop' 'sts' number (default 0)
6123 local to buffer
6124 {not in Vi}
6125 Number of spaces that a <Tab> counts for while performing editing
6126 operations, like inserting a <Tab> or using <BS>. It "feels" like
6127 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6128 used. This is useful to keep the 'ts' setting at its standard value
6129 of 8, while being able to edit like it is set to 'sts'. However,
6130 commands like "x" still work on the actual characters.
6131 When 'sts' is zero, this feature is off.
6132 'softtabstop' is set to 0 when the 'paste' option is set.
6133 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6134 spaces is minimized by using <Tab>s.
6135 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6136 set.
6137 NOTE: This option is set to 0 when 'compatible' is set.
6138
Bram Moolenaar217ad922005-03-20 22:37:15 +00006139 *'spell'* *'nospell'*
6140'spell' boolean (default off)
6141 local to window
6142 {not in Vi}
6143 {not available when compiled without the |+syntax|
6144 feature}
6145 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006146 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006147
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006148 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006149'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006150 local to buffer
6151 {not in Vi}
6152 {not available when compiled without the |+syntax|
6153 feature}
6154 Pattern to locate the end of a sentence. The following word will be
6155 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006156 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006157 When this check is not wanted make this option empty.
6158 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006159 Be careful with special characters, see |option-backslash| about
6160 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006161 To set this option automatically depending on the language, see
6162 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006163
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006164 *'spellfile'* *'spf'*
6165'spellfile' 'spf' string (default empty)
6166 local to buffer
6167 {not in Vi}
6168 {not available when compiled without the |+syntax|
6169 feature}
6170 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006171 commands. It must end in ".{encoding}.add". You need to include the
6172 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006173 *E765*
6174 It may also be a comma separated list of names. A count before the
6175 |zg| and |zw| commands can be used to access each. This allows using
6176 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006177 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006178 you: Using the first directory in 'runtimepath' that is writable. If
6179 there is no "spell" directory yet it will be created. For the file
6180 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006181 ignoring the region.
6182 The resulting ".spl" file will be used for spell checking, it does not
6183 have to appear in 'spelllang'.
6184 Normally one file is used for all regions, but you can add the region
6185 name if you want to. However, it will then only be used when
6186 'spellfile' is set to it, for entries in 'spelllang' only files
6187 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006188 This option cannot be set from a |modeline| or in the |sandbox|, for
6189 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006190
Bram Moolenaar217ad922005-03-20 22:37:15 +00006191 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006192'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006193 local to buffer
6194 {not in Vi}
6195 {not available when compiled without the |+syntax|
6196 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006197 A comma separated list of word list names. When the 'spell' option is
6198 on spellchecking will be done for these languages. Example: >
6199 set spelllang=en_us,nl,medical
6200< This means US English, Dutch and medical words are recognized. Words
6201 that are not recognized will be highlighted.
6202 The word list name must not include a comma or dot. Using a dash is
6203 recommended to separate the two letter language name from a
6204 specification. Thus "en-rare" is used for rare English words.
6205 A region name must come last and have the form "_xx", where "xx" is
6206 the two-letter, lower case region name. You can use more than one
6207 region by listing them: "en_us,en_ca" supports both US and Canadian
6208 English, but not words specific for Australia, New Zealand or Great
6209 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006210 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006211 As a special case the name of a .spl file can be given as-is. The
6212 first "_xx" in the name is removed and used as the region name
6213 (_xx is an underscore, two letters and followed by a non-letter).
6214 This is mainly for testing purposes. You must make sure the correct
6215 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006216 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006217 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6218 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006219 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006220
Bram Moolenaar98692072006-02-04 00:57:42 +00006221 If the |spellfile.vim| plugin is active and you use a language name
6222 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6223 will ask you if you want to download the file.
6224
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006225 After this option has been set successfully, Vim will source the files
6226 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006227 up to the first comma, dot or underscore.
6228 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006229
6230
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006231 *'spellsuggest'* *'sps'*
6232'spellsuggest' 'sps' string (default "best")
6233 global
6234 {not in Vi}
6235 {not available when compiled without the |+syntax|
6236 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006237 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006238 the |spellsuggest()| function. This is a comma-separated list of
6239 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006240
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006241 best Internal method that works best for English. Finds
6242 changes like "fast" and uses a bit of sound-a-like
6243 scoring to improve the ordering.
6244
6245 double Internal method that uses two methods and mixes the
6246 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006247 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006248 word. That only works when the language specifies
6249 sound folding. Can be slow and doesn't always give
6250 better results.
6251
6252 fast Internal method that only checks for simple changes:
6253 character inserts/deletes/swaps. Works well for
6254 simple typing mistakes.
6255
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006256 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006257 Not used for |spellsuggest()|. The number of
6258 suggestions is never more than the value of 'lines'
6259 minus two.
6260
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006261 file:{filename} Read file {filename}, which must have two columns,
6262 separated by a slash. The first column contains the
6263 bad word, the second column the suggested good word.
6264 Example:
6265 theribal/terrible ~
6266 Use this for common mistakes that do not appear at the
6267 top of the suggestion list with the internal methods.
6268 Lines without a slash are ignored, use this for
6269 comments.
6270 The file is used for all languages.
6271
6272 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6273 trouble with spaces. |v:val| holds the badly spelled
6274 word. The expression must evaluate to a List of
6275 Lists, each with a suggestion and a score.
6276 Example:
6277 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006278 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006279 internal methods use. A lower score is better.
6280 This may invoke |spellsuggest()| if you temporarily
6281 set 'spellsuggest' to exclude the "expr:" part.
6282 Errors are silently ignored, unless you set the
6283 'verbose' option to a non-zero value.
6284
6285 Only one of "best", "double" or "fast" may be used. The others may
6286 appear several times in any order. Example: >
6287 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6288<
6289 This option cannot be set from a |modeline| or in the |sandbox|, for
6290 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006291
6292
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6294'splitbelow' 'sb' boolean (default off)
6295 global
6296 {not in Vi}
6297 {not available when compiled without the +windows
6298 feature}
6299 When on, splitting a window will put the new window below the current
6300 one. |:split|
6301
6302 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6303'splitright' 'spr' boolean (default off)
6304 global
6305 {not in Vi}
6306 {not available when compiled without the +vertsplit
6307 feature}
6308 When on, splitting a window will put the new window right of the
6309 current one. |:vsplit|
6310
6311 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6312'startofline' 'sol' boolean (default on)
6313 global
6314 {not in Vi}
6315 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006316 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006317 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006318 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006319 with a linewise operator, with "%" with a count and to buffer changing
6320 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6321 only has a line number, e.g., ":25" or ":+".
6322 In case of buffer changing commands the cursor is placed at the column
6323 where it was the last time the buffer was edited.
6324 NOTE: This option is set when 'compatible' is set.
6325
6326 *'statusline'* *'stl'* *E540* *E541* *E542*
6327'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006328 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329 {not in Vi}
6330 {not available when compiled without the |+statusline|
6331 feature}
6332 When nonempty, this option determines the content of the status line.
6333 Also see |status-line|.
6334
6335 The option consists of printf style '%' items interspersed with
6336 normal text. Each status line item is of the form:
6337 %-0{minwid}.{maxwid}{item}
6338 All fields except the {item} is optional. A single percent sign can
6339 be given as "%%". Up to 80 items can be specified.
6340
Bram Moolenaar238a5642006-02-21 22:12:05 +00006341 When the option starts with "%!" then it is used as an expression,
6342 evaluated and the result is used as the option value. Example: >
6343 :set statusline=%!MyStatusLine()
6344< The result can contain %{} items that will be evaluated too.
6345
6346 When there is error while evaluating the option then it will be made
6347 empty to avoid further errors. Otherwise screen updating would loop.
6348
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 Note that the only effect of 'ruler' when this option is set (and
6350 'laststatus' is 2) is controlling the output of |CTRL-G|.
6351
6352 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006353 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006354 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006355 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006356 minwid Minimum width of the item, padding as set by '-' & '0'.
6357 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006358 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359 on the left for text items. Numeric items will be
6360 shifted down to maxwid-2 digits followed by '>'number
6361 where number is the amount of missing digits, much like
6362 an exponential notation.
6363 item A one letter code as described below.
6364
6365 Following is a description of the possible statusline items. The
6366 second character in "item" is the type:
6367 N for number
6368 S for string
6369 F for flags as described below
6370 - not applicable
6371
6372 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006373 f S Path to the file in the buffer, as typed or relative to current
6374 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006375 F S Full path to the file in the buffer.
6376 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006377 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006378 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006379 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006380 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006381 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006382 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006383 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006385 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6387 {not available when compiled without |+autocmd| feature}
6388 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6389 being used: "<keymap>"
6390 n N Buffer number.
6391 b N Value of byte under cursor.
6392 B N As above, in hexadecimal.
6393 o N Byte number in file of byte under cursor, first byte is 1.
6394 Mnemonic: Offset from start of file (with one added)
6395 {not available when compiled without |+byte_offset| feature}
6396 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006397 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006398 l N Line number.
6399 L N Number of lines in buffer.
6400 c N Column number.
6401 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006402 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 p N Percentage through file in lines as in |CTRL-G|.
6404 P S Percentage through file of displayed window. This is like the
6405 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006406 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006407 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006408 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006409 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006410 ( - Start of item group. Can be used for setting the width and
6411 alignment of a section. Must be followed by %) somewhere.
6412 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006413 T N For 'tabline': start of tab page N label. Use %T after the last
6414 label. This information is used for mouse clicks.
6415 X N For 'tabline': start of close tab N label. Use %X after the
6416 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6417 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 < - Where to truncate line if too long. Default is at the start.
6419 No width fields allowed.
6420 = - Separation point between left and right aligned items.
6421 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006422 # - Set highlight group. The name must follow and then a # again.
6423 Thus use %#HLname# for highlight group HLname. The same
6424 highlighting is used, also for the statusline of non-current
6425 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006426 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006427 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 The difference between User{N} and StatusLine will be applied
6429 to StatusLineNC for the statusline of non-current windows.
6430 The number N must be between 1 and 9. See |hl-User1..9|
6431
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006432 When displaying a flag, Vim removes the leading comma, if any, when
6433 that flag comes right after plaintext. This will make a nice display
6434 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435
Bram Moolenaar582fd852005-03-28 20:58:01 +00006436 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 not set) and a minwid is not set for the group, the whole group will
6438 become empty. This will make a group like the following disappear
6439 completely from the statusline when none of the flags are set. >
6440 :set statusline=...%(\ [%M%R%H]%)...
6441<
6442 Beware that an expression is evaluated each and every time the status
6443 line is displayed. The current buffer and current window will be set
6444 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006445 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006447 real current buffer.
6448
6449 The 'statusline' option may be evaluated in the |sandbox|, see
6450 |sandbox-option|.
6451
6452 It is not allowed to change text or jump to another window while
6453 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454
6455 If the statusline is not updated when you want it (e.g., after setting
6456 a variable that's used in an expression), you can force an update by
6457 setting an option without changing its value. Example: >
6458 :let &ro = &ro
6459
6460< A result of all digits is regarded a number for display purposes.
6461 Otherwise the result is taken as flag text and applied to the rules
6462 described above.
6463
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006464 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6466 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6467
6468 Examples:
6469 Emulate standard status line with 'ruler' set >
6470 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6471< Similar, but add ASCII value of char under the cursor (like "ga") >
6472 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6473< Display byte count and byte value, modified flag in red. >
6474 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6475 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6476< Display a ,GZ flag if a compressed file is loaded >
6477 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6478< In the |:autocmd|'s: >
6479 :let b:gzflag = 1
6480< And: >
6481 :unlet b:gzflag
6482< And define this function: >
6483 :function VarExists(var, val)
6484 : if exists(a:var) | return a:val | else | return '' | endif
6485 :endfunction
6486<
6487 *'suffixes'* *'su'*
6488'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6489 global
6490 {not in Vi}
6491 Files with these suffixes get a lower priority when multiple files
6492 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006493 suffixes. Spaces after the comma are ignored. A dot is also seen as
6494 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 separator, precede it with a backslash (see |option-backslash| about
6496 including spaces and backslashes).
6497 See 'wildignore' for completely ignoring files.
6498 The use of |:set+=| and |:set-=| is preferred when adding or removing
6499 suffixes from the list. This avoids problems when a future version
6500 uses another default.
6501
6502 *'suffixesadd'* *'sua'*
6503'suffixesadd' 'sua' string (default "")
6504 local to buffer
6505 {not in Vi}
6506 {not available when compiled without the
6507 |+file_in_path| feature}
6508 Comma separated list of suffixes, which are used when searching for a
6509 file for the "gf", "[I", etc. commands. Example: >
6510 :set suffixesadd=.java
6511<
6512 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6513'swapfile' 'swf' boolean (default on)
6514 local to buffer
6515 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006516 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 swapfile is not wanted for a specific buffer. For example, with
6518 confidential information that even root must not be able to access.
6519 Careful: All text will be in memory:
6520 - Don't use this for big files.
6521 - Recovery will be impossible!
6522 A swapfile will only be present when |'updatecount'| is non-zero and
6523 'swapfile' is set.
6524 When 'swapfile' is reset, the swap file for the current buffer is
6525 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6526 non-zero, a swap file is immediately created.
6527 Also see |swap-file| and |'swapsync'|.
6528
6529 This option is used together with 'bufhidden' and 'buftype' to
6530 specify special kinds of buffers. See |special-buffers|.
6531
6532 *'swapsync'* *'sws'*
6533'swapsync' 'sws' string (default "fsync")
6534 global
6535 {not in Vi}
6536 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006537 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 When this option is empty parts of the swap file may be in memory and
6539 not written to disk. When the system crashes you may lose more work.
6540 On Unix the system does a sync now and then without Vim asking for it,
6541 so the disadvantage of setting this option off is small. On some
6542 systems the swap file will not be written at all. For a unix system
6543 setting it to "sync" will use the sync() call instead of the default
6544 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006545 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546
6547 *'switchbuf'* *'swb'*
6548'switchbuf' 'swb' string (default "")
6549 global
6550 {not in Vi}
6551 This option controls the behavior when switching between buffers.
6552 Possible values (comma separated list):
6553 useopen If included, jump to the first open window that
6554 contains the specified buffer (if there is one).
6555 Otherwise: Do not examine other windows.
6556 This setting is checked with |quickfix| commands, when
6557 jumping to errors (":cc", ":cn", "cp", etc.). It is
6558 also used in all buffer related split commands, for
6559 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006560 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006561 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006562 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006563 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006564 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006565 newtab Like "split", but open a new tab page. Overrules
6566 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006568 *'synmaxcol'* *'smc'*
6569'synmaxcol' 'smc' number (default 3000)
6570 local to buffer
6571 {not in Vi}
6572 {not available when compiled without the |+syntax|
6573 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006574 Maximum column in which to search for syntax items. In long lines the
6575 text after this column is not highlighted and following lines may not
6576 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006577 This helps to avoid very slow redrawing for an XML file that is one
6578 long line.
6579 Set to zero to remove the limit.
6580
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 *'syntax'* *'syn'*
6582'syntax' 'syn' string (default empty)
6583 local to buffer
6584 {not in Vi}
6585 {not available when compiled without the |+syntax|
6586 feature}
6587 When this option is set, the syntax with this name is loaded, unless
6588 syntax highlighting has been switched off with ":syntax off".
6589 Otherwise this option does not always reflect the current syntax (the
6590 b:current_syntax variable does).
6591 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006592 not automatically recognized. Example, in an IDL file:
6593 /* vim: set syntax=idl : */ ~
6594 When a dot appears in the value then this separates two filetype
6595 names. Example:
6596 /* vim: set syntax=c.doxygen : */ ~
6597 This will use the "c" syntax first, then the "doxygen" syntax.
6598 Note that the second one must be prepared to be loaded as an addition,
6599 otherwise it will be skipped. More than one dot may appear.
6600 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 :set syntax=OFF
6602< To switch syntax highlighting on according to the current value of the
6603 'filetype' option: >
6604 :set syntax=ON
6605< What actually happens when setting the 'syntax' option is that the
6606 Syntax autocommand event is triggered with the value as argument.
6607 This option is not copied to another buffer, independent of the 's' or
6608 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006609 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006610
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006611 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006612'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006613 global
6614 {not in Vi}
6615 {not available when compiled without the +windows
6616 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006617 When nonempty, this option determines the content of the tab pages
6618 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006619 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006620
6621 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006622 option and only when there is no GUI tab line. When 'e' is in
6623 'guioptions' and the GUI supports a tab line 'guitablabel' is used
6624 instead.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006625
6626 The value is evaluated like with 'statusline'. You can use
6627 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006628 the text to be displayed. Use "%1T" for the first label, "%2T" for
6629 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006630
6631 Keep in mind that only one of the tab pages is the current one, others
6632 are invisible and you can't jump to their windows.
6633
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006634
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006635 *'tabpagemax'* *'tpm'*
6636'tabpagemax' 'tpm' number (default 10)
6637 global
6638 {not in Vi}
6639 {not available when compiled without the +windows
6640 feature}
6641 Maximum number of tab pages to be opened by the |-p| command line
6642 argument or the ":tab all" command. |tabpage|
6643
6644
6645 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006646'tabstop' 'ts' number (default 8)
6647 local to buffer
6648 Number of spaces that a <Tab> in the file counts for. Also see
6649 |:retab| command, and 'softtabstop' option.
6650
6651 Note: Setting 'tabstop' to any other value than 8 can make your file
6652 appear wrong in many places (e.g., when printing it).
6653
6654 There are four main ways to use tabs in Vim:
6655 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6656 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006657 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 behave like a tab appears every 4 (or 3) characters.
6659 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6660 'expandtab'. This way you will always insert spaces. The
6661 formatting will never be messed up when 'tabstop' is changed.
6662 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006663 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 works when using Vim to edit the file.
6665 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6666 'noexpandtab'. This should then work (for initial indents only)
6667 for any tabstop setting that people use. It might be nice to have
6668 tabs after the first non-blank inserted as spaces if you do this
6669 though. Otherwise aligned comments will be wrong when 'tabstop' is
6670 changed.
6671
6672 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6673'tagbsearch' 'tbs' boolean (default on)
6674 global
6675 {not in Vi}
6676 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006677 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006678 searching makes searching for a tag a LOT faster, but a linear search
6679 will find more tags if the tags file wasn't properly sorted.
6680 Vim normally assumes that your tags files are sorted, or indicate that
6681 they are not sorted. Only when this is not the case does the
6682 'tagbsearch' option need to be switched off.
6683
6684 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006685 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686 certain files, or retry all files with a linear search. When
6687 'tagbsearch' is off, only a linear search is done.
6688
6689 Linear searching is done anyway, for one file, when Vim finds a line
6690 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006691 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692< [The whitespace before and after the '0' must be a single <Tab>]
6693
6694 When a binary search was done and no match was found in any of the
6695 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6696 instead of a normal tag name, a retry is done with a linear search.
6697 Tags in unsorted tags files, and matches with different case will only
6698 be found in the retry.
6699
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006700 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 linear search can be avoided for the 'ignorecase' case. Use a value
6702 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6703 case-fold sorted with the -f switch to "sort" in most unices, as in
6704 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006705 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6706 for this as well. Note that case must be folded to uppercase for this
6707 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006708
6709 When 'tagbsearch' is off, tags searching is slower when a full match
6710 exists, but faster when no full match exists. Tags in unsorted tags
6711 files may only be found with 'tagbsearch' off.
6712 When the tags file is not sorted, or sorted in a wrong way (not on
6713 ASCII byte value), 'tagbsearch' should be off, or the line given above
6714 must be included in the tags file.
6715 This option doesn't affect commands that find all matching tags (e.g.,
6716 command-line completion and ":help").
6717 {Vi: always uses binary search in some versions}
6718
6719 *'taglength'* *'tl'*
6720'taglength' 'tl' number (default 0)
6721 global
6722 If non-zero, tags are significant up to this number of characters.
6723
6724 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6725'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6726 global
6727 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006728 If on and using a tags file in another directory, file names in that
6729 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730 NOTE: This option is set to the Vi default value when 'compatible' is
6731 set and to the Vim default value when 'compatible' is reset.
6732
6733 *'tags'* *'tag'* *E433*
6734'tags' 'tag' string (default "./tags,tags", when compiled with
6735 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6736 global or local to buffer |global-local|
6737 Filenames for the tag command, separated by spaces or commas. To
6738 include a space or comma in a file name, precede it with a backslash
6739 (see |option-backslash| about including spaces and backslashes).
6740 When a file name starts with "./", the '.' is replaced with the path
6741 of the current file. But only when the 'd' flag is not included in
6742 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6743 |tags-option|.
6744 "*", "**" and other wildcards can be used to search for tags files in
6745 a directory tree. See |file-searching|. {not available when compiled
6746 without the |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006747 The |tagfiles()| function can be used to get a list of the file names
6748 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6750 files are also supported. They are automatically recognized. The
6751 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6752 differences are ignored (MS-Windows). |emacs-tags|
6753 The use of |:set+=| and |:set-=| is preferred when adding or removing
6754 file names from the list. This avoids problems when a future version
6755 uses another default.
6756 {Vi: default is "tags /usr/lib/tags"}
6757
6758 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6759'tagstack' 'tgst' boolean (default on)
6760 global
6761 {not in all versions of Vi}
6762 When on, the |tagstack| is used normally. When off, a ":tag" or
6763 ":tselect" command with an argument will not push the tag onto the
6764 tagstack. A following ":tag" without an argument, a ":pop" command or
6765 any other command that uses the tagstack will use the unmodified
6766 tagstack, but does change the pointer to the active entry.
6767 Resetting this option is useful when using a ":tag" command in a
6768 mapping which should not change the tagstack.
6769
6770 *'term'* *E529* *E530* *E531*
6771'term' string (default is $TERM, if that fails:
6772 in the GUI: "builtin_gui"
6773 on Amiga: "amiga"
6774 on BeOS: "beos-ansi"
6775 on Mac: "mac-ansi"
6776 on MiNT: "vt52"
6777 on MS-DOS: "pcterm"
6778 on OS/2: "os2ansi"
6779 on Unix: "ansi"
6780 on VMS: "ansi"
6781 on Win 32: "win32")
6782 global
6783 Name of the terminal. Used for choosing the terminal control
6784 characters. Environment variables are expanded |:set_env|.
6785 For example: >
6786 :set term=$TERM
6787< See |termcap|.
6788
6789 *'termbidi'* *'tbidi'*
6790 *'notermbidi'* *'notbidi'*
6791'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6792 global
6793 {not in Vi}
6794 {only available when compiled with the |+arabic|
6795 feature}
6796 The terminal is in charge of Bi-directionality of text (as specified
6797 by Unicode). The terminal is also expected to do the required shaping
6798 that some languages (such as Arabic) require.
6799 Setting this option implies that 'rightleft' will not be set when
6800 'arabic' is set and the value of 'arabicshape' will be ignored.
6801 Note that setting 'termbidi' has the immediate effect that
6802 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6803 This option is reset when the GUI is started.
6804 For further details see |arabic.txt|.
6805
6806 *'termencoding'* *'tenc'*
6807'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6808 Macintosh GUI: "macroman")
6809 global
6810 {only available when compiled with the |+multi_byte|
6811 feature}
6812 {not in Vi}
6813 Encoding used for the terminal. This specifies what character
6814 encoding the keyboard produces and the display will understand. For
6815 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006816 display). Except for the Mac when 'macatsui' is off, then
6817 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 In the Win32 console version the default value is the console codepage
6819 when it differs from the ANSI codepage.
6820 *E617*
6821 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6822 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6823 Any attempts to set a different value will be rejected, and an error
6824 message is shown.
6825 For the Win32 GUI 'termencoding' is not used for typed characters,
6826 because the Win32 system always passes Unicode characters.
6827 When empty, the same encoding is used as for the 'encoding' option.
6828 This is the normal value.
6829 Not all combinations for 'termencoding' and 'encoding' are valid. See
6830 |encoding-table|.
6831 The value for this option must be supported by internal conversions or
6832 iconv(). When this is not possible no conversion will be done and you
6833 will probably experience problems with non-ASCII characters.
6834 Example: You are working with the locale set to euc-jp (Japanese) and
6835 want to edit a UTF-8 file: >
6836 :let &termencoding = &encoding
6837 :set encoding=utf-8
6838< You need to do this when your system has no locale support for UTF-8.
6839
6840 *'terse'* *'noterse'*
6841'terse' boolean (default off)
6842 global
6843 When set: Add 's' flag to 'shortmess' option (this makes the message
6844 for a search that hits the start or end of the file not being
6845 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6846 shortens a lot of messages}
6847
6848 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6849'textauto' 'ta' boolean (Vim default: on, Vi default: off)
6850 global
6851 {not in Vi}
6852 This option is obsolete. Use 'fileformats'.
6853 For backwards compatibility, when 'textauto' is set, 'fileformats' is
6854 set to the default value for the current system. When 'textauto' is
6855 reset, 'fileformats' is made empty.
6856 NOTE: This option is set to the Vi default value when 'compatible' is
6857 set and to the Vim default value when 'compatible' is reset.
6858
6859 *'textmode'* *'tx'* *'notextmode'* *'notx'*
6860'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
6861 others: default off)
6862 local to buffer
6863 {not in Vi}
6864 This option is obsolete. Use 'fileformat'.
6865 For backwards compatibility, when 'textmode' is set, 'fileformat' is
6866 set to "dos". When 'textmode' is reset, 'fileformat' is set to
6867 "unix".
6868
6869 *'textwidth'* *'tw'*
6870'textwidth' 'tw' number (default 0)
6871 local to buffer
6872 {not in Vi}
6873 Maximum width of text that is being inserted. A longer line will be
6874 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006875 this. 'textwidth' is set to 0 when the 'paste' option is set. When
6876 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00006878 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 NOTE: This option is set to 0 when 'compatible' is set.
6880
6881 *'thesaurus'* *'tsr'*
6882'thesaurus' 'tsr' string (default "")
6883 global or local to buffer |global-local|
6884 {not in Vi}
6885 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006886 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 the file should contain words with similar meaning, separated by
6888 non-keyword characters (white space is preferred). Maximum line
6889 length is 510 bytes.
6890 To obtain a file to be used here, check out the wordlist FAQ at
6891 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006892 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 after a comma are ignored, otherwise spaces are included in the file
6894 name. See |option-backslash| about using backslashes.
6895 The use of |:set+=| and |:set-=| is preferred when adding or removing
6896 directories from the list. This avoids problems when a future version
6897 uses another default.
6898 Backticks cannot be used in this option for security reasons.
6899
6900 *'tildeop'* *'top'* *'notildeop'* *'notop'*
6901'tildeop' 'top' boolean (default off)
6902 global
6903 {not in Vi}
6904 When on: The tilde command "~" behaves like an operator.
6905 NOTE: This option is reset when 'compatible' is set.
6906
6907 *'timeout'* *'to'* *'notimeout'* *'noto'*
6908'timeout' 'to' boolean (default on)
6909 global
6910 *'ttimeout'* *'nottimeout'*
6911'ttimeout' boolean (default off)
6912 global
6913 {not in Vi}
6914 These two options together determine the behavior when part of a
6915 mapped key sequence or keyboard code has been received:
6916
6917 'timeout' 'ttimeout' action ~
6918 off off do not time out
6919 on on or off time out on :mappings and key codes
6920 off on time out on key codes
6921
6922 If both options are off, Vim will wait until either the complete
6923 mapping or key sequence has been received, or it is clear that there
6924 is no mapping or key sequence for the received characters. For
6925 example: if you have mapped "vl" and Vim has received 'v', the next
6926 character is needed to see if the 'v' is followed by an 'l'.
6927 When one of the options is on, Vim will wait for about 1 second for
6928 the next character to arrive. After that the already received
6929 characters are interpreted as single characters. The waiting time can
6930 be changed with the 'timeoutlen' option.
6931 On slow terminals or very busy systems timing out may cause
6932 malfunctioning cursor keys. If both options are off, Vim waits
6933 forever after an entered <Esc> if there are key codes that start
6934 with <Esc>. You will have to type <Esc> twice. If you do not have
6935 problems with key codes, but would like to have :mapped key
6936 sequences not timing out in 1 second, set the 'ttimeout' option and
6937 reset the 'timeout' option.
6938
6939 NOTE: 'ttimeout' is reset when 'compatible' is set.
6940
6941 *'timeoutlen'* *'tm'*
6942'timeoutlen' 'tm' number (default 1000)
6943 global
6944 {not in all versions of Vi}
6945 *'ttimeoutlen'* *'ttm'*
6946'ttimeoutlen' 'ttm' number (default -1)
6947 global
6948 {not in Vi}
6949 The time in milliseconds that is waited for a key code or mapped key
6950 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
6951 when part of a command has been typed.
6952 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
6953 different timeout value for key codes is desired set 'ttimeoutlen' to
6954 a non-negative number.
6955
6956 ttimeoutlen mapping delay key code delay ~
6957 < 0 'timeoutlen' 'timeoutlen'
6958 >= 0 'timeoutlen' 'ttimeoutlen'
6959
6960 The timeout only happens when the 'timeout' and 'ttimeout' options
6961 tell so. A useful setting would be >
6962 :set timeout timeoutlen=3000 ttimeoutlen=100
6963< (time out on mapping after three seconds, time out on key codes after
6964 a tenth of a second).
6965
6966 *'title'* *'notitle'*
6967'title' boolean (default off, on when title can be restored)
6968 global
6969 {not in Vi}
6970 {not available when compiled without the |+title|
6971 feature}
6972 When on, the title of the window will be set to the value of
6973 'titlestring' (if it is not empty), or to:
6974 filename [+=-] (path) - VIM
6975 Where:
6976 filename the name of the file being edited
6977 - indicates the file cannot be modified, 'ma' off
6978 + indicates the file was modified
6979 = indicates the file is read-only
6980 =+ indicates the file is read-only and modified
6981 (path) is the path of the file being edited
6982 - VIM the server name |v:servername| or "VIM"
6983 Only works if the terminal supports setting window titles
6984 (currently Amiga console, Win32 console, all GUI versions and
6985 terminals with a non- empty 't_ts' option - these are Unix xterm and
6986 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
6987 *X11*
6988 When Vim was compiled with HAVE_X11 defined, the original title will
6989 be restored if possible. The output of ":version" will include "+X11"
6990 when HAVE_X11 was defined, otherwise it will be "-X11". This also
6991 works for the icon name |'icon'|.
6992 But: When Vim was started with the |-X| argument, restoring the title
6993 will not work (except in the GUI).
6994 If the title cannot be restored, it is set to the value of 'titleold'.
6995 You might want to restore the title outside of Vim then.
6996 When using an xterm from a remote machine you can use this command:
6997 rsh machine_name xterm -display $DISPLAY &
6998 then the WINDOWID environment variable should be inherited and the
6999 title of the window should change back to what it should be after
7000 exiting Vim.
7001
7002 *'titlelen'*
7003'titlelen' number (default 85)
7004 global
7005 {not in Vi}
7006 {not available when compiled without the |+title|
7007 feature}
7008 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007009 title. When the title is longer, only the end of the path name is
7010 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007011 Using a percentage makes this adapt to the width of the window. But
7012 it won't work perfectly, because the actual number of characters
7013 available also depends on the font used and other things in the title
7014 bar. When 'titlelen' is zero the full path is used. Otherwise,
7015 values from 1 to 30000 percent can be used.
7016 'titlelen' is also used for the 'titlestring' option.
7017
7018 *'titleold'*
7019'titleold' string (default "Thanks for flying Vim")
7020 global
7021 {not in Vi}
7022 {only available when compiled with the |+title|
7023 feature}
7024 This option will be used for the window title when exiting Vim if the
7025 original title cannot be restored. Only happens if 'title' is on or
7026 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007027 This option cannot be set from a |modeline| or in the |sandbox|, for
7028 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 *'titlestring'*
7030'titlestring' string (default "")
7031 global
7032 {not in Vi}
7033 {not available when compiled without the |+title|
7034 feature}
7035 When this option is not empty, it will be used for the title of the
7036 window. This happens only when the 'title' option is on.
7037 Only works if the terminal supports setting window titles (currently
7038 Amiga console, Win32 console, all GUI versions and terminals with a
7039 non-empty 't_ts' option).
7040 When Vim was compiled with HAVE_X11 defined, the original title will
7041 be restored if possible |X11|.
7042 When this option contains printf-style '%' items, they will be
7043 expanded according to the rules used for 'statusline'.
7044 Example: >
7045 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7046 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7047< The value of 'titlelen' is used to align items in the middle or right
7048 of the available space.
7049 Some people prefer to have the file name first: >
7050 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7051< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007052 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 separating space only when needed.
7054 NOTE: Use of special characters in 'titlestring' may cause the display
7055 to be garbled (e.g., when it contains a CR or NL character).
7056 {not available when compiled without the |+statusline| feature}
7057
7058 *'toolbar'* *'tb'*
7059'toolbar' 'tb' string (default "icons,tooltips")
7060 global
7061 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7062 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007063 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007064 possible values are:
7065 icons Toolbar buttons are shown with icons.
7066 text Toolbar buttons shown with text.
7067 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007068 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007069 tooltips Tooltips are active for toolbar buttons.
7070 Tooltips refer to the popup help text which appears after the mouse
7071 cursor is placed over a toolbar button for a brief moment.
7072
7073 If you want the toolbar to be shown with icons as well as text, do the
7074 following: >
7075 :set tb=icons,text
7076< Motif and Athena cannot display icons and text at the same time. They
7077 will show icons if both are requested.
7078
7079 If none of the strings specified in 'toolbar' are valid or if
7080 'toolbar' is empty, this option is ignored. If you want to disable
7081 the toolbar, you need to set the 'guioptions' option. For example: >
7082 :set guioptions-=T
7083< Also see |gui-toolbar|.
7084
7085 *'toolbariconsize'* *'tbis'*
7086'toolbariconsize' 'tbis' string (default "small")
7087 global
7088 {not in Vi}
7089 {only in the GTK+ 2 GUI}
7090 Controls the size of toolbar icons. The possible values are:
7091 tiny Use tiny toolbar icons.
7092 small Use small toolbar icons (default).
7093 medium Use medium-sized toolbar icons.
7094 large Use large toolbar icons.
7095 The exact dimensions in pixels of the various icon sizes depend on
7096 the current theme. Common dimensions are large=32x32, medium=24x24,
7097 small=20x20 and tiny=16x16.
7098
7099 If 'toolbariconsize' is empty, the global default size as determined
7100 by user preferences or the current theme is used.
7101
7102 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7103'ttybuiltin' 'tbi' boolean (default on)
7104 global
7105 {not in Vi}
7106 When on, the builtin termcaps are searched before the external ones.
7107 When off the builtin termcaps are searched after the external ones.
7108 When this option is changed, you should set the 'term' option next for
7109 the change to take effect, for example: >
7110 :set notbi term=$TERM
7111< See also |termcap|.
7112 Rationale: The default for this option is "on", because the builtin
7113 termcap entries are generally better (many systems contain faulty
7114 xterm entries...).
7115
7116 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7117'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7118 sun-cmd, screen, rxvt, dtterm or
7119 iris-ansi; also on when running Vim in
7120 a DOS console)
7121 global
7122 {not in Vi}
7123 Indicates a fast terminal connection. More characters will be sent to
7124 the screen for redrawing, instead of using insert/delete line
7125 commands. Improves smoothness of redrawing when there are multiple
7126 windows and the terminal does not support a scrolling region.
7127 Also enables the extra writing of characters at the end of each screen
7128 line for lines that wrap. This helps when using copy/paste with the
7129 mouse in an xterm and other terminals.
7130
7131 *'ttymouse'* *'ttym'*
7132'ttymouse' 'ttym' string (default depends on 'term')
7133 global
7134 {not in Vi}
7135 {only in Unix and VMS, doesn't work in the GUI; not
7136 available when compiled without |+mouse|}
7137 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007138 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007139 *xterm-mouse*
7140 xterm xterm-like mouse handling. The mouse generates
7141 "<Esc>[Mscr", where "scr" is three bytes:
7142 "s" = button state
7143 "c" = column plus 33
7144 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007145 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007146 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007147 xterm2 Works like "xterm", but with the xterm reporting the
7148 mouse position while the mouse is dragged. This works
7149 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007150 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 work. See below for how Vim detects this
7152 automatically.
7153 *netterm-mouse*
7154 netterm NetTerm mouse handling. The mouse generates
7155 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7156 for the row and column.
7157 *dec-mouse*
7158 dec DEC terminal mouse handling. The mouse generates a
7159 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007160 This is also available for an Xterm, if it was
7161 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 *jsbterm-mouse*
7163 jsbterm JSB term mouse handling.
7164 *pterm-mouse*
7165 pterm QNX pterm mouse handling.
7166
7167 The mouse handling must be enabled at compile time |+mouse_xterm|
7168 |+mouse_dec| |+mouse_netterm|.
7169 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7170 recognized, if enabled at compile time. DEC terminal mouse codes
7171 are recognized if enabled at compile time, and 'ttymouse' is not
7172 "xterm" (because the xterm and dec mouse codes conflict).
7173 This option is automatically set to "xterm", when the 'term' option is
7174 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7175 or "xterm2" already. The main use of this option is to set it to
7176 "xterm", when the terminal name doesn't start with "xterm", but it can
7177 handle xterm mouse codes.
7178 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007179 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 feature and if |t_RV| is set to the escape sequence to request the
7181 xterm version number. Otherwise "xterm2" must be set explicitly.
7182 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7183 t_RV to an empty string: >
7184 :set t_RV=
7185<
7186 *'ttyscroll'* *'tsl'*
7187'ttyscroll' 'tsl' number (default 999)
7188 global
7189 Maximum number of lines to scroll the screen. If there are more lines
7190 to scroll the window is redrawn. For terminals where scrolling is
7191 very slow and redrawing is not slow this can be set to a small number,
7192 e.g., 3, to speed up displaying.
7193
7194 *'ttytype'* *'tty'*
7195'ttytype' 'tty' string (default from $TERM)
7196 global
7197 Alias for 'term', see above.
7198
7199 *'undolevels'* *'ul'*
7200'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7201 Win32 and OS/2)
7202 global
7203 {not in Vi}
7204 Maximum number of changes that can be undone. Since undo information
7205 is kept in memory, higher numbers will cause more memory to be used
7206 (nevertheless, a single change can use an unlimited amount of memory).
7207 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7208 itself: >
7209 set ul=0
7210< But you can also get Vi compatibility by including the 'u' flag in
7211 'cpoptions', and still be able to use CTRL-R to repeat undo.
7212 Set to a negative number for no undo at all: >
7213 set ul=-1
7214< This helps when you run out of memory for a single change.
7215 Also see |undo-two-ways|.
7216
7217 *'updatecount'* *'uc'*
7218'updatecount' 'uc' number (default: 200)
7219 global
7220 {not in Vi}
7221 After typing this many characters the swap file will be written to
7222 disk. When zero, no swap file will be created at all (see chapter on
7223 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7224 Vim with the "-n" option, see |startup|. When editing in readonly
7225 mode this option will be initialized to 10000.
7226 The swapfile can be disabled per buffer with |'swapfile'|.
7227 When 'updatecount' is set from zero to non-zero, swap files are
7228 created for all buffers that have 'swapfile' set. When 'updatecount'
7229 is set to zero, existing swap files are not deleted.
7230 Also see |'swapsync'|.
7231 This option has no meaning in buffers where |'buftype'| is "nofile"
7232 or "nowrite".
7233
7234 *'updatetime'* *'ut'*
7235'updatetime' 'ut' number (default 4000)
7236 global
7237 {not in Vi}
7238 If this many milliseconds nothing is typed the swap file will be
7239 written to disk (see |crash-recovery|). Also used for the
7240 |CursorHold| autocommand event.
7241
7242 *'verbose'* *'vbs'*
7243'verbose' 'vbs' number (default 0)
7244 global
7245 {not in Vi, although some versions have a boolean
7246 verbose option}
7247 When bigger than zero, Vim will give messages about what it is doing.
7248 Currently, these messages are given:
7249 >= 1 When the viminfo file is read or written.
7250 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007251 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 >= 8 Files for which a group of autocommands is executed.
7253 >= 9 Every executed autocommand.
7254 >= 12 Every executed function.
7255 >= 13 When an exception is thrown, caught, finished, or discarded.
7256 >= 14 Anything pending in a ":finally" clause.
7257 >= 15 Every executed Ex command (truncated at 200 characters).
7258
7259 This option can also be set with the "-V" argument. See |-V|.
7260 This option is also set by the |:verbose| command.
7261
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007262 When the 'verbosefile' option is set then the verbose messages are not
7263 displayed.
7264
7265 *'verbosefile'* *'vfile'*
7266'verbosefile' 'vfile' string (default empty)
7267 global
7268 {not in Vi}
7269 When not empty all messages are written in a file with this name.
7270 When the file exists messages are appended.
7271 Writing to the file ends when Vim exits or when 'verbosefile' is made
7272 empty.
7273 Setting 'verbosefile' to a new value is like making it empty first.
7274 The difference with |:redir| is that verbose messages are not
7275 displayed when 'verbosefile' is set.
7276
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 *'viewdir'* *'vdir'*
7278'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7279 "$VIM/vimfiles/view",
7280 for Unix: "~/.vim/view",
7281 for Macintosh: "$VIM:vimfiles:view"
7282 for VMS: "sys$login:vimfiles/view"
7283 for RiscOS: "Choices:vimfiles/view")
7284 global
7285 {not in Vi}
7286 {not available when compiled without the +mksession
7287 feature}
7288 Name of the directory where to store files for |:mkview|.
7289 This option cannot be set from a |modeline| or in the |sandbox|, for
7290 security reasons.
7291
7292 *'viewoptions'* *'vop'*
7293'viewoptions' 'vop' string (default: "folds,options,cursor")
7294 global
7295 {not in Vi}
7296 {not available when compiled without the +mksession
7297 feature}
7298 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007299 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 word save and restore ~
7301 cursor cursor position in file and in window
7302 folds manually created folds, opened/closed folds and local
7303 fold options
7304 options options and mappings local to a window or buffer (not
7305 global values for local options)
7306 slash backslashes in file names replaced with forward
7307 slashes
7308 unix with Unix end-of-line format (single <NL>), even when
7309 on Windows or DOS
7310
7311 "slash" and "unix" are useful on Windows when sharing view files
7312 with Unix. The Unix version of Vim cannot source dos format scripts,
7313 but the Windows version of Vim can source unix format scripts.
7314
7315 *'viminfo'* *'vi'* *E526* *E527* *E528*
7316'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007317 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7318 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7319 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 global
7321 {not in Vi}
7322 {not available when compiled without the |+viminfo|
7323 feature}
7324 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007325 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 separated list of parameters, each consisting of a single character
7327 identifying the particular parameter, followed by a number or string
7328 which specifies the value of that parameter. If a particular
7329 character is left out, then the default value is used for that
7330 parameter. The following is a list of the identifying characters and
7331 the effect of their value.
7332 CHAR VALUE ~
7333 ! When included, save and restore global variables that start
7334 with an uppercase letter, and don't contain a lowercase
7335 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar12805862005-01-05 22:16:17 +00007336 and "_K_L_M" are not. Only String and Number types are
7337 stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007338 " Maximum number of lines saved for each register. Old name of
7339 the '<' item, with the disadvantage that you need to put a
7340 backslash before the ", otherwise it will be recognized as the
7341 start of a comment!
7342 % When included, save and restore the buffer list. If Vim is
7343 started with a file name argument, the buffer list is not
7344 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007345 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 without a file name and buffers for help files are not written
7347 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007348 When followed by a number, the number specifies the maximum
7349 number of buffers that are stored. Without a number all
7350 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 ' Maximum number of previously edited files for which the marks
7352 are remembered. This parameter must always be included when
7353 'viminfo' is non-empty.
7354 Including this item also means that the |jumplist| and the
7355 |changelist| are stored in the viminfo file.
7356 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007357 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007358 patterns are also saved. When not included, the value of
7359 'history' is used.
7360 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007361 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007362 < Maximum number of lines saved for each register. If zero then
7363 registers are not saved. When not included, all lines are
7364 saved. '"' is the old name for this item.
7365 Also see the 's' item below: limit specified in Kbyte.
7366 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007367 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368 c When included, convert the text in the viminfo file from the
7369 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007370 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007371 f Whether file marks need to be stored. If zero, file marks ('0
7372 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007373 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007374 cursor position (when exiting or when doing ":wviminfo").
7375 h Disable the effect of 'hlsearch' when loading the viminfo
7376 file. When not included, it depends on whether ":nohlsearch"
7377 has been used since the last search command.
7378 n Name of the viminfo file. The name must immediately follow
7379 the 'n'. Must be the last one! If the "-i" argument was
7380 given when starting Vim, that file name overrides the one
7381 given here with 'viminfo'. Environment variables are expanded
7382 when opening the file, not when setting the option.
7383 r Removable media. The argument is a string (up to the next
7384 ','). This parameter can be given several times. Each
7385 specifies the start of a path for which no marks will be
7386 stored. This is to avoid removable media. For MS-DOS you
7387 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7388 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7389 ignored. Maximum length of each 'r' argument is 50
7390 characters.
7391 s Maximum size of an item in Kbyte. If zero then registers are
7392 not saved. Currently only applies to registers. The default
7393 "s10" will exclude registers with more than 10 Kbyte of text.
7394 Also see the '<' item above: line count limit.
7395
7396 Example: >
7397 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7398<
7399 '50 Marks will be remembered for the last 50 files you
7400 edited.
7401 <1000 Contents of registers (up to 1000 lines each) will be
7402 remembered.
7403 s100 Registers with more than 100 Kbyte text are skipped.
7404 :0 Command-line history will not be saved.
7405 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7406 no / Since '/' is not specified, the default will be used,
7407 that is, save all of the search history, and also the
7408 previous search and substitute patterns.
7409 no % The buffer list will not be saved nor read back.
7410 no h 'hlsearch' highlighting will be restored.
7411
7412 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7413 load the contents of the file, this is not done automatically.
7414
7415 This option cannot be set from a |modeline| or in the |sandbox|, for
7416 security reasons.
7417
7418 *'virtualedit'* *'ve'*
7419'virtualedit' 've' string (default "")
7420 global
7421 {not in Vi}
7422 {not available when compiled without the
7423 |+virtualedit| feature}
7424 A comma separated list of these words:
7425 block Allow virtual editing in Visual block mode.
7426 insert Allow virtual editing in Insert mode.
7427 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007428 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007429
Bram Moolenaar071d4272004-06-13 20:20:40 +00007430 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007431 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 of the line. Useful for selecting a rectangle in Visual mode and
7433 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007434 "onemore" is not the same, it will only allow moving the cursor just
7435 after the last character of the line. This makes some commands more
7436 consistent. Previously the cursor was always past the end of the line
7437 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007438 break some plugins or Vim scripts. For example because |l| can move
7439 the cursor after the last character. Use with care!
7440 Using the |$| command will move to the last character in the line, not
7441 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007442 It doesn't make sense to combine "all" with "onemore", but you will
7443 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007444
7445 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7446'visualbell' 'vb' boolean (default off)
7447 global
7448 {not in Vi}
7449 Use visual bell instead of beeping. The terminal code to display the
7450 visual bell is given with 't_vb'. When no beep or flash is wanted,
7451 use ":set vb t_vb=".
7452 Note: When the GUI starts, 't_vb' is reset to its default value. You
7453 might want to set it again in your |gvimrc|.
7454 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7455 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7456 where 40 is the time in msec.
7457 Does not work on the Amiga, you always get a screen flash.
7458 Also see 'errorbells'.
7459
7460 *'warn'* *'nowarn'*
7461'warn' boolean (default on)
7462 global
7463 Give a warning message when a shell command is used while the buffer
7464 has been changed.
7465
7466 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7467'weirdinvert' 'wiv' boolean (default off)
7468 global
7469 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007470 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 It is provided for backwards compatibility with version 4.x.
7472 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7473 vice versa. Has no effect when the GUI is running.
7474
7475 *'whichwrap'* *'ww'*
7476'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7477 global
7478 {not in Vi}
7479 Allow specified keys that move the cursor left/right to move to the
7480 previous/next line when the cursor is on the first/last character in
7481 the line. Concatenate characters to allow this for these keys:
7482 char key mode ~
7483 b <BS> Normal and Visual
7484 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007485 h "h" Normal and Visual (not recommended)
7486 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007487 < <Left> Normal and Visual
7488 > <Right> Normal and Visual
7489 ~ "~" Normal
7490 [ <Left> Insert and Replace
7491 ] <Right> Insert and Replace
7492 For example: >
7493 :set ww=<,>,[,]
7494< allows wrap only when cursor keys are used.
7495 When the movement keys are used in combination with a delete or change
7496 operator, the <EOL> also counts for a character. This makes "3h"
7497 different from "3dh" when the cursor crosses the end of a line. This
7498 is also true for "x" and "X", because they do the same as "dl" and
7499 "dh". If you use this, you may also want to use the mapping
7500 ":map <BS> X" to make backspace delete the character in front of the
7501 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007502 When 'l' is included and it is used after an operator at the end of a
7503 line then it will not move to the next line. This makes "dl", "cl",
7504 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 NOTE: This option is set to the Vi default value when 'compatible' is
7506 set and to the Vim default value when 'compatible' is reset.
7507
7508 *'wildchar'* *'wc'*
7509'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7510 global
7511 {not in Vi}
7512 Character you have to type to start wildcard expansion in the
7513 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007514 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 The character is not recognized when used inside a macro. See
7516 'wildcharm' for that.
7517 Although 'wc' is a number option, you can set it to a special key: >
7518 :set wc=<Esc>
7519< NOTE: This option is set to the Vi default value when 'compatible' is
7520 set and to the Vim default value when 'compatible' is reset.
7521
7522 *'wildcharm'* *'wcm'*
7523'wildcharm' 'wcm' number (default: none (0))
7524 global
7525 {not in Vi}
7526 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007527 recognized when used inside a macro. You can find "spare" command-line
7528 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007529 you'll never actually type 'wildcharm', just use it in mappings that
7530 automatically invoke completion mode, e.g.: >
7531 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007532 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007533< Then after typing :ss you can use CTRL-P & CTRL-N.
7534
7535 *'wildignore'* *'wig'*
7536'wildignore' 'wig' string (default "")
7537 global
7538 {not in Vi}
7539 {not available when compiled without the |+wildignore|
7540 feature}
7541 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007542 patterns is ignored when completing file or directory names, and
7543 influences the result of |expand()|, |glob()| and |globpath()| unless
7544 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007545 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7546 Also see 'suffixes'.
7547 Example: >
7548 :set wildignore=*.o,*.obj
7549< The use of |:set+=| and |:set-=| is preferred when adding or removing
7550 a pattern from the list. This avoids problems when a future version
7551 uses another default.
7552
7553 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7554'wildmenu' 'wmnu' boolean (default off)
7555 global
7556 {not in Vi}
7557 {not available if compiled without the |+wildmenu|
7558 feature}
7559 When 'wildmenu' is on, command-line completion operates in an enhanced
7560 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7561 the possible matches are shown just above the command line, with the
7562 first match highlighted (overwriting the status line, if there is
7563 one). Keys that show the previous/next match, such as <Tab> or
7564 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7565 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7566 specified. "longest" and "list" do not start "wildmenu" mode.
7567 If there are more matches than can fit in the line, a ">" is shown on
7568 the right and/or a "<" is shown on the left. The status line scrolls
7569 as needed.
7570 The "wildmenu" mode is abandoned when a key is hit that is not used
7571 for selecting a completion.
7572 While the "wildmenu" is active the following keys have special
7573 meanings:
7574
7575 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7576 <Down> - in filename/menu name completion: move into a
7577 subdirectory or submenu.
7578 <CR> - in menu completion, when the cursor is just after a
7579 dot: move into a submenu.
7580 <Up> - in filename/menu name completion: move up into
7581 parent directory or parent menu.
7582
7583 This makes the menus accessible from the console |console-menus|.
7584
7585 If you prefer the <Left> and <Right> keys to move the cursor instead
7586 of selecting a different match, use this: >
7587 :cnoremap <Left> <Space><BS><Left>
7588 :cnoremap <Right> <Space><BS><Right>
7589<
7590 The "WildMenu" highlighting is used for displaying the current match
7591 |hl-WildMenu|.
7592
7593 *'wildmode'* *'wim'*
7594'wildmode' 'wim' string (Vim default: "full")
7595 global
7596 {not in Vi}
7597 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007598 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007599 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007600 first part specifies the behavior for the first use of 'wildchar',
7601 The second part for the second use, etc.
7602 These are the possible values for each part:
7603 "" Complete only the first match.
7604 "full" Complete the next full match. After the last match,
7605 the original string is used and then the first match
7606 again.
7607 "longest" Complete till longest common string. If this doesn't
7608 result in a longer string, use the next part.
7609 "longest:full" Like "longest", but also start 'wildmenu' if it is
7610 enabled.
7611 "list" When more than one match, list all matches.
7612 "list:full" When more than one match, list all matches and
7613 complete first match.
7614 "list:longest" When more than one match, list all matches and
7615 complete till longest common string.
7616 When there is only a single match, it is fully completed in all cases.
7617
7618 Examples: >
7619 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007620< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 :set wildmode=longest,full
7622< Complete longest common string, then each full match >
7623 :set wildmode=list:full
7624< List all matches and complete each full match >
7625 :set wildmode=list,full
7626< List all matches without completing, then each full match >
7627 :set wildmode=longest,list
7628< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007629 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007631 *'wildoptions'* *'wop'*
7632'wildoptions' 'wop' string (default "")
7633 global
7634 {not in Vi}
7635 {not available when compiled without the |+wildignore|
7636 feature}
7637 A list of words that change how command line completion is done.
7638 Currently only one word is allowed:
7639 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007640 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007641 is displayed per line. Often used tag kinds are:
7642 d #define
7643 f function
7644 Also see |cmdline-completion|.
7645
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 *'winaltkeys'* *'wak'*
7647'winaltkeys' 'wak' string (default "menu")
7648 global
7649 {not in Vi}
7650 {only used in Win32, Motif, GTK and Photon GUI}
7651 Some GUI versions allow the access to menu entries by using the ALT
7652 key in combination with a character that appears underlined in the
7653 menu. This conflicts with the use of the ALT key for mappings and
7654 entering special characters. This option tells what to do:
7655 no Don't use ALT keys for menus. ALT key combinations can be
7656 mapped, but there is no automatic handling. This can then be
7657 done with the |:simalt| command.
7658 yes ALT key handling is done by the windowing system. ALT key
7659 combinations cannot be mapped.
7660 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007661 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 keys can be mapped.
7663 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7664 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007665 This option is not used for <F10>; on Win32 and with GTK <F10> will
7666 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007668 *'window'* *'wi'*
7669'window' 'wi' number (default screen height - 1)
7670 global
7671 Window height. Do not confuse this with the height of the Vim window,
7672 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007673 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7674 value is smaller than 'lines' minus one. The screen will scroll
7675 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007676 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7677 in a much smarter way, taking care of wrapping lines.
7678 When resizing the Vim window, the value is smaller than 1 or more than
7679 or equal to 'lines' it will be set to 'lines' minus 1.
7680 {Vi also uses the option to specify the number of displayed lines}
7681
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 *'winheight'* *'wh'* *E591*
7683'winheight' 'wh' number (default 1)
7684 global
7685 {not in Vi}
7686 {not available when compiled without the +windows
7687 feature}
7688 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007689 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007690 focus goes to a window that is smaller, its size is increased, at the
7691 cost of the height of other windows.
7692 Set 'winheight' to a small number for normal editing.
7693 Set it to 999 to make the current window fill most of the screen.
7694 Other windows will be only 'winminheight' high. This has the drawback
7695 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7696 to create only two windows, set the option after startup is done,
7697 using the |VimEnter| event: >
7698 au VimEnter * set winheight=999
7699< Minimum value is 1.
7700 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007701 height of the current window.
7702 'winheight' applies to the current window. Use 'winminheight' to set
7703 the minimal height for other windows.
7704
7705 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7706'winfixheight' 'wfh' boolean (default off)
7707 local to window
7708 {not in Vi}
7709 {not available when compiled without the +windows
7710 feature}
7711 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007712 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7713 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007714 The height may be changed anyway when running out of room.
7715
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007716 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7717'winfixwidth' 'wfw' boolean (default off)
7718 local to window
7719 {not in Vi}
7720 {not available when compiled without the +windows
7721 feature}
7722 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007723 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007724 The width may be changed anyway when running out of room.
7725
Bram Moolenaar071d4272004-06-13 20:20:40 +00007726 *'winminheight'* *'wmh'*
7727'winminheight' 'wmh' number (default 1)
7728 global
7729 {not in Vi}
7730 {not available when compiled without the +windows
7731 feature}
7732 The minimal height of a window, when it's not the current window.
7733 This is a hard minimum, windows will never become smaller.
7734 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7735 status bar) if necessary. They will return to at least one line when
7736 they become active (since the cursor has to have somewhere to go.)
7737 Use 'winheight' to set the minimal height of the current window.
7738 This option is only checked when making a window smaller. Don't use a
7739 large number, it will cause errors when opening more than a few
7740 windows. A value of 0 to 3 is reasonable.
7741
7742 *'winminwidth'* *'wmw'*
7743'winminwidth' 'wmw' number (default 1)
7744 global
7745 {not in Vi}
7746 {not available when compiled without the +vertsplit
7747 feature}
7748 The minimal width of a window, when it's not the current window.
7749 This is a hard minimum, windows will never become smaller.
7750 When set to zero, windows may be "squashed" to zero columns (i.e. just
7751 a vertical separator) if necessary. They will return to at least one
7752 line when they become active (since the cursor has to have somewhere
7753 to go.)
7754 Use 'winwidth' to set the minimal width of the current window.
7755 This option is only checked when making a window smaller. Don't use a
7756 large number, it will cause errors when opening more than a few
7757 windows. A value of 0 to 12 is reasonable.
7758
7759 *'winwidth'* *'wiw'* *E592*
7760'winwidth' 'wiw' number (default 20)
7761 global
7762 {not in Vi}
7763 {not available when compiled without the +vertsplit
7764 feature}
7765 Minimal number of columns for the current window. This is not a hard
7766 minimum, Vim will use fewer columns if there is not enough room. If
7767 the current window is smaller, its size is increased, at the cost of
7768 the width of other windows. Set it to 999 to make the current window
7769 always fill the screen. Set it to a small number for normal editing.
7770 The width is not adjusted after one of the commands to change the
7771 width of the current window.
7772 'winwidth' applies to the current window. Use 'winminwidth' to set
7773 the minimal width for other windows.
7774
7775 *'wrap'* *'nowrap'*
7776'wrap' boolean (default on)
7777 local to window
7778 {not in Vi}
7779 This option changes how text is displayed. It doesn't change the text
7780 in the buffer, see 'textwidth' for that.
7781 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007782 displaying continues on the next line. When off lines will not wrap
7783 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 moved to a part that is not shown, the screen will scroll
7785 horizontally.
7786 The line will be broken in the middle of a word if necessary. See
7787 'linebreak' to get the break at a word boundary.
7788 To make scrolling horizontally a bit more useful, try this: >
7789 :set sidescroll=5
7790 :set listchars+=precedes:<,extends:>
7791< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007792 This option can't be set from a |modeline| when the 'diff' option is
7793 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007794
7795 *'wrapmargin'* *'wm'*
7796'wrapmargin' 'wm' number (default 0)
7797 local to buffer
7798 Number of characters from the right window border where wrapping
7799 starts. When typing text beyond this limit, an <EOL> will be inserted
7800 and inserting continues on the next line.
7801 Options that add a margin, such as 'number' and 'foldcolumn', cause
7802 the text width to be further reduced. This is Vi compatible.
7803 When 'textwidth' is non-zero, this option is not used.
7804 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
7805 and less usefully}
7806
7807 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
7808'wrapscan' 'ws' boolean (default on) *E384* *E385*
7809 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00007810 Searches wrap around the end of the file. Also applies to |]s| and
7811 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812
7813 *'write'* *'nowrite'*
7814'write' boolean (default on)
7815 global
7816 {not in Vi}
7817 Allows writing files. When not set, writing a file is not allowed.
7818 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007819 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00007820 argument. Filtering text is still possible, even though this requires
7821 writing a temporary file.
7822
7823 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
7824'writeany' 'wa' boolean (default off)
7825 global
7826 Allows writing to any file with no need for "!" override.
7827
7828 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
7829'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
7830 otherwise)
7831 global
7832 {not in Vi}
7833 Make a backup before overwriting a file. The backup is removed after
7834 the file was successfully written, unless the 'backup' option is
7835 also on. Reset this option if your file system is almost full. See
7836 |backup-table| for another explanation.
7837 When the 'backupskip' pattern matches, a backup is not made anyway.
7838 NOTE: This option is set to the default value when 'compatible' is
7839 set.
7840
7841 *'writedelay'* *'wd'*
7842'writedelay' 'wd' number (default 0)
7843 global
7844 {not in Vi}
7845 The number of microseconds to wait for each character sent to the
7846 screen. When non-zero, characters are sent to the terminal one by
7847 one. For MS-DOS pcterm this does not work. For debugging purposes.
7848
7849 vim:tw=78:ts=8:ft=help:norl: