blob: db3ea35d6d4c5521ae2968e6752683cc342547ae [file] [log] [blame]
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001*options.txt* For Vim version 7.3. Last change: 2010 Nov 16
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 Moolenaardb84e452010-08-15 13:50:43 +0200140{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000141
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.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200276 With the "all" argument: display local values for all
277 local options.
278 Without argument: Display local values for all local
279 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000280 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.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200301 With the "all" argument: display global values for all
302 local options.
303 Without argument: display global values for all local
304 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000305 {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.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200668 *E834* *E835*
669 The value "double" cannot be used if 'listchars' or 'fillchars'
670 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000671
672 There are a number of CJK fonts for which the width of glyphs for
673 those characters are solely based on how many octets they take in
674 legacy/traditional CJK encodings. In those encodings, Euro,
675 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000676 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000677 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000678 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 Vim is running inside a terminal (emulators) that uses a CJK font
680 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
681 this option should be set to "double" to match the width perceived
682 by Vim with the width of glyphs in the font. Perhaps it also has
683 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
684 when the system locale is set to one of CJK locales. See Unicode
685 Standard Annex #11 (http://www.unicode.org/reports/tr11).
686
687 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
688'antialias' 'anti' boolean (default: off)
689 global
690 {not in Vi}
691 {only available when compiled with GUI enabled
692 on Mac OS X}
693 This option only has an effect in the GUI version of Vim on Mac OS X
694 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
695 which can be easier to read at certain sizes on certain displays.
696 Setting this option can sometimes cause problems if 'guifont' is set
697 to its default (empty string).
698
699 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
700'autochdir' 'acd' boolean (default off)
701 global
702 {not in Vi}
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200703 {only available when compiled with it, use
704 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000705 When on, Vim will change the current working directory whenever you
706 open a file, switch buffers, delete a buffer or open/close a window.
707 It will change to the directory containing the file which was opened
708 or selected.
709 This option is provided for backward compatibility with the Vim
710 released with Sun ONE Studio 4 Enterprise Edition.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000711 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000712
713 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
714'arabic' 'arab' boolean (default off)
715 local to window
716 {not in Vi}
717 {only available when compiled with the |+arabic|
718 feature}
719 This option can be set to start editing Arabic text.
720 Setting this option will:
721 - Set the 'rightleft' option, unless 'termbidi' is set.
722 - Set the 'arabicshape' option, unless 'termbidi' is set.
723 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
724 between typing English and Arabic key mapping.
725 - Set the 'delcombine' option
726 Note that 'encoding' must be "utf-8" for working with Arabic text.
727
728 Resetting this option will:
729 - Reset the 'rightleft' option.
730 - Disable the use of 'keymap' (without changing its value).
731 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
732 option.
733 Also see |arabic.txt|.
734
735 *'arabicshape'* *'arshape'*
736 *'noarabicshape'* *'noarshape'*
737'arabicshape' 'arshape' boolean (default on)
738 global
739 {not in Vi}
740 {only available when compiled with the |+arabic|
741 feature}
742 When on and 'termbidi' is off, the required visual character
743 corrections that need to take place for displaying the Arabic language
744 take affect. Shaping, in essence, gets enabled; the term is a broad
745 one which encompasses:
746 a) the changing/morphing of characters based on their location
747 within a word (initial, medial, final and stand-alone).
748 b) the enabling of the ability to compose characters
749 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100750 When disabled the display shows each character's true stand-alone
751 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000752 Arabic is a complex language which requires other settings, for
753 further details see |arabic.txt|.
754
755 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
756'autoindent' 'ai' boolean (default off)
757 local to buffer
758 Copy indent from current line when starting a new line (typing <CR>
759 in Insert mode or when using the "o" or "O" command). If you do not
760 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000761 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
762 to another line has the same effect, unless the 'I' flag is included
763 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000764 When autoindent is on, formatting (with the "gq" command or when you
765 reach 'textwidth' in Insert mode) uses the indentation of the first
766 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000767 When 'smartindent' or 'cindent' is on the indent is changed in
768 a different way.
769 The 'autoindent' option is reset when the 'paste' option is set.
770 {small difference from Vi: After the indent is deleted when typing
771 <Esc> or <CR>, the cursor position when moving up or down is after the
772 deleted indent; Vi puts the cursor somewhere in the deleted indent}.
773
774 *'autoread'* *'ar'* *'noautoread'* *'noar'*
775'autoread' 'ar' boolean (default off)
776 global or local to buffer |global-local|
777 {not in Vi}
778 When a file has been detected to have been changed outside of Vim and
779 it has not been changed inside of Vim, automatically read it again.
780 When the file has been deleted this is not done. |timestamp|
781 If this option has a local value, use this command to switch back to
782 using the global value: >
783 :set autoread<
784<
785 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
786'autowrite' 'aw' boolean (default off)
787 global
788 Write the contents of the file, if it has been modified, on each
789 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000790 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000791 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
792 Note that for some commands the 'autowrite' option is not used, see
793 'autowriteall' for that.
794
795 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
796'autowriteall' 'awa' boolean (default off)
797 global
798 {not in Vi}
799 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
800 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
801 Setting this option also implies that Vim behaves like 'autowrite' has
802 been set.
803
804 *'background'* *'bg'*
805'background' 'bg' string (default "dark" or "light")
806 global
807 {not in Vi}
808 When set to "dark", Vim will try to use colors that look good on a
809 dark background. When set to "light", Vim will try to use colors that
810 look good on a light background. Any other value is illegal.
811 Vim tries to set the default value according to the terminal used.
812 This will not always be correct.
813 Setting this option does not change the background color, it tells Vim
814 what the background color looks like. For changing the background
815 color, see |:hi-normal|.
816
817 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000818 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000819 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100820 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 setting 'background' will cause the color scheme to be reloaded. If
822 the color scheme adjusts to the value of 'background' this will work.
823 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100824 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 When setting 'background' to the default value with: >
827 :set background&
828< Vim will guess the value. In the GUI this should work correctly,
829 in other cases Vim might not be able to guess the right value.
830
831 When starting the GUI, the default value for 'background' will be
832 "light". When the value is not set in the .gvimrc, and Vim detects
833 that the background is actually quite dark, 'background' is set to
834 "dark". But this happens only AFTER the .gvimrc file has been read
835 (because the window needs to be opened to find the actual background
836 color). To get around this, force the GUI window to be opened by
837 putting a ":gui" command in the .gvimrc file, before where the value
838 of 'background' is used (e.g., before ":syntax on").
839 Normally this option would be set in the .vimrc file. Possibly
840 depending on the terminal name. Example: >
841 :if &term == "pcterm"
842 : set background=dark
843 :endif
844< When this option is set, the default settings for the highlight groups
845 will change. To use other settings, place ":highlight" commands AFTER
846 the setting of the 'background' option.
847 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
848 to select the colors for syntax highlighting. After changing this
849 option, you must load syntax.vim again to see the result. This can be
850 done with ":syntax on".
851
852 *'backspace'* *'bs'*
853'backspace' 'bs' string (default "")
854 global
855 {not in Vi}
856 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
857 mode. This is a list of items, separated by commas. Each item allows
858 a way to backspace over something:
859 value effect ~
860 indent allow backspacing over autoindent
861 eol allow backspacing over line breaks (join lines)
862 start allow backspacing over the start of insert; CTRL-W and CTRL-U
863 stop once at the start of insert.
864
865 When the value is empty, Vi compatible backspacing is used.
866
867 For backwards compatibility with version 5.4 and earlier:
868 value effect ~
869 0 same as ":set backspace=" (Vi compatible)
870 1 same as ":set backspace=indent,eol"
871 2 same as ":set backspace=indent,eol,start"
872
873 See |:fixdel| if your <BS> or <Del> key does not do what you want.
874 NOTE: This option is set to "" when 'compatible' is set.
875
876 *'backup'* *'bk'* *'nobackup'* *'nobk'*
877'backup' 'bk' boolean (default off)
878 global
879 {not in Vi}
880 Make a backup before overwriting a file. Leave it around after the
881 file has been successfully written. If you do not want to keep the
882 backup file, but you do want a backup while the file is being
883 written, reset this option and set the 'writebackup' option (this is
884 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000885 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000886 |backup-table| for more explanations.
887 When the 'backupskip' pattern matches, a backup is not made anyway.
888 When 'patchmode' is set, the backup may be renamed to become the
889 oldest version of a file.
890 NOTE: This option is reset when 'compatible' is set.
891
892 *'backupcopy'* *'bkc'*
893'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
894 global
895 {not in Vi}
896 When writing a file and a backup is made, this option tells how it's
897 done. This is a comma separated list of words.
898
899 The main values are:
900 "yes" make a copy of the file and overwrite the original one
901 "no" rename the file and write a new one
902 "auto" one of the previous, what works best
903
904 Extra values that can be combined with the ones above are:
905 "breaksymlink" always break symlinks when writing
906 "breakhardlink" always break hardlinks when writing
907
908 Making a copy and overwriting the original file:
909 - Takes extra time to copy the file.
910 + When the file has special attributes, is a (hard/symbolic) link or
911 has a resource fork, all this is preserved.
912 - When the file is a link the backup will have the name of the link,
913 not of the real file.
914
915 Renaming the file and writing a new one:
916 + It's fast.
917 - Sometimes not all attributes of the file can be copied to the new
918 file.
919 - When the file is a link the new file will not be a link.
920
921 The "auto" value is the middle way: When Vim sees that renaming file
922 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000923 the file is not a link) that is used. When problems are expected, a
924 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925
926 The "breaksymlink" and "breakhardlink" values can be used in
927 combination with any of "yes", "no" and "auto". When included, they
928 force Vim to always break either symbolic or hard links by doing
929 exactly what the "no" option does, renaming the original file to
930 become the backup and writing a new file in its place. This can be
931 useful for example in source trees where all the files are symbolic or
932 hard links and any changes should stay in the local source tree, not
933 be propagated back to the original source.
934 *crontab*
935 One situation where "no" and "auto" will cause problems: A program
936 that opens a file, invokes Vim to edit that file, and then tests if
937 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000938 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000939 example.
940
941 When a copy is made, the original file is truncated and then filled
942 with the new text. This means that protection bits, owner and
943 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000944 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000945 group of the backup is set to the group of the original file. If this
946 fails, the protection bits for the group are made the same as for
947 others.
948
949 When the file is renamed this is the other way around: The backup has
950 the same attributes of the original file, and the newly written file
951 is owned by the current user. When the file was a (hard/symbolic)
952 link, the new file will not! That's why the "auto" value doesn't
953 rename when the file is a link. The owner and group of the newly
954 written file will be set to the same ones as the original file, but
955 the system may refuse to do this. In that case the "auto" value will
956 again not rename the file.
957
958 *'backupdir'* *'bdir'*
959'backupdir' 'bdir' string (default for Amiga: ".,t:",
960 for MS-DOS and Win32: ".,c:/tmp,c:/temp"
961 for Unix: ".,~/tmp,~/")
962 global
963 {not in Vi}
964 List of directories for the backup file, separated with commas.
965 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100966 where this is possible. The directory must exist, Vim will not
967 create it for you.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000968 - Empty means that no backup file will be created ('patchmode' is
969 impossible!). Writing may fail because of this.
970 - A directory "." means to put the backup file in the same directory
971 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +0000972 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +0000973 put the backup file relative to where the edited file is. The
974 leading "." is replaced with the path name of the edited file.
975 ("." inside a directory name has no special meaning).
976 - Spaces after the comma are ignored, other spaces are considered part
977 of the directory name. To have a space at the start of a directory
978 name, precede it with a backslash.
979 - To include a comma in a directory name precede it with a backslash.
980 - A directory name may end in an '/'.
981 - Environment variables are expanded |:set_env|.
982 - Careful with '\' characters, type one before a space, type two to
983 get one in the option (see |option-backslash|), for example: >
984 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
985< - For backwards compatibility with Vim version 3.0 a '>' at the start
986 of the option is removed.
987 See also 'backup' and 'writebackup' options.
988 If you want to hide your backup files on Unix, consider this value: >
989 :set backupdir=./.backup,~/.backup,.,/tmp
990< You must create a ".backup" directory in each directory and in your
991 home directory for this to work properly.
992 The use of |:set+=| and |:set-=| is preferred when adding or removing
993 directories from the list. This avoids problems when a future version
994 uses another default.
995 This option cannot be set from a |modeline| or in the |sandbox|, for
996 security reasons.
997
998 *'backupext'* *'bex'* *E589*
999'backupext' 'bex' string (default "~", for VMS: "_")
1000 global
1001 {not in Vi}
1002 String which is appended to a file name to make the name of the
1003 backup file. The default is quite unusual, because this avoids
1004 accidentally overwriting existing files with a backup file. You might
1005 prefer using ".bak", but make sure that you don't have files with
1006 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001007 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001009 If you like to keep a lot of backups, you could use a BufWritePre
1010 autocommand to change 'backupext' just before writing the file to
1011 include a timestamp. >
1012 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1013< Use 'backupdir' to put the backup in a different directory.
1014
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 *'backupskip'* *'bsk'*
1016'backupskip' 'bsk' string (default: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
1017 global
1018 {not in Vi}
1019 {not available when compiled without the |+wildignore|
1020 feature}
1021 A list of file patterns. When one of the patterns matches with the
1022 name of the file which is written, no backup file is created. Both
1023 the specified file name and the full path name of the file are used.
1024 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1025 Watch out for special characters, see |option-backslash|.
1026 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001027 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001028
1029 Note that environment variables are not expanded. If you want to use
1030 $HOME you must expand it explicitly, e.g.: >
1031 :let backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
1032
1033< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001034 backup would be made by renaming the original file crontab won't see
1035 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001036
1037 *'balloondelay'* *'bdlay'*
1038'balloondelay' 'bdlay' number (default: 600)
1039 global
1040 {not in Vi}
1041 {only available when compiled with the |+balloon_eval|
1042 feature}
1043 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1044
1045 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1046'ballooneval' 'beval' boolean (default off)
1047 global
1048 {not in Vi}
1049 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001050 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001051 Switch on the |balloon-eval| functionality.
1052
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001053 *'balloonexpr'* *'bexpr'*
1054'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001055 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001056 {not in Vi}
1057 {only available when compiled with the |+balloon_eval|
1058 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001059 Expression for text to show in evaluation balloon. It is only used
1060 when 'ballooneval' is on. These variables can be used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001061
1062 v:beval_bufnr number of the buffer in which balloon is going to show
1063 v:beval_winnr number of the window
1064 v:beval_lnum line number
1065 v:beval_col column number (byte index)
1066 v:beval_text word under or after the mouse pointer
1067
1068 The evaluation of the expression must not have side effects!
1069 Example: >
1070 function! MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001071 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001072 \', column ' . v:beval_col .
1073 \ ' of file ' . bufname(v:beval_bufnr) .
1074 \ ' on word "' . v:beval_text . '"'
1075 endfunction
1076 set bexpr=MyBalloonExpr()
1077 set ballooneval
1078<
1079 NOTE: The balloon is displayed only if the cursor is on a text
1080 character. If the result of evaluating 'balloonexpr' is not empty,
1081 Vim does not try to send a message to an external debugger (Netbeans
1082 or Sun Workshop).
1083
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001084 The expression may be evaluated in the |sandbox|, see
1085 |sandbox-option|.
1086
1087 It is not allowed to change text or jump to another window while
1088 evaluating 'balloonexpr' |textlock|.
1089
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001090 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001091 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001092< When they are supported "\n" characters will start a new line. If the
1093 expression evaluates to a |List| this is equal to using each List item
1094 as a string and putting "\n" in between them.
1095
Bram Moolenaar071d4272004-06-13 20:20:40 +00001096 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1097'binary' 'bin' boolean (default off)
1098 local to buffer
1099 {not in Vi}
1100 This option should be set before editing a binary file. You can also
1101 use the |-b| Vim argument. When this option is switched on a few
1102 options will be changed (also when it already was on):
1103 'textwidth' will be set to 0
1104 'wrapmargin' will be set to 0
1105 'modeline' will be off
1106 'expandtab' will be off
1107 Also, 'fileformat' and 'fileformats' options will not be used, the
1108 file is read and written like 'fileformat' was "unix" (a single <NL>
1109 separates lines).
1110 The 'fileencoding' and 'fileencodings' options will not be used, the
1111 file is read without conversion.
1112 NOTE: When you start editing a(nother) file while the 'bin' option is
1113 on, settings from autocommands may change the settings again (e.g.,
1114 'textwidth'), causing trouble when editing. You might want to set
1115 'bin' again when the file has been loaded.
1116 The previous values of these options are remembered and restored when
1117 'bin' is switched from on to off. Each buffer has its own set of
1118 saved option values.
1119 To edit a file with 'binary' set you can use the |++bin| argument.
1120 This avoids you have to do ":set bin", which would have effect for all
1121 files you edit.
1122 When writing a file the <EOL> for the last line is only written if
1123 there was one in the original file (normally Vim appends an <EOL> to
1124 the last line if there is none; this would make the file longer). See
1125 the 'endofline' option.
1126
1127 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1128'bioskey' 'biosk' boolean (default on)
1129 global
1130 {not in Vi} {only for MS-DOS}
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001131 When on the BIOS is called to obtain a keyboard character. This works
Bram Moolenaar071d4272004-06-13 20:20:40 +00001132 better to detect CTRL-C, but only works for the console. When using a
1133 terminal over a serial port reset this option.
1134 Also see |'conskey'|.
1135
1136 *'bomb'* *'nobomb'*
1137'bomb' boolean (default off)
1138 local to buffer
1139 {not in Vi}
1140 {only available when compiled with the |+multi_byte|
1141 feature}
1142 When writing a file and the following conditions are met, a BOM (Byte
1143 Order Mark) is prepended to the file:
1144 - this option is on
1145 - the 'binary' option is off
1146 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1147 endian variants.
1148 Some applications use the BOM to recognize the encoding of the file.
1149 Often used for UCS-2 files on MS-Windows. For other applications it
1150 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001151 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001152 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1153 check for the presence of the BOM is done and 'bomb' set accordingly.
1154 Unless 'binary' is set, it is removed from the first line, so that you
1155 don't see it when editing. When you don't change the options, the BOM
1156 will be restored when writing the file.
1157
1158 *'breakat'* *'brk'*
1159'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1160 global
1161 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001162 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001163 feature}
1164 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001165 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1166 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001167
1168 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001169'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001170 global
Bram Moolenaar446cb832008-06-24 21:56:24 +00001171 {not in Vi} {only for Motif, Athena, GTK, Mac and
1172 Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001173 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001174 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001175 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001176 buffer Use the directory of the related buffer.
1177 current Use the current directory.
1178 {path} Use the specified directory
1179
1180 *'bufhidden'* *'bh'*
1181'bufhidden' 'bh' string (default: "")
1182 local to buffer
1183 {not in Vi}
1184 {not available when compiled without the |+quickfix|
1185 feature}
1186 This option specifies what happens when a buffer is no longer
1187 displayed in a window:
1188 <empty> follow the global 'hidden' option
1189 hide hide the buffer (don't unload it), also when 'hidden'
1190 is not set
1191 unload unload the buffer, also when 'hidden' is set or using
1192 |:hide|
1193 delete delete the buffer from the buffer list, also when
1194 'hidden' is set or using |:hide|, like using
1195 |:bdelete|
1196 wipe wipe out the buffer from the buffer list, also when
1197 'hidden' is set or using |:hide|, like using
1198 |:bwipeout|
1199
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001200 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
1201 are lost without a warning.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001202 This option is used together with 'buftype' and 'swapfile' to specify
1203 special kinds of buffers. See |special-buffers|.
1204
1205 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1206'buflisted' 'bl' boolean (default: on)
1207 local to buffer
1208 {not in Vi}
1209 When this option is set, the buffer shows up in the buffer list. If
1210 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1211 This option is reset by Vim for buffers that are only used to remember
1212 a file name or marks. Vim sets it when starting to edit a buffer.
1213 But not when moving to a buffer with ":buffer".
1214
1215 *'buftype'* *'bt'* *E382*
1216'buftype' 'bt' string (default: "")
1217 local to buffer
1218 {not in Vi}
1219 {not available when compiled without the |+quickfix|
1220 feature}
1221 The value of this option specifies the type of a buffer:
1222 <empty> normal buffer
1223 nofile buffer which is not related to a file and will not be
1224 written
1225 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001226 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001227 autocommands. {not available when compiled without the
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001228 |+autocmd| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001229 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001230 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001231 help help buffer (you are not supposed to set this
1232 manually)
1233
1234 This option is used together with 'bufhidden' and 'swapfile' to
1235 specify special kinds of buffers. See |special-buffers|.
1236
1237 Be careful with changing this option, it can have many side effects!
1238
Bram Moolenaar280f1262006-01-30 00:14:18 +00001239 A "quickfix" buffer is only used for the error list and the location
1240 list. This value is set by the |:cwindow| and |:lwindow| commands and
1241 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001242
1243 "nofile" and "nowrite" buffers are similar:
1244 both: The buffer is not to be written to disk, ":w" doesn't
1245 work (":w filename" does work though).
1246 both: The buffer is never considered to be |'modified'|.
1247 There is no warning when the changes will be lost, for
1248 example when you quit Vim.
1249 both: A swap file is only created when using too much memory
1250 (when 'swapfile' has been reset there is never a swap
1251 file).
1252 nofile only: The buffer name is fixed, it is not handled like a
1253 file name. It is not modified in response to a |:cd|
1254 command.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001255 *E676*
1256 "acwrite" implies that the buffer name is not related to a file, like
1257 "nofile", but it will be written. Thus, in contrast to "nofile" and
1258 "nowrite", ":w" does work and a modified buffer can't be abandoned
1259 without saving. For writing there must be matching |BufWriteCmd|,
1260 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001261
1262 *'casemap'* *'cmp'*
1263'casemap' 'cmp' string (default: "internal,keepascii")
1264 global
1265 {not in Vi}
Bram Moolenaar2217cae2006-03-25 21:55:52 +00001266 {only available when compiled with the |+multi_byte|
1267 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001268 Specifies details about changing the case of letters. It may contain
1269 these words, separated by a comma:
1270 internal Use internal case mapping functions, the current
1271 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001272 matters when 'encoding' is a Unicode encoding,
1273 "latin1" or "iso-8859-15". When "internal" is
1274 omitted, the towupper() and towlower() system library
1275 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1277 case mapping, the current locale is not effective.
1278 This probably only matters for Turkish.
1279
1280 *'cdpath'* *'cd'* *E344* *E346*
1281'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1282 global
1283 {not in Vi}
1284 {not available when compiled without the
1285 |+file_in_path| feature}
1286 This is a list of directories which will be searched when using the
1287 |:cd| and |:lcd| commands, provided that the directory being searched
Bram Moolenaarc236c162008-07-13 17:41:49 +00001288 for has a relative path, not an absolute part starting with "/", "./"
1289 or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001290 The 'cdpath' option's value has the same form and semantics as
1291 |'path'|. Also see |file-searching|.
1292 The default value is taken from $CDPATH, with a "," prepended to look
1293 in the current directory first.
1294 If the default value taken from $CDPATH is not what you want, include
1295 a modified version of the following command in your vimrc file to
1296 override it: >
1297 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1298< This option cannot be set from a |modeline| or in the |sandbox|, for
1299 security reasons.
1300 (parts of 'cdpath' can be passed to the shell to expand file names).
1301
1302 *'cedit'*
1303'cedit' string (Vi default: "", Vim default: CTRL-F)
1304 global
1305 {not in Vi}
1306 {not available when compiled without the |+vertsplit|
1307 feature}
1308 The key used in Command-line Mode to open the command-line window.
1309 The default is CTRL-F when 'compatible' is off.
1310 Only non-printable keys are allowed.
1311 The key can be specified as a single character, but it is difficult to
1312 type. The preferred way is to use the <> notation. Examples: >
1313 :set cedit=<C-Y>
1314 :set cedit=<Esc>
1315< |Nvi| also has this option, but it only uses the first character.
1316 See |cmdwin|.
1317
1318 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1319'charconvert' 'ccv' string (default "")
1320 global
1321 {only available when compiled with the |+multi_byte|
Bram Moolenaardb84e452010-08-15 13:50:43 +02001322 and |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001323 {not in Vi}
1324 An expression that is used for character encoding conversion. It is
1325 evaluated when a file that is to be read or has been written has a
1326 different encoding from what is desired.
1327 'charconvert' is not used when the internal iconv() function is
1328 supported and is able to do the conversion. Using iconv() is
1329 preferred, because it is much faster.
1330 'charconvert' is not used when reading stdin |--|, because there is no
1331 file to convert from. You will have to save the text in a file first.
1332 The expression must return zero or an empty string for success,
1333 non-zero for failure.
1334 The possible encoding names encountered are in 'encoding'.
1335 Additionally, names given in 'fileencodings' and 'fileencoding' are
1336 used.
1337 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1338 is done internally by Vim, 'charconvert' is not used for this.
1339 'charconvert' is also used to convert the viminfo file, if the 'c'
1340 flag is present in 'viminfo'. Also used for Unicode conversion.
1341 Example: >
1342 set charconvert=CharConvert()
1343 fun CharConvert()
1344 system("recode "
1345 \ . v:charconvert_from . ".." . v:charconvert_to
1346 \ . " <" . v:fname_in . " >" v:fname_out)
1347 return v:shell_error
1348 endfun
1349< The related Vim variables are:
1350 v:charconvert_from name of the current encoding
1351 v:charconvert_to name of the desired encoding
1352 v:fname_in name of the input file
1353 v:fname_out name of the output file
1354 Note that v:fname_in and v:fname_out will never be the same.
1355 Note that v:charconvert_from and v:charconvert_to may be different
1356 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1357 Encryption is not done by Vim when using 'charconvert'. If you want
1358 to encrypt the file after conversion, 'charconvert' should take care
1359 of this.
1360 This option cannot be set from a |modeline| or in the |sandbox|, for
1361 security reasons.
1362
1363 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1364'cindent' 'cin' boolean (default off)
1365 local to buffer
1366 {not in Vi}
1367 {not available when compiled without the |+cindent|
1368 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001369 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001370 that trigger reindenting in insert mode and 'cinoptions' to set your
1371 preferred indent style.
1372 If 'indentexpr' is not empty, it overrules 'cindent'.
1373 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1374 the "=" operator indents using this algorithm rather than calling an
1375 external program.
1376 See |C-indenting|.
1377 When you don't like the way 'cindent' works, try the 'smartindent'
1378 option or 'indentexpr'.
1379 This option is not used when 'paste' is set.
1380 NOTE: This option is reset when 'compatible' is set.
1381
1382 *'cinkeys'* *'cink'*
1383'cinkeys' 'cink' string (default "0{,0},0),:,0#,!^F,o,O,e")
1384 local to buffer
1385 {not in Vi}
1386 {not available when compiled without the |+cindent|
1387 feature}
1388 A list of keys that, when typed in Insert mode, cause reindenting of
1389 the current line. Only used if 'cindent' is on and 'indentexpr' is
1390 empty.
1391 For the format of this option see |cinkeys-format|.
1392 See |C-indenting|.
1393
1394 *'cinoptions'* *'cino'*
1395'cinoptions' 'cino' string (default "")
1396 local to buffer
1397 {not in Vi}
1398 {not available when compiled without the |+cindent|
1399 feature}
1400 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1401 program. See |cinoptions-values| for the values of this option, and
1402 |C-indenting| for info on C indenting in general.
1403
1404
1405 *'cinwords'* *'cinw'*
1406'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1407 local to buffer
1408 {not in Vi}
1409 {not available when compiled without both the
1410 |+cindent| and the |+smartindent| features}
1411 These keywords start an extra indent in the next line when
1412 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1413 an appropriate place (inside {}).
1414 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1415 matter, include the keyword both the uppercase and lowercase:
1416 "if,If,IF".
1417
1418 *'clipboard'* *'cb'*
1419'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1420 for X-windows, "" otherwise)
1421 global
1422 {not in Vi}
1423 {only in GUI versions or when the |+xterm_clipboard|
1424 feature is included}
1425 This option is a list of comma separated names.
1426 These names are recognized:
1427
1428 unnamed When included, Vim will use the clipboard register '*'
1429 for all yank, delete, change and put operations which
1430 would normally go to the unnamed register. When a
1431 register is explicitly specified, it will always be
1432 used regardless of whether "unnamed" is in 'clipboard'
1433 or not. The clipboard register can always be
1434 explicitly accessed using the "* notation. Also see
1435 |gui-clipboard|.
1436
1437 autoselect Works like the 'a' flag in 'guioptions': If present,
1438 then whenever Visual mode is started, or the Visual
1439 area extended, Vim tries to become the owner of the
1440 windowing system's global selection or put the
1441 selected text on the clipboard used by the selection
1442 register "*. See |guioptions_a| and |quotestar| for
1443 details. When the GUI is active, the 'a' flag in
1444 'guioptions' is used, when the GUI is not active, this
1445 "autoselect" flag is used.
1446 Also applies to the modeless selection.
1447
1448 autoselectml Like "autoselect", but for the modeless selection
1449 only. Compare to the 'A' flag in 'guioptions'.
1450
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001451 html When the clipboard contains HTML, use this when
1452 pasting. When putting text on the clipboard, mark it
1453 as HTML. This works to copy rendered HTML from
1454 Firefox, paste it as raw HTML in Vim, select the HTML
1455 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001456 You probably want to add this only temporarily,
1457 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001458 Only supported for GTK version 2 and later.
1459 Only available with the |+multi_byte| feature.
1460
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 exclude:{pattern}
1462 Defines a pattern that is matched against the name of
1463 the terminal 'term'. If there is a match, no
1464 connection will be made to the X server. This is
1465 useful in this situation:
1466 - Running Vim in a console.
1467 - $DISPLAY is set to start applications on another
1468 display.
1469 - You do not want to connect to the X server in the
1470 console, but do want this in a terminal emulator.
1471 To never connect to the X server use: >
1472 exclude:.*
1473< This has the same effect as using the |-X| argument.
1474 Note that when there is no connection to the X server
1475 the window title won't be restored and the clipboard
1476 cannot be accessed.
1477 The value of 'magic' is ignored, {pattern} is
1478 interpreted as if 'magic' was on.
1479 The rest of the option value will be used for
1480 {pattern}, this must be the last entry.
1481
1482 *'cmdheight'* *'ch'*
1483'cmdheight' 'ch' number (default 1)
1484 global
1485 {not in Vi}
1486 Number of screen lines to use for the command-line. Helps avoiding
1487 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001488 The value of this option is stored with the tab page, so that each tab
1489 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001490
1491 *'cmdwinheight'* *'cwh'*
1492'cmdwinheight' 'cwh' number (default 7)
1493 global
1494 {not in Vi}
1495 {not available when compiled without the |+vertsplit|
1496 feature}
1497 Number of screen lines to use for the command-line window. |cmdwin|
1498
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001499 *'colorcolumn'* *'cc'*
1500'colorcolumn' 'cc' string (default "")
1501 local to window
1502 {not in Vi}
1503 {not available when compiled without the |+syntax|
1504 feature}
1505 'colorcolumn' is a comma separated list of screen columns that are
1506 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1507 text. Will make screen redrawing slower.
1508 The screen column can be an absolute number, or a number preceded with
1509 '+' or '-', which is added to or subtracted from 'textwidth'. >
1510
1511 :set cc=+1 " highlight column after 'textwidth'
1512 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1513 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1514<
1515 When 'textwidth' is zero then the items with '-' and '+' are not used.
1516 A maximum of 256 columns are highlighted.
1517
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 *'columns'* *'co'* *E594*
1519'columns' 'co' number (default 80 or terminal width)
1520 global
1521 {not in Vi}
1522 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001523 initialization and does not have to be set by hand. Also see
1524 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001525 When Vim is running in the GUI or in a resizable window, setting this
1526 option will cause the window size to be changed. When you only want
1527 to use the size for the GUI, put the command in your |gvimrc| file.
1528 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001529 number of columns of the display, the display may be messed up. For
1530 the GUI it is always possible and Vim limits the number of columns to
1531 what fits on the screen. You can use this command to get the widest
1532 window possible: >
1533 :set columns=9999
1534< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001535
1536 *'comments'* *'com'* *E524* *E525*
1537'comments' 'com' string (default
1538 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1539 local to buffer
1540 {not in Vi}
1541 {not available when compiled without the |+comments|
1542 feature}
1543 A comma separated list of strings that can start a comment line. See
1544 |format-comments|. See |option-backslash| about using backslashes to
1545 insert a space.
1546
1547 *'commentstring'* *'cms'* *E537*
1548'commentstring' 'cms' string (default "/*%s*/")
1549 local to buffer
1550 {not in Vi}
1551 {not available when compiled without the |+folding|
1552 feature}
1553 A template for a comment. The "%s" in the value is replaced with the
1554 comment text. Currently only used to add markers for folding, see
1555 |fold-marker|.
1556
1557 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001558'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1559 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001560 global
1561 {not in Vi}
1562 This option has the effect of making Vim either more Vi-compatible, or
1563 make Vim behave in a more useful way.
1564 This is a special kind of option, because when it's set or reset,
1565 other options are also changed as a side effect. CAREFUL: Setting or
1566 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001567 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001568 set this option in your vimrc file, you should probably put it at the
1569 very start.
1570 By default this option is on and the Vi defaults are used for the
1571 options. This default was chosen for those people who want to use Vim
1572 just like Vi, and don't even (want to) know about the 'compatible'
1573 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001574 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001575 this option is switched off, and all options that have not been
1576 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001577 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001578 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001579 happen for the system-wide vimrc or gvimrc file, nor for a file given
1580 with the |-u| argument). Also see |compatible-default| and
1581 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 You can also set this option with the "-C" argument, and reset it with
1583 "-N". See |-C| and |-N|.
1584 Switching this option off makes the Vim defaults be used for options
1585 that have a different Vi and Vim default value. See the options
1586 marked with a '+' below. Other options are not modified.
1587 At the moment this option is set, several other options will be set
1588 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001589 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001590 editing.
1591 See also 'cpoptions'.
1592
1593 option + set value effect ~
1594
1595 'allowrevins' off no CTRL-_ command
1596 'backupcopy' Unix: "yes" backup file is a copy
1597 others: "auto" copy or rename backup file
1598 'backspace' "" normal backspace
1599 'backup' off no backup file
1600 'cindent' off no C code indentation
1601 'cedit' + "" no key to open the |cmdwin|
1602 'cpoptions' + (all flags) Vi-compatible flags
1603 'cscopetag' off don't use cscope for ":tag"
1604 'cscopetagorder' 0 see |cscopetagorder|
1605 'cscopeverbose' off see |cscopeverbose|
1606 'digraph' off no digraphs
1607 'esckeys' + off no <Esc>-keys in Insert mode
1608 'expandtab' off tabs not expanded to spaces
1609 'fileformats' + "" no automatic file format detection,
1610 "dos,unix" except for DOS, Windows and OS/2
1611 'formatoptions' + "vt" Vi compatible formatting
1612 'gdefault' off no default 'g' flag for ":s"
1613 'history' + 0 no commandline history
1614 'hkmap' off no Hebrew keyboard mapping
1615 'hkmapp' off no phonetic Hebrew keyboard mapping
1616 'hlsearch' off no highlighting of search matches
1617 'incsearch' off no incremental searching
1618 'indentexpr' "" no indenting by expression
1619 'insertmode' off do not start in Insert mode
1620 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1621 characters and '_'
1622 'joinspaces' on insert 2 spaces after period
1623 'modeline' + off no modelines
1624 'more' + off no pauses in listings
1625 'revins' off no reverse insert
1626 'ruler' off no ruler
1627 'scrolljump' 1 no jump scroll
1628 'scrolloff' 0 no scroll offset
1629 'shiftround' off indent not rounded to shiftwidth
1630 'shortmess' + "" no shortening of messages
1631 'showcmd' + off command characters not shown
1632 'showmode' + off current mode not shown
1633 'smartcase' off no automatic ignore case switch
1634 'smartindent' off no smart indentation
1635 'smarttab' off no smart tab size
1636 'softtabstop' 0 tabs are always 'tabstop' positions
1637 'startofline' on goto startofline with some commands
1638 'tagrelative' + off tag file names are not relative
1639 'textauto' + off no automatic textmode detection
1640 'textwidth' 0 no automatic line wrap
1641 'tildeop' off tilde is not an operator
1642 'ttimeout' off no terminal timeout
1643 'whichwrap' + "" left-right movements don't wrap
1644 'wildchar' + CTRL-E only when the current value is <Tab>
1645 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001646 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647
1648 *'complete'* *'cpt'* *E535*
1649'complete' 'cpt' string (default: ".,w,b,u,t,i")
1650 local to buffer
1651 {not in Vi}
1652 This option specifies how keyword completion |ins-completion| works
1653 when CTRL-P or CTRL-N are used. It is also used for whole-line
1654 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1655 and the places to scan. It is a comma separated list of flags:
1656 . scan the current buffer ('wrapscan' is ignored)
1657 w scan buffers from other windows
1658 b scan other loaded buffers that are in the buffer list
1659 u scan the unloaded buffers that are in the buffer list
1660 U scan the buffers that are not in the buffer list
1661 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001662 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001663 k{dict} scan the file {dict}. Several "k" flags can be given,
1664 patterns are valid too. For example: >
1665 :set cpt=k/usr/dict/*,k~/spanish
1666< s scan the files given with the 'thesaurus' option
1667 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1668 are valid too.
1669 i scan current and included files
1670 d scan current and included files for defined name or macro
1671 |i_CTRL-X_CTRL-D|
1672 ] tag completion
1673 t same as "]"
1674
1675 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1676 not executed, this may lead to unexpected completions from some files
1677 (gzipped files for example). Unloaded buffers are not scanned for
1678 whole-line completion.
1679
1680 The default is ".,w,b,u,t,i", which means to scan:
1681 1. the current buffer
1682 2. buffers in other windows
1683 3. other loaded buffers
1684 4. unloaded buffers
1685 5. tags
1686 6. included files
1687
1688 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001689 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1690 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001691
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001692 *'completefunc'* *'cfu'*
1693'completefunc' 'cfu' string (default: empty)
1694 local to buffer
1695 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001696 {not available when compiled without the |+eval|
1697 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001698 This option specifies a function to be used for Insert mode completion
1699 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001700 See |complete-functions| for an explanation of how the function is
1701 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001702 This option cannot be set from a |modeline| or in the |sandbox|, for
1703 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001704
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001705 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001706'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001707 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001708 {not available when compiled without the
1709 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001710 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001711 A comma separated list of options for Insert mode completion
1712 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001713
1714 menu Use a popup menu to show the possible completions. The
1715 menu is only shown when there is more than one match and
1716 sufficient colors are available. |ins-completion-menu|
1717
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001718 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001719 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001720 match, e.g., what file it comes from.
1721
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001722 longest Only insert the longest common text of the matches. If
1723 the menu is displayed you can use CTRL-L to add more
1724 characters. Whether case is ignored depends on the kind
1725 of completion. For buffer text the 'ignorecase' option is
1726 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001727
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001728 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001729 completion in the preview window. Only works in
1730 combination with "menu" or "menuone".
1731
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001732
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001733 *'concealcursor'* *'cocu'*
1734'concealcursor' 'cocu' string (default: "")
1735 local to window
1736 {not in Vi}
1737 {not available when compiled without the |+conceal|
1738 feature}
1739 Sets the modes in which text in the cursor line can also be concealed.
1740 When the current mode is listed then concealing happens just like in
1741 other lines.
1742 n Normal mode
1743 v Visual mode
1744 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001745 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001746
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001747 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001748 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001749 are moving around text is concealed, but when starting to insert text
1750 or selecting a Visual area the concealed text is displayed, so that
1751 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001752 Keep in mind that the cursor position is not always where it's
1753 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001754
1755
1756'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001757 number (default 0)
1758 local to window
1759 {not in Vi}
1760 {not available when compiled without the |+conceal|
1761 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001762 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1763 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001764
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001765 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001766 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001767 1 Each block of concealed text is replaced with one
1768 character. If the syntax item does not have a custom
1769 replacement character defined (see |:syn-cchar|) the
1770 character defined in 'listchars' is used (default is a
1771 space).
1772 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001773 2 Concealed text is completely hidden unless it has a
1774 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001775 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001776 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001777
Bram Moolenaara7781e02010-07-19 20:13:22 +02001778 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001779 edit and copy the text. This can be changed with the 'concealcursor'
1780 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001781
Bram Moolenaar071d4272004-06-13 20:20:40 +00001782 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1783'confirm' 'cf' boolean (default off)
1784 global
1785 {not in Vi}
1786 When 'confirm' is on, certain operations that would normally
1787 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1788 instead raise a |dialog| asking if you wish to save the current
1789 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1790 If 'confirm' is off you can still activate confirmation for one
1791 command only (this is most useful in mappings) with the |:confirm|
1792 command.
1793 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1794
1795 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1796'conskey' 'consk' boolean (default off)
1797 global
1798 {not in Vi} {only for MS-DOS}
1799 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001800 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001801 three methods of console input are available:
1802 'conskey' 'bioskey' action ~
1803 on on or off direct console input
1804 off on BIOS
1805 off off STDIN
1806
1807 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1808'copyindent' 'ci' boolean (default off)
1809 local to buffer
1810 {not in Vi}
1811 Copy the structure of the existing lines indent when autoindenting a
1812 new line. Normally the new indent is reconstructed by a series of
1813 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1814 in which case only spaces are used). Enabling this option makes the
1815 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001816 existing line. 'expandtab' has no effect on these characters, a Tab
1817 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001818 line, the remaining space is filled in the normal manner.
1819 NOTE: 'copyindent' is reset when 'compatible' is set.
1820 Also see 'preserveindent'.
1821
1822 *'cpoptions'* *'cpo'*
1823'cpoptions' 'cpo' string (Vim default: "aABceFs",
1824 Vi default: all flags)
1825 global
1826 {not in Vi}
1827 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001828 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001829 not being vi-compatible is mostly or sometimes preferred.
1830 'cpoptions' stands for "compatible-options".
1831 Commas can be added for readability.
1832 To avoid problems with flags that are added in the future, use the
1833 "+=" and "-=" feature of ":set" |add-option-flags|.
1834 NOTE: This option is set to the Vi default value when 'compatible' is
1835 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001836 NOTE: This option is set to the POSIX default value at startup when
1837 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001838 variable exists |posix|. This means Vim tries to behave like the
1839 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001840
1841 contains behavior ~
1842 *cpo-a*
1843 a When included, a ":read" command with a file name
1844 argument will set the alternate file name for the
1845 current window.
1846 *cpo-A*
1847 A When included, a ":write" command with a file name
1848 argument will set the alternate file name for the
1849 current window.
1850 *cpo-b*
1851 b "\|" in a ":map" command is recognized as the end of
1852 the map command. The '\' is included in the mapping,
1853 the text after the '|' is interpreted as the next
1854 command. Use a CTRL-V instead of a backslash to
1855 include the '|' in the mapping. Applies to all
1856 mapping, abbreviation, menu and autocmd commands.
1857 See also |map_bar|.
1858 *cpo-B*
1859 B A backslash has no special meaning in mappings,
1860 abbreviations and the "to" part of the menu commands.
1861 Remove this flag to be able to use a backslash like a
1862 CTRL-V. For example, the command ":map X \<Esc>"
1863 results in X being mapped to:
1864 'B' included: "\^[" (^[ is a real <Esc>)
1865 'B' excluded: "<Esc>" (5 characters)
1866 ('<' excluded in both cases)
1867 *cpo-c*
1868 c Searching continues at the end of any match at the
1869 cursor position, but not further than the start of the
1870 next line. When not present searching continues
1871 one character from the cursor position. With 'c'
1872 "abababababab" only gets three matches when repeating
1873 "/abab", without 'c' there are five matches.
1874 *cpo-C*
1875 C Do not concatenate sourced lines that start with a
1876 backslash. See |line-continuation|.
1877 *cpo-d*
1878 d Using "./" in the 'tags' option doesn't mean to use
1879 the tags file relative to the current file, but the
1880 tags file in the current directory.
1881 *cpo-D*
1882 D Can't use CTRL-K to enter a digraph after Normal mode
1883 commands with a character argument, like |r|, |f| and
1884 |t|.
1885 *cpo-e*
1886 e When executing a register with ":@r", always add a
1887 <CR> to the last line, also when the register is not
1888 linewise. If this flag is not present, the register
1889 is not linewise and the last line does not end in a
1890 <CR>, then the last line is put on the command-line
1891 and can be edited before hitting <CR>.
1892 *cpo-E*
1893 E It is an error when using "y", "d", "c", "g~", "gu" or
1894 "gU" on an Empty region. The operators only work when
1895 at least one character is to be operate on. Example:
1896 This makes "y0" fail in the first column.
1897 *cpo-f*
1898 f When included, a ":read" command with a file name
1899 argument will set the file name for the current buffer,
1900 if the current buffer doesn't have a file name yet.
1901 *cpo-F*
1902 F When included, a ":write" command with a file name
1903 argument will set the file name for the current
1904 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001905 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001906 *cpo-g*
1907 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001908 *cpo-H*
1909 H When using "I" on a line with only blanks, insert
1910 before the last blank. Without this flag insert after
1911 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001912 *cpo-i*
1913 i When included, interrupting the reading of a file will
1914 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001915 *cpo-I*
1916 I When moving the cursor up or down just after inserting
1917 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001918 *cpo-j*
1919 j When joining lines, only add two spaces after a '.',
1920 not after '!' or '?'. Also see 'joinspaces'.
1921 *cpo-J*
1922 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001923 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001924 white space.
1925 *cpo-k*
1926 k Disable the recognition of raw key codes in
1927 mappings, abbreviations, and the "to" part of menu
1928 commands. For example, if <Key> sends ^[OA (where ^[
1929 is <Esc>), the command ":map X ^[OA" results in X
1930 being mapped to:
1931 'k' included: "^[OA" (3 characters)
1932 'k' excluded: "<Key>" (one key code)
1933 Also see the '<' flag below.
1934 *cpo-K*
1935 K Don't wait for a key code to complete when it is
1936 halfway a mapping. This breaks mapping <F1><F1> when
1937 only part of the second <F1> has been read. It
1938 enables cancelling the mapping by typing <F1><Esc>.
1939 *cpo-l*
1940 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001941 literally, only "\]", "\^", "\-" and "\\" are special.
1942 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001943 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1944 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001945 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001946 *cpo-L*
1947 L When the 'list' option is set, 'wrapmargin',
1948 'textwidth', 'softtabstop' and Virtual Replace mode
1949 (see |gR|) count a <Tab> as two characters, instead of
1950 the normal behavior of a <Tab>.
1951 *cpo-m*
1952 m When included, a showmatch will always wait half a
1953 second. When not included, a showmatch will wait half
1954 a second or until a character is typed. |'showmatch'|
1955 *cpo-M*
1956 M When excluded, "%" matching will take backslashes into
1957 account. Thus in "( \( )" and "\( ( \)" the outer
1958 parenthesis match. When included "%" ignores
1959 backslashes, which is Vi compatible.
1960 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001961 n When included, the column used for 'number' and
1962 'relativenumber' will also be used for text of wrapped
1963 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001964 *cpo-o*
1965 o Line offset to search command is not remembered for
1966 next search.
1967 *cpo-O*
1968 O Don't complain if a file is being overwritten, even
1969 when it didn't exist when editing it. This is a
1970 protection against a file unexpectedly created by
1971 someone else. Vi didn't complain about this.
1972 *cpo-p*
1973 p Vi compatible Lisp indenting. When not present, a
1974 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001975 *cpo-P*
1976 P When included, a ":write" command that appends to a
1977 file will set the file name for the current buffer, if
1978 the current buffer doesn't have a file name yet and
1979 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001980 *cpo-q*
1981 q When joining multiple lines leave the cursor at the
1982 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001983 *cpo-r*
1984 r Redo ("." command) uses "/" to repeat a search
1985 command, instead of the actually used search string.
1986 *cpo-R*
1987 R Remove marks from filtered lines. Without this flag
1988 marks are kept like |:keepmarks| was used.
1989 *cpo-s*
1990 s Set buffer options when entering the buffer for the
1991 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001992 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001993 set when the buffer is created.
1994 *cpo-S*
1995 S Set buffer options always when entering a buffer
1996 (except 'readonly', 'fileformat', 'filetype' and
1997 'syntax'). This is the (most) Vi compatible setting.
1998 The options are set to the values in the current
1999 buffer. When you change an option and go to another
2000 buffer, the value is copied. Effectively makes the
2001 buffer options global to all buffers.
2002
2003 's' 'S' copy buffer options
2004 no no when buffer created
2005 yes no when buffer first entered (default)
2006 X yes each time when buffer entered (vi comp.)
2007 *cpo-t*
2008 t Search pattern for the tag command is remembered for
2009 "n" command. Otherwise Vim only puts the pattern in
2010 the history for search pattern, but doesn't change the
2011 last used search pattern.
2012 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002013 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002014 *cpo-v*
2015 v Backspaced characters remain visible on the screen in
2016 Insert mode. Without this flag the characters are
2017 erased from the screen right away. With this flag the
2018 screen newly typed text overwrites backspaced
2019 characters.
2020 *cpo-w*
2021 w When using "cw" on a blank character, only change one
2022 character and not all blanks until the start of the
2023 next word.
2024 *cpo-W*
2025 W Don't overwrite a readonly file. When omitted, ":w!"
2026 overwrites a readonly file, if possible.
2027 *cpo-x*
2028 x <Esc> on the command-line executes the command-line.
2029 The default in Vim is to abandon the command-line,
2030 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002031 *cpo-X*
2032 X When using a count with "R" the replaced text is
2033 deleted only once. Also when repeating "R" with "."
2034 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 *cpo-y*
2036 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002037 *cpo-Z*
2038 Z When using "w!" while the 'readonly' option is set,
2039 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002040 *cpo-!*
2041 ! When redoing a filter command, use the last used
2042 external command, whatever it was. Otherwise the last
2043 used -filter- command is used.
2044 *cpo-$*
2045 $ When making a change to one line, don't redisplay the
2046 line, but put a '$' at the end of the changed text.
2047 The changed text will be overwritten when you type the
2048 new text. The line is redisplayed if you type any
2049 command that moves the cursor from the insertion
2050 point.
2051 *cpo-%*
2052 % Vi-compatible matching is done for the "%" command.
2053 Does not recognize "#if", "#endif", etc.
2054 Does not recognize "/*" and "*/".
2055 Parens inside single and double quotes are also
2056 counted, causing a string that contains a paren to
2057 disturb the matching. For example, in a line like
2058 "if (strcmp("foo(", s))" the first paren does not
2059 match the last one. When this flag is not included,
2060 parens inside single and double quotes are treated
2061 specially. When matching a paren outside of quotes,
2062 everything inside quotes is ignored. When matching a
2063 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002064 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002065 This flag is also used for other features, such as
2066 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002067 *cpo--*
2068 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002069 it would go above the first line or below the last
2070 line. Without it the cursor moves to the first or
2071 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002072 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002073 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002074 *cpo-+*
2075 + When included, a ":write file" command will reset the
2076 'modified' flag of the buffer, even though the buffer
2077 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002078 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002079 * Use ":*" in the same way as ":@". When not included,
2080 ":*" is an alias for ":'<,'>", select the Visual area.
2081 *cpo-<*
2082 < Disable the recognition of special key codes in |<>|
2083 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002084 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002085 ":map X <Tab>" results in X being mapped to:
2086 '<' included: "<Tab>" (5 characters)
2087 '<' excluded: "^I" (^I is a real <Tab>)
2088 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002089 *cpo->*
2090 > When appending to a register, put a line break before
2091 the appended text.
2092
2093 POSIX flags. These are not included in the Vi default value, except
2094 when $VIM_POSIX was set on startup. |posix|
2095
2096 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002097 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002098 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002099 *cpo-&*
2100 & When ":preserve" was used keep the swap file when
2101 exiting normally while this buffer is still loaded.
2102 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002103 *cpo-\*
2104 \ Backslash in a [] range in a search pattern is taken
2105 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002106 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2107 '\' excluded: "/[ \-]" finds <Space> and '-'
2108 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002109 *cpo-/*
2110 / When "%" is used as the replacement string in a |:s|
2111 command, use the previous replacement string. |:s%|
2112 *cpo-{*
2113 { The |{| and |}| commands also stop at a "{" character
2114 at the start of a line.
2115 *cpo-.*
2116 . The ":chdir" and ":cd" commands fail if the current
2117 buffer is modified, unless ! is used. Vim doesn't
2118 need this, since it remembers the full path of an
2119 opened file.
2120 *cpo-bar*
2121 | The value of the $LINES and $COLUMNS environment
2122 variables overrule the terminal size values obtained
2123 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002124
Bram Moolenaar071d4272004-06-13 20:20:40 +00002125
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002126 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002127'cryptmethod' string (default "zip")
2128 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002129 {not in Vi}
2130 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002131 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002132 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002133 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002134 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002135 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002136 or later, files can NOT be read by Vim 7.2 and older.
2137 This adds a "seed" to the file, every time you write
2138 the file the encrypted bytes will be different.
2139
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002140 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002141 to the detected method of the file being read. Thus if you write it
2142 without changing 'cryptmethod' the same method will be used.
2143 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002144 explicitly write it, you don't get a warning unless there are other
2145 modifications. Also see |:X|.
2146
2147 When setting the global value to an empty string, it will end up with
2148 the value "zip". When setting the local value to an empty string the
2149 buffer will use the global value.
2150
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002151 When a new encryption method is added in a later version of Vim, and
2152 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002153 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002154
2155
Bram Moolenaar071d4272004-06-13 20:20:40 +00002156 *'cscopepathcomp'* *'cspc'*
2157'cscopepathcomp' 'cspc' number (default 0)
2158 global
2159 {not available when compiled without the |+cscope|
2160 feature}
2161 {not in Vi}
2162 Determines how many components of the path to show in a list of tags.
2163 See |cscopepathcomp|.
2164
2165 *'cscopeprg'* *'csprg'*
2166'cscopeprg' 'csprg' string (default "cscope")
2167 global
2168 {not available when compiled without the |+cscope|
2169 feature}
2170 {not in Vi}
2171 Specifies the command to execute cscope. See |cscopeprg|.
2172 This option cannot be set from a |modeline| or in the |sandbox|, for
2173 security reasons.
2174
2175 *'cscopequickfix'* *'csqf'*
2176'cscopequickfix' 'csqf' string (default "")
2177 global
2178 {not available when compiled without the |+cscope|
2179 or |+quickfix| features}
2180 {not in Vi}
2181 Specifies whether to use quickfix window to show cscope results.
2182 See |cscopequickfix|.
2183
2184 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2185'cscopetag' 'cst' boolean (default off)
2186 global
2187 {not available when compiled without the |+cscope|
2188 feature}
2189 {not in Vi}
2190 Use cscope for tag commands. See |cscope-options|.
2191 NOTE: This option is reset when 'compatible' is set.
2192
2193 *'cscopetagorder'* *'csto'*
2194'cscopetagorder' 'csto' number (default 0)
2195 global
2196 {not available when compiled without the |+cscope|
2197 feature}
2198 {not in Vi}
2199 Determines the order in which ":cstag" performs a search. See
2200 |cscopetagorder|.
2201 NOTE: This option is set to 0 when 'compatible' is set.
2202
2203 *'cscopeverbose'* *'csverb'*
2204 *'nocscopeverbose'* *'nocsverb'*
2205'cscopeverbose' 'csverb' boolean (default off)
2206 global
2207 {not available when compiled without the |+cscope|
2208 feature}
2209 {not in Vi}
2210 Give messages when adding a cscope database. See |cscopeverbose|.
2211 NOTE: This option is reset when 'compatible' is set.
2212
Bram Moolenaar860cae12010-06-05 23:22:07 +02002213 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2214'cursorbind' 'crb' boolean (default off)
2215 local to window
2216 {not in Vi}
2217 {not available when compiled without the |+cursorbind|
2218 feature}
2219 When this option is set, as the cursor in the current
2220 window moves other cursorbound windows (windows that also have
2221 this option set) move their cursors to the corresponding line and
2222 column. This option is useful for viewing the
2223 differences between two versions of a file (see 'diff'); in diff mode,
2224 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002225 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002226
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002227
2228 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2229'cursorcolumn' 'cuc' boolean (default off)
2230 local to window
2231 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002232 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002233 feature}
2234 Highlight the screen column of the cursor with CursorColumn
2235 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2236 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002237 If you only want the highlighting in the current window you can use
2238 these autocommands: >
2239 au WinLeave * set nocursorline nocursorcolumn
2240 au WinEnter * set cursorline cursorcolumn
2241<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002242
2243 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2244'cursorline' 'cul' boolean (default off)
2245 local to window
2246 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002247 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002248 feature}
2249 Highlight the screen line of the cursor with CursorLine
2250 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2251 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002252 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002253 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002254
2255
Bram Moolenaar071d4272004-06-13 20:20:40 +00002256 *'debug'*
2257'debug' string (default "")
2258 global
2259 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002260 These values can be used:
2261 msg Error messages that would otherwise be omitted will be given
2262 anyway.
2263 throw Error messages that would otherwise be omitted will be given
2264 anyway and also throw an exception and set |v:errmsg|.
2265 beep A message will be given when otherwise only a beep would be
2266 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002267 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002268 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2269 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002270
2271 *'define'* *'def'*
2272'define' 'def' string (default "^\s*#\s*define")
2273 global or local to buffer |global-local|
2274 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002275 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002276 pattern, just like for the "/" command. This option is used for the
2277 commands like "[i" and "[d" |include-search|. The 'isident' option is
2278 used to recognize the defined name after the match:
2279 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2280 See |option-backslash| about inserting backslashes to include a space
2281 or backslash.
2282 The default value is for C programs. For C++ this value would be
2283 useful, to include const type declarations: >
2284 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2285< When using the ":set" command, you need to double the backslashes!
2286
2287 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2288'delcombine' 'deco' boolean (default off)
2289 global
2290 {not in Vi}
2291 {only available when compiled with the |+multi_byte|
2292 feature}
2293 If editing Unicode and this option is set, backspace and Normal mode
2294 "x" delete each combining character on its own. When it is off (the
2295 default) the character along with its combining characters are
2296 deleted.
2297 Note: When 'delcombine' is set "xx" may work different from "2x"!
2298
2299 This is useful for Arabic, Hebrew and many other languages where one
2300 may have combining characters overtop of base characters, and want
2301 to remove only the combining ones.
2302
2303 *'dictionary'* *'dict'*
2304'dictionary' 'dict' string (default "")
2305 global or local to buffer |global-local|
2306 {not in Vi}
2307 List of file names, separated by commas, that are used to lookup words
2308 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2309 contain a list of words. This can be one word per line, or several
2310 words per line, separated by non-keyword characters (white space is
2311 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002312 When this option is empty, or an entry "spell" is present, spell
2313 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002314 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002315 after a comma are ignored, otherwise spaces are included in the file
2316 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002317 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002318 Where to find a list of words?
2319 - On FreeBSD, there is the file "/usr/share/dict/words".
2320 - In the Simtel archive, look in the "msdos/linguist" directory.
2321 - In "miscfiles" of the GNU collection.
2322 The use of |:set+=| and |:set-=| is preferred when adding or removing
2323 directories from the list. This avoids problems when a future version
2324 uses another default.
2325 Backticks cannot be used in this option for security reasons.
2326
2327 *'diff'* *'nodiff'*
2328'diff' boolean (default off)
2329 local to window
2330 {not in Vi}
2331 {not available when compiled without the |+diff|
2332 feature}
2333 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002334 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002335
2336 *'dex'* *'diffexpr'*
2337'diffexpr' 'dex' string (default "")
2338 global
2339 {not in Vi}
2340 {not available when compiled without the |+diff|
2341 feature}
2342 Expression which is evaluated to obtain an ed-style diff file from two
2343 versions of a file. See |diff-diffexpr|.
2344 This option cannot be set from a |modeline| or in the |sandbox|, for
2345 security reasons.
2346
2347 *'dip'* *'diffopt'*
2348'diffopt' 'dip' string (default "filler")
2349 global
2350 {not in Vi}
2351 {not available when compiled without the |+diff|
2352 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002353 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002354 All are optional. Items must be separated by a comma.
2355
2356 filler Show filler lines, to keep the text
2357 synchronized with a window that has inserted
2358 lines at the same position. Mostly useful
2359 when windows are side-by-side and 'scrollbind'
2360 is set.
2361
2362 context:{n} Use a context of {n} lines between a change
2363 and a fold that contains unchanged lines.
2364 When omitted a context of six lines is used.
2365 See |fold-diff|.
2366
2367 icase Ignore changes in case of text. "a" and "A"
2368 are considered the same. Adds the "-i" flag
2369 to the "diff" command if 'diffexpr' is empty.
2370
2371 iwhite Ignore changes in amount of white space. Adds
2372 the "-b" flag to the "diff" command if
2373 'diffexpr' is empty. Check the documentation
2374 of the "diff" command for what this does
2375 exactly. It should ignore adding trailing
2376 white space, but not leading white space.
2377
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002378 horizontal Start diff mode with horizontal splits (unless
2379 explicitly specified otherwise).
2380
2381 vertical Start diff mode with vertical splits (unless
2382 explicitly specified otherwise).
2383
2384 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2385 starting diff mode. Without this 2 is used.
2386
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 Examples: >
2388
2389 :set diffopt=filler,context:4
2390 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002391 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392<
2393 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2394'digraph' 'dg' boolean (default off)
2395 global
2396 {not in Vi}
2397 {not available when compiled without the |+digraphs|
2398 feature}
2399 Enable the entering of digraphs in Insert mode with {char1} <BS>
2400 {char2}. See |digraphs|.
2401 NOTE: This option is reset when 'compatible' is set.
2402
2403 *'directory'* *'dir'*
2404'directory' 'dir' string (default for Amiga: ".,t:",
2405 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2406 for Unix: ".,~/tmp,/var/tmp,/tmp")
2407 global
2408 List of directory names for the swap file, separated with commas.
2409 - The swap file will be created in the first directory where this is
2410 possible.
2411 - Empty means that no swap file will be used (recovery is
2412 impossible!).
2413 - A directory "." means to put the swap file in the same directory as
2414 the edited file. On Unix, a dot is prepended to the file name, so
2415 it doesn't show in a directory listing. On MS-Windows the "hidden"
2416 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002417 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002418 put the swap file relative to where the edited file is. The leading
2419 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002420 - For Unix and Win32, if a directory ends in two path separators "//"
2421 or "\\", the swap file name will be built from the complete path to
2422 the file with all path separators substituted to percent '%' signs.
2423 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002424 On Win32, when a separating comma is following, you must use "//",
2425 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002426 - Spaces after the comma are ignored, other spaces are considered part
2427 of the directory name. To have a space at the start of a directory
2428 name, precede it with a backslash.
2429 - To include a comma in a directory name precede it with a backslash.
2430 - A directory name may end in an ':' or '/'.
2431 - Environment variables are expanded |:set_env|.
2432 - Careful with '\' characters, type one before a space, type two to
2433 get one in the option (see |option-backslash|), for example: >
2434 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2435< - For backwards compatibility with Vim version 3.0 a '>' at the start
2436 of the option is removed.
2437 Using "." first in the list is recommended. This means that editing
2438 the same file twice will result in a warning. Using "/tmp" on Unix is
2439 discouraged: When the system crashes you lose the swap file.
2440 "/var/tmp" is often not cleared when rebooting, thus is a better
2441 choice than "/tmp". But it can contain a lot of files, your swap
2442 files get lost in the crowd. That is why a "tmp" directory in your
2443 home directory is tried first.
2444 The use of |:set+=| and |:set-=| is preferred when adding or removing
2445 directories from the list. This avoids problems when a future version
2446 uses another default.
2447 This option cannot be set from a |modeline| or in the |sandbox|, for
2448 security reasons.
2449 {Vi: directory to put temp file in, defaults to "/tmp"}
2450
2451 *'display'* *'dy'*
2452'display' 'dy' string (default "")
2453 global
2454 {not in Vi}
2455 Change the way text is displayed. This is comma separated list of
2456 flags:
2457 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002458 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002459 last line that doesn't fit is replaced with "@" lines.
2460 uhex Show unprintable characters hexadecimal as <xx>
2461 instead of using ^C and ~C.
2462
2463 *'eadirection'* *'ead'*
2464'eadirection' 'ead' string (default "both")
2465 global
2466 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002467 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 feature}
2469 Tells when the 'equalalways' option applies:
2470 ver vertically, width of windows is not affected
2471 hor horizontally, height of windows is not affected
2472 both width and height of windows is affected
2473
2474 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2475'edcompatible' 'ed' boolean (default off)
2476 global
2477 Makes the 'g' and 'c' flags of the ":substitute" command to be
2478 toggled each time the flag is given. See |complex-change|. See
2479 also 'gdefault' option.
2480 Switching this option on is discouraged!
2481
2482 *'encoding'* *'enc'* *E543*
2483'encoding' 'enc' string (default: "latin1" or value from $LANG)
2484 global
2485 {only available when compiled with the |+multi_byte|
2486 feature}
2487 {not in Vi}
2488 Sets the character encoding used inside Vim. It applies to text in
2489 the buffers, registers, Strings in expressions, text stored in the
2490 viminfo file, etc. It sets the kind of characters which Vim can work
2491 with. See |encoding-names| for the possible values.
2492
2493 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002494 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002495 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002496 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497
Bram Moolenaar865242e2010-07-14 21:12:05 +02002498 This option cannot be set from a |modeline|. It would most likely
2499 corrupt the text.
2500
Bram Moolenaar071d4272004-06-13 20:20:40 +00002501 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2502 "utf-8". Although care has been taken to allow different values of
2503 'encoding', "utf-8" is the natural choice for the environment and
2504 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002505 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506 versions, and to avoid changing the encoding of newly created files
2507 without your knowledge (in case 'fileencodings' is empty).
2508
2509 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002510 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 iconv() or as specified with 'charconvert'.
2512
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002513 If you need to know whether 'encoding' is a multi-byte encoding, you
2514 can use: >
2515 if has("multi_byte_encoding")
2516<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517 Normally 'encoding' will be equal to your current locale. This will
2518 be the default if Vim recognizes your environment settings. If
2519 'encoding' is not set to the current locale, 'termencoding' must be
2520 set to convert typed and displayed text. See |encoding-table|.
2521
2522 When you set this option, it fires the |EncodingChanged| autocommand
2523 event so that you can set up fonts if necessary.
2524
2525 When the option is set, the value is converted to lowercase. Thus
2526 you can set it with uppercase values too. Underscores are translated
2527 to '-' signs.
2528 When the encoding is recognized, it is changed to the standard name.
2529 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2530 "iso-8859-2" and "utf8" becomes "utf-8".
2531
2532 Note: "latin1" is also used when the encoding could not be detected.
2533 This only works when editing files in the same encoding! When the
2534 actual character set is not latin1, make sure 'fileencoding' and
2535 'fileencodings' are empty. When conversion is needed, switch to using
2536 utf-8.
2537
2538 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2539 You don't notice this while editing, but it does matter for the
2540 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2541 setting 'encoding' to one of these values instead of utf-8 only has
2542 effect for encoding used for files when 'fileencoding' is empty.
2543
Bram Moolenaar661b1822005-07-28 22:36:45 +00002544 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2545 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002546
2547 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2548'endofline' 'eol' boolean (default on)
2549 local to buffer
2550 {not in Vi}
2551 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002552 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 option is automatically set when starting to edit a new file, unless
2554 the file does not have an <EOL> for the last line in the file, in
2555 which case it is reset. Normally you don't have to set or reset this
2556 option. When 'binary' is off the value is not used when writing the
2557 file. When 'binary' is on it is used to remember the presence of a
2558 <EOL> for the last line in the file, so that when you write the file
2559 the situation from the original file can be kept. But you can change
2560 it if you want to.
2561
2562 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2563'equalalways' 'ea' boolean (default on)
2564 global
2565 {not in Vi}
2566 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002567 splitting or closing a window. This also happens the moment the
2568 option is switched on. When off, splitting a window will reduce the
2569 size of the current window and leave the other windows the same. When
2570 closing a window the extra lines are given to the window next to it
2571 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002572 When mixing vertically and horizontally split windows, a minimal size
2573 is computed and some windows may be larger if there is room. The
2574 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002575 Changing the height and width of a window can be avoided by setting
2576 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002577 If a window size is specified when creating a new window sizes are
2578 currently not equalized (it's complicated, but may be implemented in
2579 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002580
2581 *'equalprg'* *'ep'*
2582'equalprg' 'ep' string (default "")
2583 global or local to buffer |global-local|
2584 {not in Vi}
2585 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002586 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002587 or 'indentexpr'. When Vim was compiled without internal formatting,
2588 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002589 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 about including spaces and backslashes.
2591 This option cannot be set from a |modeline| or in the |sandbox|, for
2592 security reasons.
2593
2594 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2595'errorbells' 'eb' boolean (default off)
2596 global
2597 Ring the bell (beep or screen flash) for error messages. This only
2598 makes a difference for error messages, the bell will be used always
2599 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002600 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002601 screen flash or do nothing.
2602
2603 *'errorfile'* *'ef'*
2604'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2605 others: "errors.err")
2606 global
2607 {not in Vi}
2608 {not available when compiled without the |+quickfix|
2609 feature}
2610 Name of the errorfile for the QuickFix mode (see |:cf|).
2611 When the "-q" command-line argument is used, 'errorfile' is set to the
2612 following argument. See |-q|.
2613 NOT used for the ":make" command. See 'makeef' for that.
2614 Environment variables are expanded |:set_env|.
2615 See |option-backslash| about including spaces and backslashes.
2616 This option cannot be set from a |modeline| or in the |sandbox|, for
2617 security reasons.
2618
2619 *'errorformat'* *'efm'*
2620'errorformat' 'efm' string (default is very long)
2621 global or local to buffer |global-local|
2622 {not in Vi}
2623 {not available when compiled without the |+quickfix|
2624 feature}
2625 Scanf-like description of the format for the lines in the error file
2626 (see |errorformat|).
2627
2628 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2629'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2630 global
2631 {not in Vi}
2632 Function keys that start with an <Esc> are recognized in Insert
2633 mode. When this option is off, the cursor and function keys cannot be
2634 used in Insert mode if they start with an <Esc>. The advantage of
2635 this is that the single <Esc> is recognized immediately, instead of
2636 after one second. Instead of resetting this option, you might want to
2637 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2638 when 'esckeys' is off, you can still map anything, but the cursor keys
2639 won't work by default.
2640 NOTE: This option is set to the Vi default value when 'compatible' is
2641 set and to the Vim default value when 'compatible' is reset.
2642
2643 *'eventignore'* *'ei'*
2644'eventignore' 'ei' string (default "")
2645 global
2646 {not in Vi}
2647 {not available when compiled without the |+autocmd|
2648 feature}
2649 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002650 When set to "all" or when "all" is one of the items, all autocommand
2651 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652 Otherwise this is a comma separated list of event names. Example: >
2653 :set ei=WinEnter,WinLeave
2654<
2655 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2656'expandtab' 'et' boolean (default off)
2657 local to buffer
2658 {not in Vi}
2659 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002660 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2662 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2663 NOTE: This option is reset when 'compatible' is set.
2664
2665 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2666'exrc' 'ex' boolean (default off)
2667 global
2668 {not in Vi}
2669 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2670 directory. If you switch this option on you should also consider
2671 setting the 'secure' option (see |initialization|). Using a local
2672 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2673 also see |.vimrc| and |gui-init|.
2674 This option cannot be set from a |modeline| or in the |sandbox|, for
2675 security reasons.
2676
2677 *'fileencoding'* *'fenc'* *E213*
2678'fileencoding' 'fenc' string (default: "")
2679 local to buffer
2680 {only available when compiled with the |+multi_byte|
2681 feature}
2682 {not in Vi}
2683 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002684
Bram Moolenaar071d4272004-06-13 20:20:40 +00002685 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002686 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 When 'fileencoding' is empty, the same value as 'encoding' will be
2688 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002689 Conversion will also be done when 'encoding' and 'fileencoding' are
2690 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2691 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002692 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002693 'encoding' is "utf-8" or another Unicode encoding, conversion
2694 is most likely done in a way that the reverse conversion
2695 results in the same text. When 'encoding' is not "utf-8" some
2696 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002697
Bram Moolenaar071d4272004-06-13 20:20:40 +00002698 See 'encoding' for the possible values. Additionally, values may be
2699 specified that can be handled by the converter, see
2700 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002701
Bram Moolenaar071d4272004-06-13 20:20:40 +00002702 When reading a file 'fileencoding' will be set from 'fileencodings'.
2703 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002704 'fileencoding', use the |++enc| argument. One exception: when
2705 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002706 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002707
Bram Moolenaar071d4272004-06-13 20:20:40 +00002708 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2709 When the option is set, the value is converted to lowercase. Thus
2710 you can set it with uppercase values too. '_' characters are
2711 replaced with '-'. If a name is recognized from the list for
2712 'encoding', it is replaced by the standard name. For example
2713 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002714
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 When this option is set, after starting to edit a file, the 'modified'
2716 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002717
2718 Keep in mind that changing 'fenc' from a modeline happens
2719 AFTER the text has been read, thus it applies to when the file will be
2720 written. If you do set 'fenc' in a modeline, you might want to set
2721 'nomodified' to avoid not being able to ":q".
2722
Bram Moolenaar071d4272004-06-13 20:20:40 +00002723 This option can not be changed when 'modifiable' is off.
2724
2725 *'fe'*
2726 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002727 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002728 old short name was 'fe', which is no longer used.
2729
2730 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002731'fileencodings' 'fencs' string (default: "ucs-bom",
2732 "ucs-bom,utf-8,default,latin1" when
2733 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 global
2735 {only available when compiled with the |+multi_byte|
2736 feature}
2737 {not in Vi}
2738 This is a list of character encodings considered when starting to edit
2739 an existing file. When a file is read, Vim tries to use the first
2740 mentioned character encoding. If an error is detected, the next one
2741 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002742 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 an empty string, which means the value of 'encoding' is used.
2744 WARNING: Conversion can cause loss of information! When
2745 'encoding' is "utf-8" (or one of the other Unicode variants)
2746 conversion is most likely done in a way that the reverse
2747 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002748 "utf-8" some non-ASCII characters may be lost! You can use
2749 the |++bad| argument to specify what is done with characters
2750 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 For an empty file or a file with only ASCII characters most encodings
2752 will work and the first entry of 'fileencodings' will be used (except
2753 "ucs-bom", which requires the BOM to be present). If you prefer
2754 another encoding use an BufReadPost autocommand event to test if your
2755 preferred encoding is to be used. Example: >
2756 au BufReadPost * if search('\S', 'w') == 0 |
2757 \ set fenc=iso-2022-jp | endif
2758< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2759 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002760 When the |++enc| argument is used then the value of 'fileencodings' is
2761 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002762 Note that 'fileencodings' is not used for a new file, the global value
2763 of 'fileencoding' is used instead. You can set it with: >
2764 :setglobal fenc=iso-8859-2
2765< This means that a non-existing file may get a different encoding than
2766 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 The special value "ucs-bom" can be used to check for a Unicode BOM
2768 (Byte Order Mark) at the start of the file. It must not be preceded
2769 by "utf-8" or another Unicode encoding for this to work properly.
2770 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2771 because Vim cannot detect an error, thus the encoding is always
2772 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002773 The special value "default" can be used for the encoding from the
2774 environment. This is the default value for 'encoding'. It is useful
2775 when 'encoding' is set to "utf-8" and your environment uses a
2776 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002777 When 'encoding' is "utf-8" and a file contains an illegal byte
2778 sequence it won't be recognized as UTF-8. You can use the |8g8|
2779 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 WRONG VALUES: WHAT'S WRONG:
2781 latin1,utf-8 "latin1" will always be used
2782 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2783 file
2784 cp1250,latin1 "cp1250" will always be used
2785 If 'fileencodings' is empty, 'fileencoding' is not modified.
2786 See 'fileencoding' for the possible values.
2787 Setting this option does not have an effect until the next time a file
2788 is read.
2789
2790 *'fileformat'* *'ff'*
2791'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2792 Unix default: "unix",
2793 Macintosh default: "mac")
2794 local to buffer
2795 {not in Vi}
2796 This gives the <EOL> of the current buffer, which is used for
2797 reading/writing the buffer from/to a file:
2798 dos <CR> <NL>
2799 unix <NL>
2800 mac <CR>
2801 When "dos" is used, CTRL-Z at the end of a file is ignored.
2802 See |file-formats| and |file-read|.
2803 For the character encoding of the file see 'fileencoding'.
2804 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2805 works like it was set to "unix'.
2806 This option is set automatically when starting to edit a file and
2807 'fileformats' is not empty and 'binary' is off.
2808 When this option is set, after starting to edit a file, the 'modified'
2809 option is set, because the file would be different when written.
2810 This option can not be changed when 'modifiable' is off.
2811 For backwards compatibility: When this option is set to "dos",
2812 'textmode' is set, otherwise 'textmode' is reset.
2813
2814 *'fileformats'* *'ffs'*
2815'fileformats' 'ffs' string (default:
2816 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2817 Vim Unix: "unix,dos",
2818 Vim Mac: "mac,unix,dos",
2819 Vi Cygwin: "unix,dos",
2820 Vi others: "")
2821 global
2822 {not in Vi}
2823 This gives the end-of-line (<EOL>) formats that will be tried when
2824 starting to edit a new buffer and when reading a file into an existing
2825 buffer:
2826 - When empty, the format defined with 'fileformat' will be used
2827 always. It is not set automatically.
2828 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002829 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002830 'fileformats' name will be used when a file is read into an existing
2831 buffer, no matter what 'fileformat' for that buffer is set to.
2832 - When more than one name is present, separated by commas, automatic
2833 <EOL> detection will be done when reading a file. When starting to
2834 edit a file, a check is done for the <EOL>:
2835 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2836 'fileformat' is set to "dos".
2837 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002840 3. If 'fileformat' has not yet been set, and if 'fileformats'
2841 includes "mac", 'fileformat' is set to "mac".
2842 This means that "mac" is only chosen when:
2843 "unix" is not present or no <NL> is found in the file, and
2844 "dos" is not present or no <CR><NL> is found in the file.
2845 Except: if "unix" was chosen, but there is a <CR> before
2846 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002847 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 4. If 'fileformat' is still not set, the first name from
2849 'fileformats' is used.
2850 When reading a file into an existing buffer, the same is done, but
2851 this happens like 'fileformat' has been set appropriately for that
2852 file only, the option is not changed.
2853 When 'binary' is set, the value of 'fileformats' is not used.
2854
2855 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2856 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2857 done:
2858 - When 'fileformats' is empty, there is no automatic detection. Dos
2859 format will be used.
2860 - When 'fileformats' is set to one or more names, automatic detection
2861 is done. This is based on the first <NL> in the file: If there is a
2862 <CR> in front of it, Dos format is used, otherwise Unix format is
2863 used.
2864 Also see |file-formats|.
2865 For backwards compatibility: When this option is set to an empty
2866 string or one format (no comma is included), 'textauto' is reset,
2867 otherwise 'textauto' is set.
2868 NOTE: This option is set to the Vi default value when 'compatible' is
2869 set and to the Vim default value when 'compatible' is reset.
2870
2871 *'filetype'* *'ft'*
2872'filetype' 'ft' string (default: "")
2873 local to buffer
2874 {not in Vi}
2875 {not available when compiled without the |+autocmd|
2876 feature}
2877 When this option is set, the FileType autocommand event is triggered.
2878 All autocommands that match with the value of this option will be
2879 executed. Thus the value of 'filetype' is used in place of the file
2880 name.
2881 Otherwise this option does not always reflect the current file type.
2882 This option is normally set when the file type is detected. To enable
2883 this use the ":filetype on" command. |:filetype|
2884 Setting this option to a different value is most useful in a modeline,
2885 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002886 Example, for in an IDL file:
2887 /* vim: set filetype=idl : */ ~
2888 |FileType| |filetypes|
2889 When a dot appears in the value then this separates two filetype
2890 names. Example:
2891 /* vim: set filetype=c.doxygen : */ ~
2892 This will use the "c" filetype first, then the "doxygen" filetype.
2893 This works both for filetype plugins and for syntax files. More than
2894 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895 Do not confuse this option with 'osfiletype', which is for the file
2896 type that is actually stored with the file.
2897 This option is not copied to another buffer, independent of the 's' or
2898 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002899 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900
2901 *'fillchars'* *'fcs'*
2902'fillchars' 'fcs' string (default "vert:|,fold:-")
2903 global
2904 {not in Vi}
2905 {not available when compiled without the |+windows|
2906 and |+folding| features}
2907 Characters to fill the statuslines and vertical separators.
2908 It is a comma separated list of items:
2909
2910 item default Used for ~
2911 stl:c ' ' or '^' statusline of the current window
2912 stlnc:c ' ' or '-' statusline of the non-current windows
2913 vert:c '|' vertical separators |:vsplit|
2914 fold:c '-' filling 'foldtext'
2915 diff:c '-' deleted lines of the 'diff' option
2916
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002917 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 "stlnc" the space will be used when there is highlighting, '^' or '-'
2919 otherwise.
2920
2921 Example: >
2922 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2923< This is similar to the default, except that these characters will also
2924 be used when there is highlighting.
2925
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002926 for "stl" and "stlnc" only single-byte values are supported.
2927
Bram Moolenaar071d4272004-06-13 20:20:40 +00002928 The highlighting used for these items:
2929 item highlight group ~
2930 stl:c StatusLine |hl-StatusLine|
2931 stlnc:c StatusLineNC |hl-StatusLineNC|
2932 vert:c VertSplit |hl-VertSplit|
2933 fold:c Folded |hl-Folded|
2934 diff:c DiffDelete |hl-DiffDelete|
2935
2936 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2937'fkmap' 'fk' boolean (default off) *E198*
2938 global
2939 {not in Vi}
2940 {only available when compiled with the |+rightleft|
2941 feature}
2942 When on, the keyboard is mapped for the Farsi character set.
2943 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002944 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'foldclose'* *'fcl'*
2947'foldclose' 'fcl' string (default "")
2948 global
2949 {not in Vi}
2950 {not available when compiled without the |+folding|
2951 feature}
2952 When set to "all", a fold is closed when the cursor isn't in it and
2953 its level is higher than 'foldlevel'. Useful if you want folds to
2954 automatically close when moving out of them.
2955
2956 *'foldcolumn'* *'fdc'*
2957'foldcolumn' 'fdc' number (default 0)
2958 local to window
2959 {not in Vi}
2960 {not available when compiled without the |+folding|
2961 feature}
2962 When non-zero, a column with the specified width is shown at the side
2963 of the window which indicates open and closed folds. The maximum
2964 value is 12.
2965 See |folding|.
2966
2967 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2968'foldenable' 'fen' boolean (default on)
2969 local to window
2970 {not in Vi}
2971 {not available when compiled without the |+folding|
2972 feature}
2973 When off, all folds are open. This option can be used to quickly
2974 switch between showing all text unfolded and viewing the text with
2975 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002976 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002977 'foldenable' is off.
2978 This option is set by commands that create a new fold or close a fold.
2979 See |folding|.
2980
2981 *'foldexpr'* *'fde'*
2982'foldexpr' 'fde' string (default: "0")
2983 local to window
2984 {not in Vi}
2985 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002986 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002988 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002989
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002990 The expression may be evaluated in the |sandbox|, see
2991 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002992 This option can't be set from a |modeline| when the 'diff' option is
2993 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002994
2995 It is not allowed to change text or jump to another window while
2996 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002997
2998 *'foldignore'* *'fdi'*
2999'foldignore' 'fdi' string (default: "#")
3000 local to window
3001 {not in Vi}
3002 {not available when compiled without the |+folding|
3003 feature}
3004 Used only when 'foldmethod' is "indent". Lines starting with
3005 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003006 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 The default "#" works well for C programs. See |fold-indent|.
3008
3009 *'foldlevel'* *'fdl'*
3010'foldlevel' 'fdl' number (default: 0)
3011 local to window
3012 {not in Vi}
3013 {not available when compiled without the |+folding|
3014 feature}
3015 Sets the fold level: Folds with a higher level will be closed.
3016 Setting this option to zero will close all folds. Higher numbers will
3017 close fewer folds.
3018 This option is set by commands like |zm|, |zM| and |zR|.
3019 See |fold-foldlevel|.
3020
3021 *'foldlevelstart'* *'fdls'*
3022'foldlevelstart' 'fdls' number (default: -1)
3023 global
3024 {not in Vi}
3025 {not available when compiled without the |+folding|
3026 feature}
3027 Sets 'foldlevel' when starting to edit another buffer in a window.
3028 Useful to always start editing with all folds closed (value zero),
3029 some folds closed (one) or no folds closed (99).
3030 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003031 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 ignores this option and closes all folds.
3033 It is also done before BufReadPre autocommands, to allow an autocmd to
3034 overrule the 'foldlevel' value for specific files.
3035 When the value is negative, it is not used.
3036
3037 *'foldmarker'* *'fmr'* *E536*
3038'foldmarker' 'fmr' string (default: "{{{,}}}")
3039 local to window
3040 {not in Vi}
3041 {not available when compiled without the |+folding|
3042 feature}
3043 The start and end marker used when 'foldmethod' is "marker". There
3044 must be one comma, which separates the start and end marker. The
3045 marker is a literal string (a regular expression would be too slow).
3046 See |fold-marker|.
3047
3048 *'foldmethod'* *'fdm'*
3049'foldmethod' 'fdm' string (default: "manual")
3050 local to window
3051 {not in Vi}
3052 {not available when compiled without the |+folding|
3053 feature}
3054 The kind of folding used for the current window. Possible values:
3055 |fold-manual| manual Folds are created manually.
3056 |fold-indent| indent Lines with equal indent form a fold.
3057 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3058 |fold-marker| marker Markers are used to specify folds.
3059 |fold-syntax| syntax Syntax highlighting items specify folds.
3060 |fold-diff| diff Fold text that is not changed.
3061
3062 *'foldminlines'* *'fml'*
3063'foldminlines' 'fml' number (default: 1)
3064 local to window
3065 {not in Vi}
3066 {not available when compiled without the |+folding|
3067 feature}
3068 Sets the minimum number of screen lines for a fold to be displayed
3069 closed. Also for manually closed folds.
3070 Note that this only has an effect of what is displayed. After using
3071 "zc" to close a fold, which is displayed open because it's smaller
3072 than 'foldminlines', a following "zc" may close a containing fold.
3073
3074 *'foldnestmax'* *'fdn'*
3075'foldnestmax' 'fdn' number (default: 20)
3076 local to window
3077 {not in Vi}
3078 {not available when compiled without the |+folding|
3079 feature}
3080 Sets the maximum nesting of folds for the "indent" and "syntax"
3081 methods. This avoids that too many folds will be created. Using more
3082 than 20 doesn't work, because the internal limit is 20.
3083
3084 *'foldopen'* *'fdo'*
3085'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3086 search,tag,undo")
3087 global
3088 {not in Vi}
3089 {not available when compiled without the |+folding|
3090 feature}
3091 Specifies for which type of commands folds will be opened, if the
3092 command moves the cursor into a closed fold. It is a comma separated
3093 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003094 NOTE: When the command is part of a mapping this option is not used.
3095 Add the |zv| command to the mapping to get the same effect.
3096 (rationale: the mapping may want to control opening folds itself)
3097
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 item commands ~
3099 all any
3100 block "(", "{", "[[", "[{", etc.
3101 hor horizontal movements: "l", "w", "fx", etc.
3102 insert any command in Insert mode
3103 jump far jumps: "G", "gg", etc.
3104 mark jumping to a mark: "'m", CTRL-O, etc.
3105 percent "%"
3106 quickfix ":cn", ":crew", ":make", etc.
3107 search search for a pattern: "/", "n", "*", "gd", etc.
3108 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003109 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 tag jumping to a tag: ":ta", CTRL-T, etc.
3111 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003112 When a movement command is used for an operator (e.g., "dl" or "y%")
3113 this option is not used. This means the operator will include the
3114 whole closed fold.
3115 Note that vertical movements are not here, because it would make it
3116 very difficult to move onto a closed fold.
3117 In insert mode the folds containing the cursor will always be open
3118 when text is inserted.
3119 To close folds you can re-apply 'foldlevel' with the |zx| command or
3120 set the 'foldclose' option to "all".
3121
3122 *'foldtext'* *'fdt'*
3123'foldtext' 'fdt' string (default: "foldtext()")
3124 local to window
3125 {not in Vi}
3126 {not available when compiled without the |+folding|
3127 feature}
3128 An expression which is used to specify the text displayed for a closed
3129 fold. See |fold-foldtext|.
3130
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003131 The expression may be evaluated in the |sandbox|, see
3132 |sandbox-option|.
3133
3134 It is not allowed to change text or jump to another window while
3135 evaluating 'foldtext' |textlock|.
3136
Bram Moolenaar071d4272004-06-13 20:20:40 +00003137 *'formatoptions'* *'fo'*
3138'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3139 local to buffer
3140 {not in Vi}
3141 This is a sequence of letters which describes how automatic
3142 formatting is to be done. See |fo-table|. When the 'paste' option is
3143 on, no formatting is done (like 'formatoptions' is empty). Commas can
3144 be inserted for readability.
3145 To avoid problems with flags that are added in the future, use the
3146 "+=" and "-=" feature of ":set" |add-option-flags|.
3147 NOTE: This option is set to the Vi default value when 'compatible' is
3148 set and to the Vim default value when 'compatible' is reset.
3149
Bram Moolenaar86b68352004-12-27 21:59:20 +00003150 *'formatlistpat'* *'flp'*
3151'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3152 local to buffer
3153 {not in Vi}
3154 A pattern that is used to recognize a list header. This is used for
3155 the "n" flag in 'formatoptions'.
3156 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003157 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003158 while still checking more characters. There must be a character
3159 following the pattern, when it matches the whole line it is handled
3160 like there is no match.
3161 The default recognizes a number, followed by an optional punctuation
3162 character and white space.
3163
Bram Moolenaar071d4272004-06-13 20:20:40 +00003164 *'formatprg'* *'fp'*
3165'formatprg' 'fp' string (default "")
3166 global
3167 {not in Vi}
3168 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003169 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003171 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003172 If the 'formatexpr' option is not empty it will be used instead.
3173 Otherwise, if 'formatprg' option is an empty string, the internal
3174 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003175 Environment variables are expanded |:set_env|. See |option-backslash|
3176 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003177 The expression may be evaluated in the |sandbox|, see
3178 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003180 *'formatexpr'* *'fex'*
3181'formatexpr' 'fex' string (default "")
3182 local to buffer
3183 {not in Vi}
3184 {not available when compiled without the |+eval|
3185 feature}
3186 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003187 operator or automatic formatting (see 'formatoptions'). When this
3188 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003189
3190 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003191 The |v:count| variable holds the number of lines to be formatted.
3192 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003193 inserted if the expression is being evaluated due to
3194 automatic formatting. This can be empty. Don't insert
3195 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003196
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003197 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003198 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003199< This will invoke the mylang#Format() function in the
3200 autoload/mylang.vim file in 'runtimepath'. |autoload|
3201
3202 The expression is also evaluated when 'textwidth' is set and adding
3203 text beyond that limit. This happens under the same conditions as
3204 when internal formatting is used. Make sure the cursor is kept in the
3205 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003206 return "i" or "R" in this situation.
3207
3208 When the expression evaluates to non-zero Vim will fall back to using
3209 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003210
3211 The expression may be evaluated in the |sandbox|, see
3212 |sandbox-option|.
3213
3214 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003215'fsync' 'fs' boolean (default on)
3216 global
3217 {not in Vi}
3218 When on, the library function fsync() will be called after writing a
3219 file. This will flush a file to disk, ensuring that it is safely
3220 written even on filesystems which do metadata-only journaling. This
3221 will force the harddrive to spin up on Linux systems running in laptop
3222 mode, so it may be undesirable in some situations. Be warned that
3223 turning this off increases the chances of data loss after a crash. On
3224 systems without an fsync() implementation, this variable is always
3225 off.
3226 Also see 'swapsync' for controlling fsync() on swap files.
3227
Bram Moolenaar071d4272004-06-13 20:20:40 +00003228 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3229'gdefault' 'gd' boolean (default off)
3230 global
3231 {not in Vi}
3232 When on, the ":substitute" flag 'g' is default on. This means that
3233 all matches in a line are substituted instead of one. When a 'g' flag
3234 is given to a ":substitute" command, this will toggle the substitution
3235 of all or one match. See |complex-change|.
3236
3237 command 'gdefault' on 'gdefault' off ~
3238 :s/// subst. all subst. one
3239 :s///g subst. one subst. all
3240 :s///gg subst. all subst. one
3241
3242 NOTE: This option is reset when 'compatible' is set.
3243
3244 *'grepformat'* *'gfm'*
3245'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3246 global
3247 {not in Vi}
3248 Format to recognize for the ":grep" command output.
3249 This is a scanf-like string that uses the same format as the
3250 'errorformat' option: see |errorformat|.
3251
3252 *'grepprg'* *'gp'*
3253'grepprg' 'gp' string (default "grep -n ",
3254 Unix: "grep -n $* /dev/null",
3255 Win32: "findstr /n" or "grep -n",
3256 VMS: "SEARCH/NUMBERS ")
3257 global or local to buffer |global-local|
3258 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003259 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 and '#' characters, which are expanded like when used in a command-
3261 line. The placeholder "$*" is allowed to specify where the arguments
3262 will be included. Environment variables are expanded |:set_env|. See
3263 |option-backslash| about including spaces and backslashes.
3264 When your "grep" accepts the "-H" argument, use this to make ":grep"
3265 also work well with a single file: >
3266 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003267< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003268 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3269 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003270 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003271 apply equally to 'grepprg'.
3272 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3273 otherwise it's "grep -n".
3274 This option cannot be set from a |modeline| or in the |sandbox|, for
3275 security reasons.
3276
3277 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3278'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3279 ve:ver35-Cursor,
3280 o:hor50-Cursor,
3281 i-ci:ver25-Cursor/lCursor,
3282 r-cr:hor20-Cursor/lCursor,
3283 sm:block-Cursor
3284 -blinkwait175-blinkoff150-blinkon175",
3285 for MS-DOS and Win32 console:
3286 "n-v-c:block,o:hor50,i-ci:hor15,
3287 r-cr:hor30,sm:block")
3288 global
3289 {not in Vi}
3290 {only available when compiled with GUI enabled, and
3291 for MS-DOS and Win32 console}
3292 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003293 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 the height of the cursor can be changed. This can be done by
3295 specifying a block cursor, or a percentage for a vertical or
3296 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003297 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003299 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 mode-list and an argument-list:
3301 mode-list:argument-list,mode-list:argument-list,..
3302 The mode-list is a dash separated list of these modes:
3303 n Normal mode
3304 v Visual mode
3305 ve Visual mode with 'selection' "exclusive" (same as 'v',
3306 if not specified)
3307 o Operator-pending mode
3308 i Insert mode
3309 r Replace mode
3310 c Command-line Normal (append) mode
3311 ci Command-line Insert mode
3312 cr Command-line Replace mode
3313 sm showmatch in Insert mode
3314 a all modes
3315 The argument-list is a dash separated list of these arguments:
3316 hor{N} horizontal bar, {N} percent of the character height
3317 ver{N} vertical bar, {N} percent of the character width
3318 block block cursor, fills the whole character
3319 [only one of the above three should be present]
3320 blinkwait{N} *cursor-blinking*
3321 blinkon{N}
3322 blinkoff{N}
3323 blink times for cursor: blinkwait is the delay before
3324 the cursor starts blinking, blinkon is the time that
3325 the cursor is shown and blinkoff is the time that the
3326 cursor is not shown. The times are in msec. When one
3327 of the numbers is zero, there is no blinking. The
3328 default is: "blinkwait700-blinkon400-blinkoff250".
3329 These numbers are used for a missing entry. This
3330 means that blinking is enabled by default. To switch
3331 blinking off you can use "blinkon0". The cursor only
3332 blinks when Vim is waiting for input, not while
3333 executing a command.
3334 To make the cursor blink in an xterm, see
3335 |xterm-blink|.
3336 {group-name}
3337 a highlight group name, that sets the color and font
3338 for the cursor
3339 {group-name}/{group-name}
3340 Two highlight group names, the first is used when
3341 no language mappings are used, the other when they
3342 are. |language-mapping|
3343
3344 Examples of parts:
3345 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3346 block cursor with colors from the "nCursor"
3347 highlight group
3348 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3349 In Insert and Command-line Insert mode, use a
3350 30% vertical bar cursor with colors from the
3351 "iCursor" highlight group. Blink a bit
3352 faster.
3353
3354 The 'a' mode is different. It will set the given argument-list for
3355 all modes. It does not reset anything to defaults. This can be used
3356 to do a common setting for all modes. For example, to switch off
3357 blinking: "a:blinkon0"
3358
3359 Examples of cursor highlighting: >
3360 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3361 :highlight Cursor gui=NONE guifg=bg guibg=fg
3362<
3363 *'guifont'* *'gfn'*
3364 *E235* *E596* *E610* *E611*
3365'guifont' 'gfn' string (default "")
3366 global
3367 {not in Vi}
3368 {only available when compiled with GUI enabled}
3369 This is a list of fonts which will be used for the GUI version of Vim.
3370 In its simplest form the value is just one font name. When
3371 the font cannot be found you will get an error message. To try other
3372 font names a list can be specified, font names separated with commas.
3373 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003374
Bram Moolenaar05159a02005-02-26 23:04:13 +00003375 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3376 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003377
Bram Moolenaar071d4272004-06-13 20:20:40 +00003378 Spaces after a comma are ignored. To include a comma in a font name
3379 precede it with a backslash. Setting an option requires an extra
3380 backslash before a space and a backslash. See also
3381 |option-backslash|. For example: >
3382 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003383< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003384 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003385
3386 If none of the fonts can be loaded, Vim will keep the current setting.
3387 If an empty font list is given, Vim will try using other resource
3388 settings (for X, it will use the Vim.font resource), and finally it
3389 will try some builtin default which should always be there ("7x13" in
3390 the case of X). The font names given should be "normal" fonts. Vim
3391 will try to find the related bold and italic fonts.
3392
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003393 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003394 :set guifont=*
3395< will bring up a font requester, where you can pick the font you want.
3396
3397 The font name depends on the GUI used. See |setting-guifont| for a
3398 way to set 'guifont' for various systems.
3399
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 For the GTK+ 2 GUI the font name looks like this: >
3401 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003402< That's all. XLFDs are not used. For Chinese this is reported to work
3403 well: >
3404 if has("gui_gtk2")
3405 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3406 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3407 endif
3408<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003409 For Mac OSX you can use something like this: >
3410 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003411< Also see 'macatsui', it can help fix display problems.
3412 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003414 width). An exception is GTK 2: all fonts are accepted, but
3415 mono-spaced fonts look best.
3416
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 To preview a font on X11, you might be able to use the "xfontsel"
3418 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003419
Bram Moolenaar071d4272004-06-13 20:20:40 +00003420 For the Win32 GUI *E244* *E245*
3421 - takes these options in the font name:
3422 hXX - height is XX (points, can be floating-point)
3423 wXX - width is XX (points, can be floating-point)
3424 b - bold
3425 i - italic
3426 u - underline
3427 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003428 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003429 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3430 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3431 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003432 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433
3434 Use a ':' to separate the options.
3435 - A '_' can be used in the place of a space, so you don't need to use
3436 backslashes to escape the spaces.
3437 - Examples: >
3438 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3439 :set guifont=Andale_Mono:h7.5:w4.5
3440< See also |font-sizes|.
3441
3442 *'guifontset'* *'gfs'*
3443 *E250* *E252* *E234* *E597* *E598*
3444'guifontset' 'gfs' string (default "")
3445 global
3446 {not in Vi}
3447 {only available when compiled with GUI enabled and
3448 with the |+xfontset| feature}
3449 {not available in the GTK+ 2 GUI}
3450 When not empty, specifies two (or more) fonts to be used. The first
3451 one for normal English, the second one for your special language. See
3452 |xfontset|.
3453 Setting this option also means that all font names will be handled as
3454 a fontset name. Also the ones used for the "font" argument of the
3455 |:highlight| command.
3456 The fonts must match with the current locale. If fonts for the
3457 character sets that the current locale uses are not included, setting
3458 'guifontset' will fail.
3459 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3460 the comma-separated names are alternative names, one of which will be
3461 used. In 'guifontset' the whole string is one fontset name,
3462 including the commas. It is not possible to specify alternative
3463 fontset names.
3464 This example works on many X11 systems: >
3465 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3466<
3467 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3468'guifontwide' 'gfw' string (default "")
3469 global
3470 {not in Vi}
3471 {only available when compiled with GUI enabled}
3472 When not empty, specifies a comma-separated list of fonts to be used
3473 for double-width characters. The first font that can be loaded is
3474 used.
3475 Note: The size of these fonts must be exactly twice as wide as the one
3476 specified with 'guifont' and the same height.
3477
3478 All GUI versions but GTK+ 2:
3479
3480 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3481 'guifontset' is empty or invalid.
3482 When 'guifont' is set and a valid font is found in it and
3483 'guifontwide' is empty Vim will attempt to find a matching
3484 double-width font and set 'guifontwide' to it.
3485
3486 GTK+ 2 GUI only: *guifontwide_gtk2*
3487
3488 If set and valid, 'guifontwide' is always used for double width
3489 characters, even if 'encoding' is not set to "utf-8".
3490 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003491 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003492 font for characters not available in 'guifont'. Thus you do not need
3493 to set 'guifontwide' at all unless you want to override the choice
3494 made by Pango/Xft.
3495
3496 *'guiheadroom'* *'ghr'*
3497'guiheadroom' 'ghr' number (default 50)
3498 global
3499 {not in Vi} {only for GTK and X11 GUI}
3500 The number of pixels subtracted from the screen height when fitting
3501 the GUI window on the screen. Set this before the GUI is started,
3502 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003503 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 lines will be left for window decorations and other items on the
3505 screen. Set it to a negative value to allow windows taller than the
3506 screen.
3507
3508 *'guioptions'* *'go'*
3509'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003510 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003511 global
3512 {not in Vi}
3513 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003514 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003515 sequence of letters which describes what components and options of the
3516 GUI should be used.
3517 To avoid problems with flags that are added in the future, use the
3518 "+=" and "-=" feature of ":set" |add-option-flags|.
3519
3520 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003521 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 'a' Autoselect: If present, then whenever VISUAL mode is started,
3523 or the Visual area extended, Vim tries to become the owner of
3524 the windowing system's global selection. This means that the
3525 Visually highlighted text is available for pasting into other
3526 applications as well as into Vim itself. When the Visual mode
3527 ends, possibly due to an operation on the text, or when an
3528 application wants to paste the selection, the highlighted text
3529 is automatically yanked into the "* selection register.
3530 Thus the selection is still available for pasting into other
3531 applications after the VISUAL mode has ended.
3532 If not present, then Vim won't become the owner of the
3533 windowing system's global selection unless explicitly told to
3534 by a yank or delete operation for the "* register.
3535 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003536 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003537 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 applies to the modeless selection.
3539
3540 'guioptions' autoselect Visual autoselect modeless ~
3541 "" - -
3542 "a" yes yes
3543 "A" - yes
3544 "aA" yes yes
3545
Bram Moolenaar02467872007-05-06 13:22:01 +00003546 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003547 'c' Use console dialogs instead of popup dialogs for simple
3548 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003549 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003550 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003551 'guitablabel' can be used to change the text in the labels.
3552 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003553 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003554 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003555 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003556 'f' Foreground: Don't use fork() to detach the GUI from the shell
3557 where it was started. Use this for programs that wait for the
3558 editor to finish (e.g., an e-mail program). Alternatively you
3559 can use "gvim -f" or ":gui -f" to start the GUI in the
3560 foreground. |gui-fork|
3561 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003562 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003563 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3565 corner of the window. It's black&white on non-GTK, because of
3566 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003567 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003568 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003569 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003570 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003572 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003573 file is sourced the system menu has already been loaded; the
3574 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003575 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003576 'g' Grey menu items: Make menu items that are not active grey. If
3577 'g' is not included inactive menu items are not shown at all.
3578 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003579 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003580 't' Include tearoff menu items. Currently only works for Win32,
3581 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003582 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003583 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003584 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003585 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003587 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588 'R' Right-hand scrollbar is present when there is a vertically
3589 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003590 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003592 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 'L' Left-hand scrollbar is present when there is a vertically
3594 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003595 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3597 the longest visible line, or on the cursor line if the 'h'
3598 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003599 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003600 'h' Limit horizontal scrollbar size to the length of the cursor
3601 line. Reduces computations. |gui-horiz-scroll|
3602
3603 And yes, you may even have scrollbars on the left AND the right if
3604 you really want to :-). See |gui-scrollbars| for more information.
3605
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003606 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003607 'v' Use a vertical button layout for dialogs. When not included,
3608 a horizontal layout is preferred, but when it doesn't fit a
3609 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003610 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003611 'p' Use Pointer callbacks for X11 GUI. This is required for some
3612 window managers. If the cursor is not blinking or hollow at
3613 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003614 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003615 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003616 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003617 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618
Bram Moolenaar02467872007-05-06 13:22:01 +00003619
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 *'guipty'* *'noguipty'*
3621'guipty' boolean (default on)
3622 global
3623 {not in Vi}
3624 {only available when compiled with GUI enabled}
3625 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3626 I/O to/from shell commands. See |gui-pty|.
3627
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003628 *'guitablabel'* *'gtl'*
3629'guitablabel' 'gtl' string (default empty)
3630 global
3631 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003632 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003633 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003634 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003635 pages line. When empty and when the result is empty Vim will use a
3636 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003637
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003638 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003639 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003640
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003641 Only used when the GUI tab pages line is displayed. 'e' must be
3642 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3643 used.
3644
Bram Moolenaar57657d82006-04-21 22:12:41 +00003645 *'guitabtooltip'* *'gtt'*
3646'guitabtooltip' 'gtt' string (default empty)
3647 global
3648 {not in Vi}
3649 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003650 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003651 When nonempty describes the text to use in a tooltip for the GUI tab
3652 pages line. When empty Vim will use a default tooltip.
3653 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003654 You can include a line break. Simplest method is to use |:let|: >
3655 :let &guitabtooltip = "line one\nline two"
3656<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003657
Bram Moolenaar071d4272004-06-13 20:20:40 +00003658 *'helpfile'* *'hf'*
3659'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3660 (others) "$VIMRUNTIME/doc/help.txt")
3661 global
3662 {not in Vi}
3663 Name of the main help file. All distributed help files should be
3664 placed together in one directory. Additionally, all "doc" directories
3665 in 'runtimepath' will be used.
3666 Environment variables are expanded |:set_env|. For example:
3667 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003668 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 spaces and backslashes.
3670 This option cannot be set from a |modeline| or in the |sandbox|, for
3671 security reasons.
3672
3673 *'helpheight'* *'hh'*
3674'helpheight' 'hh' number (default 20)
3675 global
3676 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003677 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003678 feature}
3679 Minimal initial height of the help window when it is opened with the
3680 ":help" command. The initial height of the help window is half of the
3681 current window, or (when the 'ea' option is on) the same as other
3682 windows. When the height is less than 'helpheight', the height is
3683 set to 'helpheight'. Set to zero to disable.
3684
3685 *'helplang'* *'hlg'*
3686'helplang' 'hlg' string (default: messages language or empty)
3687 global
3688 {only available when compiled with the |+multi_lang|
3689 feature}
3690 {not in Vi}
3691 Comma separated list of languages. Vim will use the first language
3692 for which the desired help can be found. The English help will always
3693 be used as a last resort. You can add "en" to prefer English over
3694 another language, but that will only find tags that exist in that
3695 language and not in the English help.
3696 Example: >
3697 :set helplang=de,it
3698< This will first search German, then Italian and finally English help
3699 files.
3700 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3701 try to find the tag in the current language before using this option.
3702 See |help-translated|.
3703
3704 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3705'hidden' 'hid' boolean (default off)
3706 global
3707 {not in Vi}
3708 When off a buffer is unloaded when it is |abandon|ed. When on a
3709 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3710 displayed in another window, it does not become hidden, of course.
3711 The commands that move through the buffer list sometimes make a buffer
3712 hidden although the 'hidden' option is off: When the buffer is
3713 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003714 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003715 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003716 This option is set for one command with ":hide {command}" |:hide|.
3717 WARNING: It's easy to forget that you have changes in hidden buffers.
3718 Think twice when using ":q!" or ":qa!".
3719
3720 *'highlight'* *'hl'*
3721'highlight' 'hl' string (default (as a single string):
3722 "8:SpecialKey,@:NonText,d:Directory,
3723 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3724 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003725 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003726 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3727 f:Folded,F:FoldColumn,A:DiffAdd,
3728 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003729 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003730 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003731 +:Pmenu,=:PmenuSel,
3732 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003733 global
3734 {not in Vi}
3735 This option can be used to set highlighting mode for various
3736 occasions. It is a comma separated list of character pairs. The
3737 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003738 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3740 |hl-NonText| @ '~' and '@' at the end of the window and
3741 characters from 'showbreak'
3742 |hl-Directory| d directories in CTRL-D listing and other special
3743 things in listings
3744 |hl-ErrorMsg| e error messages
3745 h (obsolete, ignored)
3746 |hl-IncSearch| i 'incsearch' highlighting
3747 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3748 |hl-MoreMsg| m |more-prompt|
3749 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003750 |hl-LineNr| n line number for ":number" and ":#" commands, and
3751 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 |hl-Question| r |hit-enter| prompt and yes/no questions
3753 |hl-StatusLine| s status line of current window |status-line|
3754 |hl-StatusLineNC| S status lines of not-current windows
3755 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3756 |hl-VertSplit| c column used to separate vertically split windows
3757 |hl-Visual| v Visual mode
3758 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3759 Selection" Only X11 Gui's |gui-x11| and
3760 |xterm-clipboard|.
3761 |hl-WarningMsg| w warning messages
3762 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3763 |hl-Folded| f line used for closed folds
3764 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003765 |hl-DiffAdd| A added line in diff mode
3766 |hl-DiffChange| C changed line in diff mode
3767 |hl-DiffDelete| D deleted line in diff mode
3768 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003770 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003771 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003772 |hl-SpellRare| R rare word |spell|
3773 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003774 |hl-Conceal| - the placeholders used for concealed characters
3775 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003776 |hl-Pmenu| + popup menu normal line
3777 |hl-PmenuSel| = popup menu normal line
3778 |hl-PmenuSbar| x popup menu scrollbar
3779 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780
3781 The display modes are:
3782 r reverse (termcap entry "mr" and "me")
3783 i italic (termcap entry "ZH" and "ZR")
3784 b bold (termcap entry "md" and "me")
3785 s standout (termcap entry "so" and "se")
3786 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003787 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 n no highlighting
3789 - no highlighting
3790 : use a highlight group
3791 The default is used for occasions that are not included.
3792 If you want to change what the display modes do, see |dos-colors|
3793 for an example.
3794 When using the ':' display mode, this must be followed by the name of
3795 a highlight group. A highlight group can be used to define any type
3796 of highlighting, including using color. See |:highlight| on how to
3797 define one. The default uses a different group for each occasion.
3798 See |highlight-default| for the default highlight groups.
3799
3800 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3801'hlsearch' 'hls' boolean (default off)
3802 global
3803 {not in Vi}
3804 {not available when compiled without the
3805 |+extra_search| feature}
3806 When there is a previous search pattern, highlight all its matches.
3807 The type of highlighting used can be set with the 'l' occasion in the
3808 'highlight' option. This uses the "Search" highlight group by
3809 default. Note that only the matching text is highlighted, any offsets
3810 are not applied.
3811 See also: 'incsearch' and |:match|.
3812 When you get bored looking at the highlighted matches, you can turn it
3813 off with |:nohlsearch|. As soon as you use a search command, the
3814 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003815 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 When the search pattern can match an end-of-line, Vim will try to
3817 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003818 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003820 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003821 NOTE: This option is reset when 'compatible' is set.
3822
3823 *'history'* *'hi'*
3824'history' 'hi' number (Vim default: 20, Vi default: 0)
3825 global
3826 {not in Vi}
3827 A history of ":" commands, and a history of previous search patterns
3828 are remembered. This option decides how many entries may be stored in
3829 each of these histories (see |cmdline-editing|).
3830 NOTE: This option is set to the Vi default value when 'compatible' is
3831 set and to the Vim default value when 'compatible' is reset.
3832
3833 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3834'hkmap' 'hk' boolean (default off)
3835 global
3836 {not in Vi}
3837 {only available when compiled with the |+rightleft|
3838 feature}
3839 When on, the keyboard is mapped for the Hebrew character set.
3840 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3841 toggle this option. See |rileft.txt|.
3842 NOTE: This option is reset when 'compatible' is set.
3843
3844 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3845'hkmapp' 'hkp' boolean (default off)
3846 global
3847 {not in Vi}
3848 {only available when compiled with the |+rightleft|
3849 feature}
3850 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3851 This is useful if you have a non-Hebrew keyboard.
3852 See |rileft.txt|.
3853 NOTE: This option is reset when 'compatible' is set.
3854
3855 *'icon'* *'noicon'*
3856'icon' boolean (default off, on when title can be restored)
3857 global
3858 {not in Vi}
3859 {not available when compiled without the |+title|
3860 feature}
3861 When on, the icon text of the window will be set to the value of
3862 'iconstring' (if it is not empty), or to the name of the file
3863 currently being edited. Only the last part of the name is used.
3864 Overridden by the 'iconstring' option.
3865 Only works if the terminal supports setting window icons (currently
3866 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3867 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3868 builtin termcap).
3869 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003870 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 X11.
3872
3873 *'iconstring'*
3874'iconstring' string (default "")
3875 global
3876 {not in Vi}
3877 {not available when compiled without the |+title|
3878 feature}
3879 When this option is not empty, it will be used for the icon text of
3880 the window. This happens only when the 'icon' option is on.
3881 Only works if the terminal supports setting window icon text
3882 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3883 Does not work for MS Windows.
3884 When Vim was compiled with HAVE_X11 defined, the original icon will be
3885 restored if possible |X11|.
3886 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003887 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003888 'titlestring' for example settings.
3889 {not available when compiled without the |+statusline| feature}
3890
3891 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3892'ignorecase' 'ic' boolean (default off)
3893 global
3894 Ignore case in search patterns. Also used when searching in the tags
3895 file.
3896 Also see 'smartcase'.
3897 Can be overruled by using "\c" or "\C" in the pattern, see
3898 |/ignorecase|.
3899
3900 *'imactivatekey'* *'imak'*
3901'imactivatekey' 'imak' string (default "")
3902 global
3903 {not in Vi}
3904 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003905 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003906 Specifies the key that your Input Method in X-Windows uses for
3907 activation. When this is specified correctly, vim can fully control
3908 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3909 You can't use this option to change the activation key, the option
3910 tells Vim what the key is.
3911 Format:
3912 [MODIFIER_FLAG-]KEY_STRING
3913
3914 These characters can be used for MODIFIER_FLAG (case is ignored):
3915 S Shift key
3916 L Lock key
3917 C Control key
3918 1 Mod1 key
3919 2 Mod2 key
3920 3 Mod3 key
3921 4 Mod4 key
3922 5 Mod5 key
3923 Combinations are allowed, for example "S-C-space" or "SC-space" are
3924 both shift+ctrl+space.
3925 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3926
3927 Example: >
3928 :set imactivatekey=S-space
3929< "S-space" means shift+space. This is the activation key for kinput2 +
3930 canna (Japanese), and ami (Korean).
3931
3932 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3933'imcmdline' 'imc' boolean (default off)
3934 global
3935 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003936 {only available when compiled with the |+xim|,
3937 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 When set the Input Method is always on when starting to edit a command
3939 line, unless entering a search pattern (see 'imsearch' for that).
3940 Setting this option is useful when your input method allows entering
3941 English characters directly, e.g., when it's used to type accented
3942 characters with dead keys.
3943
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003944 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003945'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3946 global
3947 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003948 {only available when compiled with the |+xim|,
3949 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 When set the Input Method is never used. This is useful to disable
3951 the IM when it doesn't work properly.
3952 Currently this option is on by default for SGI/IRIX machines. This
3953 may change in later releases.
3954
3955 *'iminsert'* *'imi'*
3956'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3957 local to buffer
3958 {not in Vi}
3959 Specifies whether :lmap or an Input Method (IM) is to be used in
3960 Insert mode. Valid values:
3961 0 :lmap is off and IM is off
3962 1 :lmap is ON and IM is off
3963 2 :lmap is off and IM is ON
3964 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3965 or |global-ime|.
3966 To always reset the option to zero when leaving Insert mode with <Esc>
3967 this can be used: >
3968 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3969< This makes :lmap and IM turn off automatically when leaving Insert
3970 mode.
3971 Note that this option changes when using CTRL-^ in Insert mode
3972 |i_CTRL-^|.
3973 The value is set to 1 when setting 'keymap' to a valid keymap name.
3974 It is also used for the argument of commands like "r" and "f".
3975 The value 0 may not work correctly with Athena and Motif with some XIM
3976 methods. Use 'imdisable' to disable XIM then.
3977
3978 *'imsearch'* *'ims'*
3979'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3980 local to buffer
3981 {not in Vi}
3982 Specifies whether :lmap or an Input Method (IM) is to be used when
3983 entering a search pattern. Valid values:
3984 -1 the value of 'iminsert' is used, makes it look like
3985 'iminsert' is also used when typing a search pattern
3986 0 :lmap is off and IM is off
3987 1 :lmap is ON and IM is off
3988 2 :lmap is off and IM is ON
3989 Note that this option changes when using CTRL-^ in Command-line mode
3990 |c_CTRL-^|.
3991 The value is set to 1 when it is not -1 and setting the 'keymap'
3992 option to a valid keymap name.
3993 The value 0 may not work correctly with Athena and Motif with some XIM
3994 methods. Use 'imdisable' to disable XIM then.
3995
3996 *'include'* *'inc'*
3997'include' 'inc' string (default "^\s*#\s*include")
3998 global or local to buffer |global-local|
3999 {not in Vi}
4000 {not available when compiled without the
4001 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004002 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004003 pattern, just like for the "/" command (See |pattern|). The default
4004 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004005 "]I", "[d", etc.
4006 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004007 comes after the matched pattern. But if "\zs" appears in the pattern
4008 then the text matched from "\zs" to the end, or until "\ze" if it
4009 appears, is used as the file name. Use this to include characters
4010 that are not in 'isfname', such as a space. You can then use
4011 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004012 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004013
4014 *'includeexpr'* *'inex'*
4015'includeexpr' 'inex' string (default "")
4016 local to buffer
4017 {not in Vi}
4018 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004019 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004021 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 :set includeexpr=substitute(v:fname,'\\.','/','g')
4023< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004024
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004026 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 Also used for |<cfile>|.
4028
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004029 The expression may be evaluated in the |sandbox|, see
4030 |sandbox-option|.
4031
4032 It is not allowed to change text or jump to another window while
4033 evaluating 'includeexpr' |textlock|.
4034
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4036'incsearch' 'is' boolean (default off)
4037 global
4038 {not in Vi}
4039 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004040 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004041 While typing a search command, show where the pattern, as it was typed
4042 so far, matches. The matched string is highlighted. If the pattern
4043 is invalid or not found, nothing is shown. The screen will be updated
4044 often, this is only useful on fast terminals.
4045 Note that the match will be shown, but the cursor will return to its
4046 original position when no match is found and when pressing <Esc>. You
4047 still need to finish the search command with <Enter> to move the
4048 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004049 When compiled with the |+reltime| feature Vim only searches for about
4050 half a second. With a complicated pattern and/or a lot of text the
4051 match may not be found. This is to avoid that Vim hangs while you
4052 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004053 The highlighting can be set with the 'i' flag in 'highlight'.
4054 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004055 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004056 to the command line. If 'ignorecase' and 'smartcase' are set and the
4057 command line has no uppercase characters, the added character is
4058 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004059 CTRL-R CTRL-W can be used to add the word at the end of the current
4060 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004061 NOTE: This option is reset when 'compatible' is set.
4062
4063 *'indentexpr'* *'inde'*
4064'indentexpr' 'inde' string (default "")
4065 local to buffer
4066 {not in Vi}
4067 {not available when compiled without the |+cindent|
4068 or |+eval| features}
4069 Expression which is evaluated to obtain the proper indent for a line.
4070 It is used when a new line is created, for the |=| operator and
4071 in Insert mode as specified with the 'indentkeys' option.
4072 When this option is not empty, it overrules the 'cindent' and
4073 'smartindent' indenting.
4074 When 'paste' is set this option is not used for indenting.
4075 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004076 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 when the expression is evaluated (but it may be moved around).
4078 The expression must return the number of spaces worth of indent. It
4079 can return "-1" to keep the current indent (this means 'autoindent' is
4080 used for the indent).
4081 Functions useful for computing the indent are |indent()|, |cindent()|
4082 and |lispindent()|.
4083 The evaluation of the expression must not have side effects! It must
4084 not change the text, jump to another window, etc. Afterwards the
4085 cursor position is always restored, thus the cursor may be moved.
4086 Normally this option would be set to call a function: >
4087 :set indentexpr=GetMyIndent()
4088< Error messages will be suppressed, unless the 'debug' option contains
4089 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004090 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 NOTE: This option is made empty when 'compatible' is set.
4092
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004093 The expression may be evaluated in the |sandbox|, see
4094 |sandbox-option|.
4095
4096 It is not allowed to change text or jump to another window while
4097 evaluating 'indentexpr' |textlock|.
4098
4099
Bram Moolenaar071d4272004-06-13 20:20:40 +00004100 *'indentkeys'* *'indk'*
4101'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4102 local to buffer
4103 {not in Vi}
4104 {not available when compiled without the |+cindent|
4105 feature}
4106 A list of keys that, when typed in Insert mode, cause reindenting of
4107 the current line. Only happens if 'indentexpr' isn't empty.
4108 The format is identical to 'cinkeys', see |indentkeys-format|.
4109 See |C-indenting| and |indent-expression|.
4110
4111 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4112'infercase' 'inf' boolean (default off)
4113 local to buffer
4114 {not in Vi}
4115 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004116 'ignorecase' is also on, the case of the match is adjusted depending
4117 on the typed text. If the typed text contains a lowercase letter
4118 where the match has an upper case letter, the completed part is made
4119 lowercase. If the typed text has no lowercase letters and the match
4120 has a lowercase letter where the typed text has an uppercase letter,
4121 and there is a letter before it, the completed part is made uppercase.
4122 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004123
4124 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4125'insertmode' 'im' boolean (default off)
4126 global
4127 {not in Vi}
4128 Makes Vim work in a way that Insert mode is the default mode. Useful
4129 if you want to use Vim as a modeless editor. Used for |evim|.
4130 These Insert mode commands will be useful:
4131 - Use the cursor keys to move around.
4132 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4133 this is a mapping, it is executed as if 'insertmode' was off.
4134 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004135 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004136 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4137 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004138
4139 These items change when 'insertmode' is set:
4140 - when starting to edit of a file, Vim goes to Insert mode.
4141 - <Esc> in Insert mode is a no-op and beeps.
4142 - <Esc> in Normal mode makes Vim go to Insert mode.
4143 - CTRL-L in Insert mode is a command, it is not inserted.
4144 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4145 However, when <Esc> is used inside a mapping, it behaves like
4146 'insertmode' was not set. This was done to be able to use the same
4147 mappings with 'insertmode' set or not set.
4148 When executing commands with |:normal| 'insertmode' is not used.
4149
4150 NOTE: This option is reset when 'compatible' is set.
4151
4152 *'isfname'* *'isf'*
4153'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4154 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4155 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4156 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4157 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4158 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4159 global
4160 {not in Vi}
4161 The characters specified by this option are included in file names and
4162 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004163 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004164 Multi-byte characters 256 and above are always included, only the
4165 characters up to 255 are specified with this option.
4166 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004167 Think twice before adding white space to this option. Although a
4168 space may appear inside a file name, the effect will be that Vim
4169 doesn't know where a file name starts or ends when doing completion.
4170 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171
4172 Note that on systems using a backslash as path separator, Vim tries to
4173 do its best to make it work as you would expect. That is a bit
4174 tricky, since Vi originally used the backslash to escape special
4175 characters. Vim will not remove a backslash in front of a normal file
4176 name character on these systems, but it will on Unix and alikes. The
4177 '&' and '^' are not included by default, because these are special for
4178 cmd.exe.
4179
4180 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004181 Each part can be a single character number or a range. A range is two
4182 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183 decimal number between 0 and 255 or the ASCII character itself (does
4184 not work for digits). Example:
4185 "_,-,128-140,#-43" (include '_' and '-' and the range
4186 128 to 140 and '#' to 43)
4187 If a part starts with '^', the following character number or range
4188 will be excluded from the option. The option is interpreted from left
4189 to right. Put the excluded character after the range where it is
4190 included. To include '^' itself use it as the last character of the
4191 option or the end of a range. Example:
4192 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4193 If the character is '@', all characters where isalpha() returns TRUE
4194 are included. Normally these are the characters a to z and A to Z,
4195 plus accented characters. To include '@' itself use "@-@". Examples:
4196 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004197 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 "a-z,A-Z,@-@" All letters plus the '@' character.
4199 A comma can be included by using it where a character number is
4200 expected. Example:
4201 "48-57,,,_" Digits, comma and underscore.
4202 A comma can be excluded by prepending a '^'. Example:
4203 " -~,^,,9" All characters from space to '~', excluding
4204 comma, plus <Tab>.
4205 See |option-backslash| about including spaces and backslashes.
4206
4207 *'isident'* *'isi'*
4208'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4209 "@,48-57,_,128-167,224-235"
4210 otherwise: "@,48-57,_,192-255")
4211 global
4212 {not in Vi}
4213 The characters given by this option are included in identifiers.
4214 Identifiers are used in recognizing environment variables and after a
4215 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004216 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 option.
4218 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004219 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004220 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4221
4222 *'iskeyword'* *'isk'*
4223'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4224 "@,48-57,_,128-167,224-235"
4225 otherwise: "@,48-57,_,192-255"
4226 Vi default: "@,48-57,_")
4227 local to buffer
4228 {not in Vi}
4229 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004230 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004231 'isfname' for a description of the format of this option. For C
4232 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4233 For a help file it is set to all non-blank printable characters except
4234 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4235 command).
4236 When the 'lisp' option is on the '-' character is always included.
4237 NOTE: This option is set to the Vi default value when 'compatible' is
4238 set and to the Vim default value when 'compatible' is reset.
4239
4240 *'isprint'* *'isp'*
4241'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4242 "@,~-255"; otherwise: "@,161-255")
4243 global
4244 {not in Vi}
4245 The characters given by this option are displayed directly on the
4246 screen. It is also used for "\p" in a |pattern|. The characters from
4247 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4248 even when they are not included in 'isprint' or excluded. See
4249 'isfname' for a description of the format of this option.
4250
4251 Non-printable characters are displayed with two characters:
4252 0 - 31 "^@" - "^_"
4253 32 - 126 always single characters
4254 127 "^?"
4255 128 - 159 "~@" - "~_"
4256 160 - 254 "| " - "|~"
4257 255 "~?"
4258 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4259 displayed as <xx>, with the hexadecimal value of the byte.
4260 When 'display' contains "uhex" all unprintable characters are
4261 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004262 The SpecialKey highlighting will be used for unprintable characters.
4263 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264
4265 Multi-byte characters 256 and above are always included, only the
4266 characters up to 255 are specified with this option. When a character
4267 is printable but it is not available in the current font, a
4268 replacement character will be shown.
4269 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4270 There is no option to specify these characters.
4271
4272 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4273'joinspaces' 'js' boolean (default on)
4274 global
4275 {not in Vi}
4276 Insert two spaces after a '.', '?' and '!' with a join command.
4277 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4278 Otherwise only one space is inserted.
4279 NOTE: This option is set when 'compatible' is set.
4280
4281 *'key'*
4282'key' string (default "")
4283 local to buffer
4284 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004285 {only available when compiled with the |+cryptv|
4286 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004288 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 Careful: Do not set the key value by hand, someone might see the typed
4290 key. Use the |:X| command. But you can make 'key' empty: >
4291 :set key=
4292< It is not possible to get the value of this option with ":set key" or
4293 "echo &key". This is to avoid showing it to someone who shouldn't
4294 know. It also means you cannot see it yourself once you have set it,
4295 be careful not to make a typing error!
4296
4297 *'keymap'* *'kmp'* *E544*
4298'keymap' 'kmp' string (default "")
4299 local to buffer
4300 {not in Vi}
4301 {only available when compiled with the |+keymap|
4302 feature}
4303 Name of a keyboard mapping. See |mbyte-keymap|.
4304 Setting this option to a valid keymap name has the side effect of
4305 setting 'iminsert' to one, so that the keymap becomes effective.
4306 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004307 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308
4309 *'keymodel'* *'km'*
4310'keymodel' 'km' string (default "")
4311 global
4312 {not in Vi}
4313 List of comma separated words, which enable special things that keys
4314 can do. These values can be used:
4315 startsel Using a shifted special key starts selection (either
4316 Select mode or Visual mode, depending on "key" being
4317 present in 'selectmode').
4318 stopsel Using a not-shifted special key stops selection.
4319 Special keys in this context are the cursor keys, <End>, <Home>,
4320 <PageUp> and <PageDown>.
4321 The 'keymodel' option is set by the |:behave| command.
4322
4323 *'keywordprg'* *'kp'*
4324'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4325 OS/2: "view /", VMS: "help")
4326 global or local to buffer |global-local|
4327 {not in Vi}
4328 Program to use for the |K| command. Environment variables are
4329 expanded |:set_env|. ":help" may be used to access the Vim internal
4330 help. (Note that previously setting the global option to the empty
4331 value did this, which is now deprecated.)
4332 When "man" is used, Vim will automatically translate a count for the
4333 "K" command to a section number. Also for "man -s", in which case the
4334 "-s" is removed when there is no count.
4335 See |option-backslash| about including spaces and backslashes.
4336 Example: >
4337 :set keywordprg=man\ -s
4338< This option cannot be set from a |modeline| or in the |sandbox|, for
4339 security reasons.
4340
4341 *'langmap'* *'lmap'* *E357* *E358*
4342'langmap' 'lmap' string (default "")
4343 global
4344 {not in Vi}
4345 {only available when compiled with the |+langmap|
4346 feature}
4347 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004348 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 inserted directly. When in command mode the 'langmap' option takes
4350 care of translating these special characters to the original meaning
4351 of the key. This means you don't have to change the keyboard mode to
4352 be able to execute Normal mode commands.
4353 This is the opposite of the 'keymap' option, where characters are
4354 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004356 Example (for Greek, in UTF-8): *greek* >
4357 :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 +00004358< Example (exchanges meaning of z and y for commands): >
4359 :set langmap=zy,yz,ZY,YZ
4360<
4361 The 'langmap' option is a list of parts, separated with commas. Each
4362 part can be in one of two forms:
4363 1. A list of pairs. Each pair is a "from" character immediately
4364 followed by the "to" character. Examples: "aA", "aAbBcC".
4365 2. A list of "from" characters, a semi-colon and a list of "to"
4366 characters. Example: "abc;ABC"
4367 Example: "aA,fgh;FGH,cCdDeE"
4368 Special characters need to be preceded with a backslash. These are
4369 ";", ',' and backslash itself.
4370
4371 This will allow you to activate vim actions without having to switch
4372 back and forth between the languages. Your language characters will
4373 be understood as normal vim English characters (according to the
4374 langmap mappings) in the following cases:
4375 o Normal/Visual mode (commands, buffer/register names, user mappings)
4376 o Insert/Replace Mode: Register names after CTRL-R
4377 o Insert/Replace Mode: Mappings
4378 Characters entered in Command-line mode will NOT be affected by
4379 this option. Note that this option can be changed at any time
4380 allowing to switch between mappings for different languages/encodings.
4381 Use a mapping to avoid having to type it each time!
4382
4383 *'langmenu'* *'lm'*
4384'langmenu' 'lm' string (default "")
4385 global
4386 {not in Vi}
4387 {only available when compiled with the |+menu| and
4388 |+multi_lang| features}
4389 Language to use for menu translation. Tells which file is loaded
4390 from the "lang" directory in 'runtimepath': >
4391 "lang/menu_" . &langmenu . ".vim"
4392< (without the spaces). For example, to always use the Dutch menus, no
4393 matter what $LANG is set to: >
4394 :set langmenu=nl_NL.ISO_8859-1
4395< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004396 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 If your $LANG is set to a non-English language but you do want to use
4398 the English menus: >
4399 :set langmenu=none
4400< This option must be set before loading menus, switching on filetype
4401 detection or syntax highlighting. Once the menus are defined setting
4402 this option has no effect. But you could do this: >
4403 :source $VIMRUNTIME/delmenu.vim
4404 :set langmenu=de_DE.ISO_8859-1
4405 :source $VIMRUNTIME/menu.vim
4406< Warning: This deletes all menus that you defined yourself!
4407
4408 *'laststatus'* *'ls'*
4409'laststatus' 'ls' number (default 1)
4410 global
4411 {not in Vi}
4412 The value of this option influences when the last window will have a
4413 status line:
4414 0: never
4415 1: only if there are at least two windows
4416 2: always
4417 The screen looks nicer with a status line if you have several
4418 windows, but it takes another screen line. |status-line|
4419
4420 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4421'lazyredraw' 'lz' boolean (default off)
4422 global
4423 {not in Vi}
4424 When this option is set, the screen will not be redrawn while
4425 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004426 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 update use |:redraw|.
4428
4429 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4430'linebreak' 'lbr' boolean (default off)
4431 local to window
4432 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004433 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004434 feature}
4435 If on Vim will wrap long lines at a character in 'breakat' rather
4436 than at the last character that fits on the screen. Unlike
4437 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4438 it only affects the way the file is displayed, not its contents. The
4439 value of 'showbreak' is used to put in front of wrapped lines.
4440 This option is not used when the 'wrap' option is off or 'list' is on.
4441 Note that <Tab> characters after an <EOL> are mostly not displayed
4442 with the right amount of white space.
4443
4444 *'lines'* *E593*
4445'lines' number (default 24 or terminal height)
4446 global
4447 Number of lines of the Vim window.
4448 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004449 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004450 When Vim is running in the GUI or in a resizable window, setting this
4451 option will cause the window size to be changed. When you only want
4452 to use the size for the GUI, put the command in your |gvimrc| file.
4453 Vim limits the number of lines to what fits on the screen. You can
4454 use this command to get the tallest window possible: >
4455 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004456< Minimum value is 2, maximum value is 1000.
4457 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 When you set this option and Vim is unable to change the physical
4459 number of lines of the display, the display may be messed up.
4460
4461 *'linespace'* *'lsp'*
4462'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4463 global
4464 {not in Vi}
4465 {only in the GUI}
4466 Number of pixel lines inserted between characters. Useful if the font
4467 uses the full character cell height, making lines touch each other.
4468 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004469 With some fonts there can be too much room between lines (to have
4470 space for ascents and descents). Then it makes sense to set
4471 'linespace' to a negative value. This may cause display problems
4472 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473
4474 *'lisp'* *'nolisp'*
4475'lisp' boolean (default off)
4476 local to buffer
4477 {not available when compiled without the |+lispindent|
4478 feature}
4479 Lisp mode: When <Enter> is typed in insert mode set the indent for
4480 the next line to Lisp standards (well, sort of). Also happens with
4481 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4482 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4483 better. Also see 'lispwords'.
4484 The '-' character is included in keyword characters. Redefines the
4485 "=" operator to use this same indentation algorithm rather than
4486 calling an external program if 'equalprg' is empty.
4487 This option is not used when 'paste' is set.
4488 {Vi: Does it a little bit differently}
4489
4490 *'lispwords'* *'lw'*
4491'lispwords' 'lw' string (default is very long)
4492 global
4493 {not in Vi}
4494 {not available when compiled without the |+lispindent|
4495 feature}
4496 Comma separated list of words that influence the Lisp indenting.
4497 |'lisp'|
4498
4499 *'list'* *'nolist'*
4500'list' boolean (default off)
4501 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004502 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4503 line. Useful to see the difference between tabs and spaces and for
4504 trailing blanks. Further changed by the 'listchars' option.
4505
4506 The cursor is displayed at the start of the space a Tab character
4507 occupies, not at the end as usual in Normal mode. To get this cursor
4508 position while displaying Tabs with spaces, use: >
4509 :set list lcs=tab\ \
4510<
4511 Note that list mode will also affect formatting (set with 'textwidth'
4512 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004513 changing the way tabs are displayed.
4514
4515 *'listchars'* *'lcs'*
4516'listchars' 'lcs' string (default "eol:$")
4517 global
4518 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004519 Strings to use in 'list' mode and for the |:list| command. It is a
4520 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 eol:c Character to show at the end of each line. When
4522 omitted, there is no extra character at the end of the
4523 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004524 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004525 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004526 fill the space that the tab normally occupies.
4527 "tab:>-" will show a tab that takes four spaces as
4528 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004529 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004530 trailing spaces are blank.
4531 extends:c Character to show in the last column, when 'wrap' is
4532 off and the line continues beyond the right of the
4533 screen.
4534 precedes:c Character to show in the first column, when 'wrap'
4535 is off and there is text preceding the character
4536 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004537 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004538 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004539 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004540 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004542 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004544 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545
4546 Examples: >
4547 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004548 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004549 :set lcs=extends:>,precedes:<
4550< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004551 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004552 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004553
4554 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4555'loadplugins' 'lpl' boolean (default on)
4556 global
4557 {not in Vi}
4558 When on the plugin scripts are loaded when starting up |load-plugins|.
4559 This option can be reset in your |vimrc| file to disable the loading
4560 of plugins.
4561 Note that using the "-u NONE" and "--noplugin" command line arguments
4562 reset this option. |-u| |--noplugin|
4563
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004564 *'macatsui'* *'nomacatsui'*
4565'macatsui' boolean (default on)
4566 global
4567 {only available in Mac GUI version}
4568 This is a workaround for when drawing doesn't work properly. When set
4569 and compiled with multi-byte support ATSUI text drawing is used. When
4570 not set ATSUI text drawing is not used. Switch this option off when
4571 you experience drawing problems. In a future version the problems may
4572 be solved and this option becomes obsolete. Therefore use this method
4573 to unset it: >
4574 if exists('&macatsui')
4575 set nomacatsui
4576 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004577< Another option to check if you have drawing problems is
4578 'termencoding'.
4579
Bram Moolenaar071d4272004-06-13 20:20:40 +00004580 *'magic'* *'nomagic'*
4581'magic' boolean (default on)
4582 global
4583 Changes the special characters that can be used in search patterns.
4584 See |pattern|.
4585 NOTE: To avoid portability problems with using patterns, always keep
4586 this option at the default "on". Only switch it off when working with
4587 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004588 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004589
4590 *'makeef'* *'mef'*
4591'makeef' 'mef' string (default: "")
4592 global
4593 {not in Vi}
4594 {not available when compiled without the |+quickfix|
4595 feature}
4596 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4597 and the |:grep| command.
4598 When it is empty, an internally generated temp file will be used.
4599 When "##" is included, it is replaced by a number to make the name
4600 unique. This makes sure that the ":make" command doesn't overwrite an
4601 existing file.
4602 NOT used for the ":cf" command. See 'errorfile' for that.
4603 Environment variables are expanded |:set_env|.
4604 See |option-backslash| about including spaces and backslashes.
4605 This option cannot be set from a |modeline| or in the |sandbox|, for
4606 security reasons.
4607
4608 *'makeprg'* *'mp'*
4609'makeprg' 'mp' string (default "make", VMS: "MMS")
4610 global or local to buffer |global-local|
4611 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004612 Program to use for the ":make" command. See |:make_makeprg|.
4613 This option may contain '%' and '#' characters, which are expanded to
4614 the current and alternate file name. |:_%| |:_#|
4615 Environment variables are expanded |:set_env|. See |option-backslash|
4616 about including spaces and backslashes.
4617 Note that a '|' must be escaped twice: once for ":set" and once for
4618 the interpretation of a command. When you use a filter called
4619 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 :set makeprg=gmake\ \\\|\ myfilter
4621< The placeholder "$*" can be given (even multiple times) to specify
4622 where the arguments will be included, for example: >
4623 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4624< This option cannot be set from a |modeline| or in the |sandbox|, for
4625 security reasons.
4626
4627 *'matchpairs'* *'mps'*
4628'matchpairs' 'mps' string (default "(:),{:},[:]")
4629 local to buffer
4630 {not in Vi}
4631 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004632 other. Currently only single byte character pairs are allowed, and
4633 they must be different. The characters must be separated by a colon.
4634 The pairs must be separated by a comma. Example for including '<' and
4635 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004636 :set mps+=<:>
4637
4638< A more exotic example, to jump between the '=' and ';' in an
4639 assignment, useful for languages like C and Java: >
4640 :au FileType c,cpp,java set mps+==:;
4641
4642< For a more advanced way of using "%", see the matchit.vim plugin in
4643 the $VIMRUNTIME/macros directory. |add-local-help|
4644
4645 *'matchtime'* *'mat'*
4646'matchtime' 'mat' number (default 5)
4647 global
4648 {not in Vi}{in Nvi}
4649 Tenths of a second to show the matching paren, when 'showmatch' is
4650 set. Note that this is not in milliseconds, like other options that
4651 set a time. This is to be compatible with Nvi.
4652
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004653 *'maxcombine'* *'mco'*
4654'maxcombine' 'mco' number (default 2)
4655 global
4656 {not in Vi}
4657 {only available when compiled with the |+multi_byte|
4658 feature}
4659 The maximum number of combining characters supported for displaying.
4660 Only used when 'encoding' is "utf-8".
4661 The default is OK for most languages. Hebrew may require 4.
4662 Maximum value is 6.
4663 Even when this option is set to 2 you can still edit text with more
4664 combining characters, you just can't see them. Use |g8| or |ga|.
4665 See |mbyte-combining|.
4666
Bram Moolenaar071d4272004-06-13 20:20:40 +00004667 *'maxfuncdepth'* *'mfd'*
4668'maxfuncdepth' 'mfd' number (default 100)
4669 global
4670 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004671 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004672 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004673 Maximum depth of function calls for user functions. This normally
4674 catches endless recursion. When using a recursive function with
4675 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4676 more memory, there is the danger of failing when memory is exhausted.
4677 See also |:function|.
4678
4679 *'maxmapdepth'* *'mmd'* *E223*
4680'maxmapdepth' 'mmd' number (default 1000)
4681 global
4682 {not in Vi}
4683 Maximum number of times a mapping is done without resulting in a
4684 character to be used. This normally catches endless mappings, like
4685 ":map x y" with ":map y x". It still does not catch ":map g wg",
4686 because the 'w' is used before the next mapping is done. See also
4687 |key-mapping|.
4688
4689 *'maxmem'* *'mm'*
4690'maxmem' 'mm' number (default between 256 to 5120 (system
4691 dependent) or half the amount of memory
4692 available)
4693 global
4694 {not in Vi}
4695 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4696 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004697 other memory to be freed. The maximum usable value is about 2000000.
4698 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004699
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004700 *'maxmempattern'* *'mmp'*
4701'maxmempattern' 'mmp' number (default 1000)
4702 global
4703 {not in Vi}
4704 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004705 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004706 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004707 When Vim runs into the limit it gives an error message and mostly
4708 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004709 Running into the limit often means that the pattern is very
4710 inefficient or too complex. This may already happen with the pattern
4711 "\(.\)*" on a very long line. ".*" works much better.
4712 Vim may run out of memory before hitting the 'maxmempattern' limit.
4713
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 *'maxmemtot'* *'mmt'*
4715'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4716 dependent) or half the amount of memory
4717 available)
4718 global
4719 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004720 Maximum amount of memory in Kbyte to use for all buffers together.
4721 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4722 without a limit. On 64 bit machines higher values might work. But
4723 hey, do you really need more than 2 Gbyte for text editing?
4724 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004725
4726 *'menuitems'* *'mis'*
4727'menuitems' 'mis' number (default 25)
4728 global
4729 {not in Vi}
4730 {not available when compiled without the |+menu|
4731 feature}
4732 Maximum number of items to use in a menu. Used for menus that are
4733 generated from a list of items, e.g., the Buffers menu. Changing this
4734 option has no direct effect, the menu must be refreshed first.
4735
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004736 *'mkspellmem'* *'msm'*
4737'mkspellmem' 'msm' string (default "460000,2000,500")
4738 global
4739 {not in Vi}
4740 {not available when compiled without the |+syntax|
4741 feature}
4742 Parameters for |:mkspell|. This tunes when to start compressing the
4743 word tree. Compression can be slow when there are many words, but
4744 it's needed to avoid running out of memory. The amount of memory used
4745 per word depends very much on how similar the words are, that's why
4746 this tuning is complicated.
4747
4748 There are three numbers, separated by commas:
4749 {start},{inc},{added}
4750
4751 For most languages the uncompressed word tree fits in memory. {start}
4752 gives the amount of memory in Kbyte that can be used before any
4753 compression is done. It should be a bit smaller than the amount of
4754 memory that is available to Vim.
4755
4756 When going over the {start} limit the {inc} number specifies the
4757 amount of memory in Kbyte that can be allocated before another
4758 compression is done. A low number means compression is done after
4759 less words are added, which is slow. A high number means more memory
4760 will be allocated.
4761
4762 After doing compression, {added} times 1024 words can be added before
4763 the {inc} limit is ignored and compression is done when any extra
4764 amount of memory is needed. A low number means there is a smaller
4765 chance of hitting the {inc} limit, less memory is used but it's
4766 slower.
4767
4768 The languages for which these numbers are important are Italian and
4769 Hungarian. The default works for when you have about 512 Mbyte. If
4770 you have 1 Gbyte you could use: >
4771 :set mkspellmem=900000,3000,800
4772< If you have less than 512 Mbyte |:mkspell| may fail for some
4773 languages, no matter what you set 'mkspellmem' to.
4774
Bram Moolenaar071d4272004-06-13 20:20:40 +00004775 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004776'modeline' 'ml' boolean (Vim default: on (off for root),
4777 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778 local to buffer
4779 *'modelines'* *'mls'*
4780'modelines' 'mls' number (default 5)
4781 global
4782 {not in Vi}
4783 If 'modeline' is on 'modelines' gives the number of lines that is
4784 checked for set commands. If 'modeline' is off or 'modelines' is zero
4785 no lines are checked. See |modeline|.
4786 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4787 set and to the Vim default value when 'compatible' is reset.
4788
4789 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4790'modifiable' 'ma' boolean (default on)
4791 local to buffer
4792 {not in Vi} *E21*
4793 When off the buffer contents cannot be changed. The 'fileformat' and
4794 'fileencoding' options also can't be changed.
4795 Can be reset with the |-M| command line argument.
4796
4797 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4798'modified' 'mod' boolean (default off)
4799 local to buffer
4800 {not in Vi}
4801 When on, the buffer is considered to be modified. This option is set
4802 when:
4803 1. A change was made to the text since it was last written. Using the
4804 |undo| command to go back to the original text will reset the
4805 option. But undoing changes that were made before writing the
4806 buffer will set the option again, since the text is different from
4807 when it was written.
4808 2. 'fileformat' or 'fileencoding' is different from its original
4809 value. The original value is set when the buffer is read or
4810 written. A ":set nomodified" command also resets the original
4811 values to the current values and the 'modified' option will be
4812 reset.
4813 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4814 will be ignored.
4815
4816 *'more'* *'nomore'*
4817'more' boolean (Vim default: on, Vi default: off)
4818 global
4819 {not in Vi}
4820 When on, listings pause when the whole screen is filled. You will get
4821 the |more-prompt|. When this option is off there are no pauses, the
4822 listing continues until finished.
4823 NOTE: This option is set to the Vi default value when 'compatible' is
4824 set and to the Vim default value when 'compatible' is reset.
4825
4826 *'mouse'* *E538*
4827'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4828 global
4829 {not in Vi}
4830 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004831 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4832 sysmouse and Linux console with gpm). For using the mouse in the
4833 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004834 The mouse can be enabled for different modes:
4835 n Normal mode
4836 v Visual mode
4837 i Insert mode
4838 c Command-line mode
4839 h all previous modes when editing a help file
4840 a all previous modes
4841 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004842 Normally you would enable the mouse in all four modes with: >
4843 :set mouse=a
4844< When the mouse is not enabled, the GUI will still use the mouse for
4845 modeless selection. This doesn't move the text cursor.
4846
4847 See |mouse-using|. Also see |'clipboard'|.
4848
4849 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004850 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 the mouse buttons can still be used by keeping the shift key pressed.
4852 Also see the 'clipboard' option.
4853
4854 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4855'mousefocus' 'mousef' boolean (default off)
4856 global
4857 {not in Vi}
4858 {only works in the GUI}
4859 The window that the mouse pointer is on is automatically activated.
4860 When changing the window layout or window focus in another way, the
4861 mouse pointer is moved to the window with keyboard focus. Off is the
4862 default because it makes using the pull down menus a little goofy, as
4863 a pointer transit may activate a window unintentionally.
4864
4865 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4866'mousehide' 'mh' boolean (default on)
4867 global
4868 {not in Vi}
4869 {only works in the GUI}
4870 When on, the mouse pointer is hidden when characters are typed.
4871 The mouse pointer is restored when the mouse is moved.
4872
4873 *'mousemodel'* *'mousem'*
4874'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4875 global
4876 {not in Vi}
4877 Sets the model to use for the mouse. The name mostly specifies what
4878 the right mouse button is used for:
4879 extend Right mouse button extends a selection. This works
4880 like in an xterm.
4881 popup Right mouse button pops up a menu. The shifted left
4882 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004883 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004884 popup_setpos Like "popup", but the cursor will be moved to the
4885 position where the mouse was clicked, and thus the
4886 selected operation will act upon the clicked object.
4887 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004888 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 course, that right clicking outside a selection will
4890 end Visual mode.
4891 Overview of what button does what for each model:
4892 mouse extend popup(_setpos) ~
4893 left click place cursor place cursor
4894 left drag start selection start selection
4895 shift-left search word extend selection
4896 right click extend selection popup menu (place cursor)
4897 right drag extend selection -
4898 middle click paste paste
4899
4900 In the "popup" model the right mouse button produces a pop-up menu.
4901 You need to define this first, see |popup-menu|.
4902
4903 Note that you can further refine the meaning of buttons with mappings.
4904 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4905 selection (because that's handled in the GUI code directly).
4906
4907 The 'mousemodel' option is set by the |:behave| command.
4908
4909 *'mouseshape'* *'mouses'* *E547*
4910'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004911 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004912 global
4913 {not in Vi}
4914 {only available when compiled with the |+mouseshape|
4915 feature}
4916 This option tells Vim what the mouse pointer should look like in
4917 different modes. The option is a comma separated list of parts, much
4918 like used for 'guicursor'. Each part consist of a mode/location-list
4919 and an argument-list:
4920 mode-list:shape,mode-list:shape,..
4921 The mode-list is a dash separated list of these modes/locations:
4922 In a normal window: ~
4923 n Normal mode
4924 v Visual mode
4925 ve Visual mode with 'selection' "exclusive" (same as 'v',
4926 if not specified)
4927 o Operator-pending mode
4928 i Insert mode
4929 r Replace mode
4930
4931 Others: ~
4932 c appending to the command-line
4933 ci inserting in the command-line
4934 cr replacing in the command-line
4935 m at the 'Hit ENTER' or 'More' prompts
4936 ml idem, but cursor in the last line
4937 e any mode, pointer below last window
4938 s any mode, pointer on a status line
4939 sd any mode, while dragging a status line
4940 vs any mode, pointer on a vertical separator line
4941 vd any mode, while dragging a vertical separator line
4942 a everywhere
4943
4944 The shape is one of the following:
4945 avail name looks like ~
4946 w x arrow Normal mouse pointer
4947 w x blank no pointer at all (use with care!)
4948 w x beam I-beam
4949 w x updown up-down sizing arrows
4950 w x leftright left-right sizing arrows
4951 w x busy The system's usual busy pointer
4952 w x no The system's usual 'no input' pointer
4953 x udsizing indicates up-down resizing
4954 x lrsizing indicates left-right resizing
4955 x crosshair like a big thin +
4956 x hand1 black hand
4957 x hand2 white hand
4958 x pencil what you write with
4959 x question big ?
4960 x rightup-arrow arrow pointing right-up
4961 w x up-arrow arrow pointing up
4962 x <number> any X11 pointer number (see X11/cursorfont.h)
4963
4964 The "avail" column contains a 'w' if the shape is available for Win32,
4965 x for X11.
4966 Any modes not specified or shapes not available use the normal mouse
4967 pointer.
4968
4969 Example: >
4970 :set mouseshape=s:udsizing,m:no
4971< will make the mouse turn to a sizing arrow over the status lines and
4972 indicate no input when the hit-enter prompt is displayed (since
4973 clicking the mouse has no effect in this state.)
4974
4975 *'mousetime'* *'mouset'*
4976'mousetime' 'mouset' number (default 500)
4977 global
4978 {not in Vi}
4979 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4980 time in msec between two mouse clicks for the second click to be
4981 recognized as a multi click.
4982
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004983 *'mzquantum'* *'mzq'*
4984'mzquantum' 'mzq' number (default 100)
4985 global
4986 {not in Vi}
4987 {not available when compiled without the |+mzscheme|
4988 feature}
4989 The number of milliseconds between polls for MzScheme threads.
4990 Negative or zero value means no thread scheduling.
4991
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 *'nrformats'* *'nf'*
4993'nrformats' 'nf' string (default "octal,hex")
4994 local to buffer
4995 {not in Vi}
4996 This defines what bases Vim will consider for numbers when using the
4997 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4998 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004999 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005000 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005001 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005002 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005004 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 considered to be hexadecimal. Example: Using CTRL-X on
5006 "0x100" results in "0x0ff".
5007 Numbers which simply begin with a digit in the range 1-9 are always
5008 considered decimal. This also happens for numbers that are not
5009 recognized as octal or hex.
5010
5011 *'number'* *'nu'* *'nonumber'* *'nonu'*
5012'number' 'nu' boolean (default off)
5013 local to window
5014 Print the line number in front of each line. When the 'n' option is
5015 excluded from 'cpoptions' a wrapped line will not use the column of
5016 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005017 The 'numberwidth' option can be used to set the room used for the line
5018 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 When a long, wrapped line doesn't start with the first character, '-'
5020 characters are put before the number.
5021 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005022 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005024 *'numberwidth'* *'nuw'*
5025'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5026 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005027 {not in Vi}
5028 {only available when compiled with the |+linebreak|
5029 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005030 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005031 when the 'number' or 'relativenumber' option is set or printing lines
5032 with a line number. Since one space is always between the number and
5033 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005034 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005035 fit the highest line number in the buffer respectively the number of
5036 rows in the window, depending on whether 'number' or 'relativenumber'
5037 is set. Thus with the Vim default of 4 there is room for a line number
5038 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005039 The minimum value is 1, the maximum value is 10.
5040 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5041
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005042 *'omnifunc'* *'ofu'*
5043'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005044 local to buffer
5045 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005046 {not available when compiled without the |+eval|
5047 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005048 This option specifies a function to be used for Insert mode omni
5049 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005050 See |complete-functions| for an explanation of how the function is
5051 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005052 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005053 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005054
5055
Bram Moolenaar02467872007-05-06 13:22:01 +00005056 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005057'opendevice' 'odev' boolean (default off)
5058 global
5059 {not in Vi}
5060 {only for MS-DOS, MS-Windows and OS/2}
5061 Enable reading and writing from devices. This may get Vim stuck on a
5062 device that can be opened but doesn't actually do the I/O. Therefore
5063 it is off by default.
5064 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5065 result in editing a device.
5066
5067
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005068 *'operatorfunc'* *'opfunc'*
5069'operatorfunc' 'opfunc' string (default: empty)
5070 global
5071 {not in Vi}
5072 This option specifies a function to be called by the |g@| operator.
5073 See |:map-operator| for more info and an example.
5074
5075 This option cannot be set from a |modeline| or in the |sandbox|, for
5076 security reasons.
5077
5078
Bram Moolenaar071d4272004-06-13 20:20:40 +00005079 *'osfiletype'* *'oft'* *E366*
5080'osfiletype' 'oft' string (RISC-OS default: "Text",
5081 others default: "")
5082 local to buffer
5083 {not in Vi}
5084 {only available when compiled with the |+osfiletype|
5085 feature}
5086 Some operating systems store extra information about files besides
5087 name, datestamp and permissions. This option contains the extra
5088 information, the nature of which will vary between systems.
5089 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005090 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005091 It can affect the pattern matching of the automatic commands.
5092 |autocmd-osfiletypes|
5093
5094 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005095'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005096 global
5097 Specifies the nroff macros that separate paragraphs. These are pairs
5098 of two letters (see |object-motions|).
5099
5100 *'paste'* *'nopaste'*
5101'paste' boolean (default off)
5102 global
5103 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005104 Put Vim in Paste mode. This is useful if you want to cut or copy
5105 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005106 unexpected effects.
5107 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005108 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 knows about pasting and will mostly do the right thing without 'paste'
5110 being set. The same is true for a terminal where Vim handles the
5111 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005112 This option is reset when starting the GUI. Thus if you set it in
5113 your .vimrc it will work in a terminal, but not in the GUI. Setting
5114 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5115 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005116 When the 'paste' option is switched on (also when it was already on):
5117 - mapping in Insert mode and Command-line mode is disabled
5118 - abbreviations are disabled
5119 - 'textwidth' is set to 0
5120 - 'wrapmargin' is set to 0
5121 - 'autoindent' is reset
5122 - 'smartindent' is reset
5123 - 'softtabstop' is set to 0
5124 - 'revins' is reset
5125 - 'ruler' is reset
5126 - 'showmatch' is reset
5127 - 'formatoptions' is used like it is empty
5128 These options keep their value, but their effect is disabled:
5129 - 'lisp'
5130 - 'indentexpr'
5131 - 'cindent'
5132 NOTE: When you start editing another file while the 'paste' option is
5133 on, settings from the modelines or autocommands may change the
5134 settings again, causing trouble when pasting text. You might want to
5135 set the 'paste' option again.
5136 When the 'paste' option is reset the mentioned options are restored to
5137 the value before the moment 'paste' was switched from off to on.
5138 Resetting 'paste' before ever setting it does not have any effect.
5139 Since mapping doesn't work while 'paste' is active, you need to use
5140 the 'pastetoggle' option to toggle the 'paste' option with some key.
5141
5142 *'pastetoggle'* *'pt'*
5143'pastetoggle' 'pt' string (default "")
5144 global
5145 {not in Vi}
5146 When non-empty, specifies the key sequence that toggles the 'paste'
5147 option. This is like specifying a mapping: >
5148 :map {keys} :set invpaste<CR>
5149< Where {keys} is the value of 'pastetoggle'.
5150 The difference is that it will work even when 'paste' is set.
5151 'pastetoggle' works in Insert mode and Normal mode, but not in
5152 Command-line mode.
5153 Mappings are checked first, thus overrule 'pastetoggle'. However,
5154 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5155 this: >
5156 :map <F10> :set paste<CR>
5157 :map <F11> :set nopaste<CR>
5158 :imap <F10> <C-O>:set paste<CR>
5159 :imap <F11> <nop>
5160 :set pastetoggle=<F11>
5161< This will make <F10> start paste mode and <F11> stop paste mode.
5162 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5163 mode everything is inserted literally, except the 'pastetoggle' key
5164 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005165 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
5167 *'pex'* *'patchexpr'*
5168'patchexpr' 'pex' string (default "")
5169 global
5170 {not in Vi}
5171 {not available when compiled without the |+diff|
5172 feature}
5173 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005174 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175
5176 *'patchmode'* *'pm'* *E206*
5177'patchmode' 'pm' string (default "")
5178 global
5179 {not in Vi}
5180 When non-empty the oldest version of a file is kept. This can be used
5181 to keep the original version of a file if you are changing files in a
5182 source distribution. Only the first time that a file is written a
5183 copy of the original file will be kept. The name of the copy is the
5184 name of the original file with the string in the 'patchmode' option
5185 appended. This option should start with a dot. Use a string like
5186 ".org". 'backupdir' must not be empty for this to work (Detail: The
5187 backup file is renamed to the patchmode file after the new file has
5188 been successfully written, that's why it must be possible to write a
5189 backup file). If there was no file to be backed up, an empty file is
5190 created.
5191 When the 'backupskip' pattern matches, a patchmode file is not made.
5192 Using 'patchmode' for compressed files appends the extension at the
5193 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5194 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005195 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
5197 *'path'* *'pa'* *E343* *E345* *E347*
5198'path' 'pa' string (default on Unix: ".,/usr/include,,"
5199 on OS/2: ".,/emx/include,,"
5200 other systems: ".,,")
5201 global or local to buffer |global-local|
5202 {not in Vi}
5203 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005204 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5205 provided that the file being searched for has a relative path (not
5206 starting with "/", "./" or "../"). The directories in the 'path'
5207 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005208 - Use commas to separate directory names: >
5209 :set path=.,/usr/local/include,/usr/include
5210< - Spaces can also be used to separate directory names (for backwards
5211 compatibility with version 3.0). To have a space in a directory
5212 name, precede it with an extra backslash, and escape the space: >
5213 :set path=.,/dir/with\\\ space
5214< - To include a comma in a directory name precede it with an extra
5215 backslash: >
5216 :set path=.,/dir/with\\,comma
5217< - To search relative to the directory of the current file, use: >
5218 :set path=.
5219< - To search in the current directory use an empty string between two
5220 commas: >
5221 :set path=,,
5222< - A directory name may end in a ':' or '/'.
5223 - Environment variables are expanded |:set_env|.
5224 - When using |netrw.vim| URLs can be used. For example, adding
5225 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005226 - Search upwards and downwards in a directory tree using "*", "**" and
5227 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005228 {not available when compiled without the |+path_extra| feature}
5229 - Careful with '\' characters, type two to get one in the option: >
5230 :set path=.,c:\\include
5231< Or just use '/' instead: >
5232 :set path=.,c:/include
5233< Don't forget "." or files won't even be found in the same directory as
5234 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005235 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 it is something like 256 or 1024 characters.
5237 You can check if all the include files are found, using the value of
5238 'path', see |:checkpath|.
5239 The use of |:set+=| and |:set-=| is preferred when adding or removing
5240 directories from the list. This avoids problems when a future version
5241 uses another default. To remove the current directory use: >
5242 :set path-=
5243< To add the current directory use: >
5244 :set path+=
5245< To use an environment variable, you probably need to replace the
5246 separator. Here is an example to append $INCL, in which directory
5247 names are separated with a semi-colon: >
5248 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5249< Replace the ';' with a ':' or whatever separator is used. Note that
5250 this doesn't work when $INCL contains a comma or white space.
5251
5252 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5253'preserveindent' 'pi' boolean (default off)
5254 local to buffer
5255 {not in Vi}
5256 When changing the indent of the current line, preserve as much of the
5257 indent structure as possible. Normally the indent is replaced by a
5258 series of tabs followed by spaces as required (unless |'expandtab'| is
5259 enabled, in which case only spaces are used). Enabling this option
5260 means the indent will preserve as many existing characters as possible
5261 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005262 'expandtab' does not apply to the preserved white space, a Tab remains
5263 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 NOTE: When using ">>" multiple times the resulting indent is a mix of
5265 tabs and spaces. You might not like this.
5266 NOTE: 'preserveindent' is reset when 'compatible' is set.
5267 Also see 'copyindent'.
5268 Use |:retab| to clean up white space.
5269
5270 *'previewheight'* *'pvh'*
5271'previewheight' 'pvh' number (default 12)
5272 global
5273 {not in Vi}
5274 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005275 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 Default height for a preview window. Used for |:ptag| and associated
5277 commands. Used for |CTRL-W_}| when no count is given.
5278
5279 *'previewwindow'* *'nopreviewwindow'*
5280 *'pvw'* *'nopvw'* *E590*
5281'previewwindow' 'pvw' boolean (default off)
5282 local to window
5283 {not in Vi}
5284 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005285 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005286 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005287 set. It's normally not set directly, but by using one of the commands
5288 |:ptag|, |:pedit|, etc.
5289
5290 *'printdevice'* *'pdev'*
5291'printdevice' 'pdev' string (default empty)
5292 global
5293 {not in Vi}
5294 {only available when compiled with the |+printer|
5295 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005296 The name of the printer to be used for |:hardcopy|.
5297 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005298 This option cannot be set from a |modeline| or in the |sandbox|, for
5299 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300
Bram Moolenaar8299df92004-07-10 09:47:34 +00005301 *'printencoding'* *'penc'*
5302'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005303 global
5304 {not in Vi}
5305 {only available when compiled with the |+printer|
5306 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005307 Sets the character encoding used when printing.
5308 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005309
5310 *'printexpr'* *'pexpr'*
5311'printexpr' 'pexpr' String (default: see below)
5312 global
5313 {not in Vi}
5314 {only available when compiled with the |+printer|
5315 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005316 Expression used to print the PostScript produced with |:hardcopy|.
5317 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318
Bram Moolenaar8299df92004-07-10 09:47:34 +00005319 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005320'printfont' 'pfn' string (default "courier")
5321 global
5322 {not in Vi}
5323 {only available when compiled with the |+printer|
5324 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005325 The name of the font that will be used for |:hardcopy|.
5326 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005327
5328 *'printheader'* *'pheader'*
5329'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5330 global
5331 {not in Vi}
5332 {only available when compiled with the |+printer|
5333 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005334 The format of the header produced in |:hardcopy| output.
5335 See |pheader-option|.
5336
5337 *'printmbcharset'* *'pmbcs'*
5338'printmbcharset' 'pmbcs' string (default "")
5339 global
5340 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005341 {only available when compiled with the |+printer|,
5342 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005343 The CJK character set to be used for CJK output from |:hardcopy|.
5344 See |pmbcs-option|.
5345
5346 *'printmbfont'* *'pmbfn'*
5347'printmbfont' 'pmbfn' string (default "")
5348 global
5349 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005350 {only available when compiled with the |+printer|,
5351 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005352 List of font names to be used for CJK output from |:hardcopy|.
5353 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005354
5355 *'printoptions'* *'popt'*
5356'printoptions' 'popt' string (default "")
5357 global
5358 {not in Vi}
5359 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005360 List of items that control the format of the output of |:hardcopy|.
5361 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005363 *'prompt'* *'noprompt'*
5364'prompt' boolean (default on)
5365 global
5366 When on a ":" prompt is used in Ex mode.
5367
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005368 *'pumheight'* *'ph'*
5369'pumheight' 'ph' number (default 0)
5370 global
5371 {not available when compiled without the
5372 |+insert_expand| feature}
5373 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005374 Determines the maximum number of items to show in the popup menu for
5375 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005376 |ins-completion-menu|.
5377
5378
Bram Moolenaar677ee682005-01-27 14:41:15 +00005379 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005380'quoteescape' 'qe' string (default "\")
5381 local to buffer
5382 {not in Vi}
5383 The characters that are used to escape quotes in a string. Used for
5384 objects like a', a" and a` |a'|.
5385 When one of the characters in this option is found inside a string,
5386 the following character will be skipped. The default value makes the
5387 text "foo\"bar\\" considered to be one string.
5388
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5390'readonly' 'ro' boolean (default off)
5391 local to buffer
5392 If on, writes fail unless you use a '!'. Protects you from
5393 accidentally overwriting a file. Default on when Vim is started
5394 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005395 When using ":w!" the 'readonly' option is reset for the current
5396 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005398 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005399
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005400 *'redrawtime'* *'rdt'*
5401'redrawtime' 'rdt' number (default 2000)
5402 global
5403 {not in Vi}
5404 {only available when compiled with the |+reltime|
5405 feature}
5406 The time in milliseconds for redrawing the display. This applies to
5407 searching for patterns for 'hlsearch' and |:match| highlighting.
5408 When redrawing takes more than this many milliseconds no further
5409 matches will be highlighted. This is used to avoid that Vim hangs
5410 when using a very complicated pattern.
5411
Bram Moolenaar64486672010-05-16 15:46:46 +02005412 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5413'relativenumber' 'rnu' boolean (default off)
5414 local to window
5415 {not in Vi}
5416 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005417 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005418 precede some vertical motion commands (e.g. j k + -) with, without
5419 having to calculate it yourself. Especially useful in combination with
5420 other commands (e.g. y d c < > gq gw =).
5421 When the 'n' option is excluded from 'cpoptions' a wrapped
5422 line will not use the column of line numbers (this is the default when
5423 'compatible' isn't set).
5424 The 'numberwidth' option can be used to set the room used for the line
5425 number.
5426 When a long, wrapped line doesn't start with the first character, '-'
5427 characters are put before the number.
5428 See |hl-LineNr| for the highlighting used for the number.
5429 When setting this option, 'number' is reset.
5430
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 *'remap'* *'noremap'*
5432'remap' boolean (default on)
5433 global
5434 Allows for mappings to work recursively. If you do not want this for
5435 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005436 NOTE: To avoid portability problems with Vim scripts, always keep
5437 this option at the default "on". Only switch it off when working with
5438 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005439
5440 *'report'*
5441'report' number (default 2)
5442 global
5443 Threshold for reporting number of lines changed. When the number of
5444 changed lines is more than 'report' a message will be given for most
5445 ":" commands. If you want it always, set 'report' to 0.
5446 For the ":substitute" command the number of substitutions is used
5447 instead of the number of lines.
5448
5449 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5450'restorescreen' 'rs' boolean (default on)
5451 global
5452 {not in Vi} {only in Windows 95/NT console version}
5453 When set, the screen contents is restored when exiting Vim. This also
5454 happens when executing external commands.
5455
5456 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5457 options in your .vimrc. To disable restoring:
5458 set t_ti= t_te=
5459 To enable restoring (for an xterm):
5460 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5461 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5462
5463 *'revins'* *'ri'* *'norevins'* *'nori'*
5464'revins' 'ri' boolean (default off)
5465 global
5466 {not in Vi}
5467 {only available when compiled with the |+rightleft|
5468 feature}
5469 Inserting characters in Insert mode will work backwards. See "typing
5470 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5471 command in Insert mode, when 'allowrevins' is set.
5472 NOTE: This option is reset when 'compatible' or 'paste' is set.
5473
5474 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5475'rightleft' 'rl' boolean (default off)
5476 local to window
5477 {not in Vi}
5478 {only available when compiled with the |+rightleft|
5479 feature}
5480 When on, display orientation becomes right-to-left, i.e., characters
5481 that are stored in the file appear from the right to the left.
5482 Using this option, it is possible to edit files for languages that
5483 are written from the right to the left such as Hebrew and Arabic.
5484 This option is per window, so it is possible to edit mixed files
5485 simultaneously, or to view the same file in both ways (this is
5486 useful whenever you have a mixed text file with both right-to-left
5487 and left-to-right strings so that both sets are displayed properly
5488 in different windows). Also see |rileft.txt|.
5489
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005490 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005491'rightleftcmd' 'rlc' string (default "search")
5492 local to window
5493 {not in Vi}
5494 {only available when compiled with the |+rightleft|
5495 feature}
5496 Each word in this option enables the command line editing to work in
5497 right-to-left mode for a group of commands:
5498
5499 search "/" and "?" commands
5500
5501 This is useful for languages such as Hebrew, Arabic and Farsi.
5502 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5503
5504 *'ruler'* *'ru'* *'noruler'* *'noru'*
5505'ruler' 'ru' boolean (default off)
5506 global
5507 {not in Vi}
5508 {not available when compiled without the
5509 |+cmdline_info| feature}
5510 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005511 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 text in the file is shown on the far right:
5513 Top first line is visible
5514 Bot last line is visible
5515 All first and last line are visible
5516 45% relative position in the file
5517 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005518 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005520 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005521 this option takes precedence over 'ruler' and 'rulerformat'
5522 If the number of characters displayed is different from the number of
5523 bytes in the text (e.g., for a TAB or a multi-byte character), both
5524 the text column (byte number) and the screen column are shown,
5525 separated with a dash.
5526 For an empty line "0-1" is shown.
5527 For an empty buffer the line number will also be zero: "0,0-1".
5528 This option is reset when the 'paste' option is set.
5529 If you don't want to see the ruler all the time but want to know where
5530 you are, use "g CTRL-G" |g_CTRL-G|.
5531 NOTE: This option is reset when 'compatible' is set.
5532
5533 *'rulerformat'* *'ruf'*
5534'rulerformat' 'ruf' string (default empty)
5535 global
5536 {not in Vi}
5537 {not available when compiled without the |+statusline|
5538 feature}
5539 When this option is not empty, it determines the content of the ruler
5540 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005541 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005542 The default ruler width is 17 characters. To make the ruler 15
5543 characters wide, put "%15(" at the start and "%)" at the end.
5544 Example: >
5545 :set rulerformat=%15(%c%V\ %p%%%)
5546<
5547 *'runtimepath'* *'rtp'* *vimfiles*
5548'runtimepath' 'rtp' string (default:
5549 Unix: "$HOME/.vim,
5550 $VIM/vimfiles,
5551 $VIMRUNTIME,
5552 $VIM/vimfiles/after,
5553 $HOME/.vim/after"
5554 Amiga: "home:vimfiles,
5555 $VIM/vimfiles,
5556 $VIMRUNTIME,
5557 $VIM/vimfiles/after,
5558 home:vimfiles/after"
5559 PC, OS/2: "$HOME/vimfiles,
5560 $VIM/vimfiles,
5561 $VIMRUNTIME,
5562 $VIM/vimfiles/after,
5563 $HOME/vimfiles/after"
5564 Macintosh: "$VIM:vimfiles,
5565 $VIMRUNTIME,
5566 $VIM:vimfiles:after"
5567 RISC-OS: "Choices:vimfiles,
5568 $VIMRUNTIME,
5569 Choices:vimfiles/after"
5570 VMS: "sys$login:vimfiles,
5571 $VIM/vimfiles,
5572 $VIMRUNTIME,
5573 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005574 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005575 global
5576 {not in Vi}
5577 This is a list of directories which will be searched for runtime
5578 files:
5579 filetype.vim filetypes by file name |new-filetype|
5580 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005581 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 colors/ color scheme files |:colorscheme|
5583 compiler/ compiler files |:compiler|
5584 doc/ documentation |write-local-help|
5585 ftplugin/ filetype plugins |write-filetype-plugin|
5586 indent/ indent scripts |indent-expression|
5587 keymap/ key mapping files |mbyte-keymap|
5588 lang/ menu translations |:menutrans|
5589 menu.vim GUI menus |menu.vim|
5590 plugin/ plugin scripts |write-plugin|
5591 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005592 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593 syntax/ syntax files |mysyntaxfile|
5594 tutor/ files for vimtutor |tutor|
5595
5596 And any other file searched for with the |:runtime| command.
5597
5598 The defaults for most systems are setup to search five locations:
5599 1. In your home directory, for your personal preferences.
5600 2. In a system-wide Vim directory, for preferences from the system
5601 administrator.
5602 3. In $VIMRUNTIME, for files distributed with Vim.
5603 *after-directory*
5604 4. In the "after" directory in the system-wide Vim directory. This is
5605 for the system administrator to overrule or add to the distributed
5606 defaults (rarely needed)
5607 5. In the "after" directory in your home directory. This is for
5608 personal preferences to overrule or add to the distributed defaults
5609 or system-wide settings (rarely needed).
5610
5611 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5612 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005613 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005614 wildcards.
5615 See |:runtime|.
5616 Example: >
5617 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5618< This will use the directory "~/vimruntime" first (containing your
5619 personal Vim runtime files), then "/mygroup/vim" (shared between a
5620 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5621 files).
5622 You probably should always include $VIMRUNTIME somewhere, to use the
5623 distributed runtime files. You can put a directory before $VIMRUNTIME
5624 to find files which replace a distributed runtime files. You can put
5625 a directory after $VIMRUNTIME to find files which add to distributed
5626 runtime files.
5627 This option cannot be set from a |modeline| or in the |sandbox|, for
5628 security reasons.
5629
5630 *'scroll'* *'scr'*
5631'scroll' 'scr' number (default: half the window height)
5632 local to window
5633 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5634 set to half the number of lines in the window when the window size
5635 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005636 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005637 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5638 the number of screen lines instead of file lines, makes a difference
5639 when lines wrap}
5640
5641 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5642'scrollbind' 'scb' boolean (default off)
5643 local to window
5644 {not in Vi}
5645 {not available when compiled without the |+scrollbind|
5646 feature}
5647 See also |scroll-binding|. When this option is set, the current
5648 window scrolls as other scrollbind windows (windows that also have
5649 this option set) scroll. This option is useful for viewing the
5650 differences between two versions of a file, see 'diff'.
5651 See |'scrollopt'| for options that determine how this option should be
5652 interpreted.
5653 This option is mostly reset when splitting a window to edit another
5654 file. This means that ":split | edit file" results in two windows
5655 with scroll-binding, but ":split file" does not.
5656
5657 *'scrolljump'* *'sj'*
5658'scrolljump' 'sj' number (default 1)
5659 global
5660 {not in Vi}
5661 Minimal number of lines to scroll when the cursor gets off the
5662 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5663 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005664 When set to a negative number from -1 to -100 this is used as the
5665 percentage of the window height. Thus -50 scrolls half the window
5666 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005667 NOTE: This option is set to 1 when 'compatible' is set.
5668
5669 *'scrolloff'* *'so'*
5670'scrolloff' 'so' number (default 0)
5671 global
5672 {not in Vi}
5673 Minimal number of screen lines to keep above and below the cursor.
5674 This will make some context visible around where you are working. If
5675 you set it to a very large value (999) the cursor line will always be
5676 in the middle of the window (except at the start or end of the file or
5677 when long lines wrap).
5678 For scrolling horizontally see 'sidescrolloff'.
5679 NOTE: This option is set to 0 when 'compatible' is set.
5680
5681 *'scrollopt'* *'sbo'*
5682'scrollopt' 'sbo' string (default "ver,jump")
5683 global
5684 {not available when compiled without the |+scrollbind|
5685 feature}
5686 {not in Vi}
5687 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005688 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5689 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 The following words are available:
5691 ver Bind vertical scrolling for 'scrollbind' windows
5692 hor Bind horizontal scrolling for 'scrollbind' windows
5693 jump Applies to the offset between two windows for vertical
5694 scrolling. This offset is the difference in the first
5695 displayed line of the bound windows. When moving
5696 around in a window, another 'scrollbind' window may
5697 reach a position before the start or after the end of
5698 the buffer. The offset is not changed though, when
5699 moving back the 'scrollbind' window will try to scroll
5700 to the desired position when possible.
5701 When now making that window the current one, two
5702 things can be done with the relative offset:
5703 1. When "jump" is not included, the relative offset is
5704 adjusted for the scroll position in the new current
5705 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005706 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 2. When "jump" is included, the other windows are
5708 scrolled to keep the same relative offset. When
5709 going back to the other window, it still uses the
5710 same relative offset.
5711 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005712 When 'diff' mode is active there always is vertical scroll binding,
5713 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714
5715 *'sections'* *'sect'*
5716'sections' 'sect' string (default "SHNHH HUnhsh")
5717 global
5718 Specifies the nroff macros that separate sections. These are pairs of
5719 two letters (See |object-motions|). The default makes a section start
5720 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5721
5722 *'secure'* *'nosecure'* *E523*
5723'secure' boolean (default off)
5724 global
5725 {not in Vi}
5726 When on, ":autocmd", shell and write commands are not allowed in
5727 ".vimrc" and ".exrc" in the current directory and map commands are
5728 displayed. Switch it off only if you know that you will not run into
5729 problems, or when the 'exrc' option is off. On Unix this option is
5730 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005731 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005732 'secure' at the end of your ~/.vimrc then.
5733 This option cannot be set from a |modeline| or in the |sandbox|, for
5734 security reasons.
5735
5736 *'selection'* *'sel'*
5737'selection' 'sel' string (default "inclusive")
5738 global
5739 {not in Vi}
5740 This option defines the behavior of the selection. It is only used
5741 in Visual and Select mode.
5742 Possible values:
5743 value past line inclusive ~
5744 old no yes
5745 inclusive yes yes
5746 exclusive yes no
5747 "past line" means that the cursor is allowed to be positioned one
5748 character past the line.
5749 "inclusive" means that the last character of the selection is included
5750 in an operation. For example, when "x" is used to delete the
5751 selection.
5752 Note that when "exclusive" is used and selecting from the end
5753 backwards, you cannot include the last character of a line, when
5754 starting in Normal mode and 'virtualedit' empty.
5755
5756 The 'selection' option is set by the |:behave| command.
5757
5758 *'selectmode'* *'slm'*
5759'selectmode' 'slm' string (default "")
5760 global
5761 {not in Vi}
5762 This is a comma separated list of words, which specifies when to start
5763 Select mode instead of Visual mode, when a selection is started.
5764 Possible values:
5765 mouse when using the mouse
5766 key when using shifted special keys
5767 cmd when using "v", "V" or CTRL-V
5768 See |Select-mode|.
5769 The 'selectmode' option is set by the |:behave| command.
5770
5771 *'sessionoptions'* *'ssop'*
5772'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005773 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005774 global
5775 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005776 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005777 feature}
5778 Changes the effect of the |:mksession| command. It is a comma
5779 separated list of words. Each word enables saving and restoring
5780 something:
5781 word save and restore ~
5782 blank empty windows
5783 buffers hidden and unloaded buffers, not just those in windows
5784 curdir the current directory
5785 folds manually created folds, opened/closed folds and local
5786 fold options
5787 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005788 and contain at least one lowercase letter. Only
5789 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 help the help window
5791 localoptions options and mappings local to a window or buffer (not
5792 global values for local options)
5793 options all options and mappings (also global values for local
5794 options)
5795 resize size of the Vim window: 'lines' and 'columns'
5796 sesdir the directory in which the session file is located
5797 will become the current directory (useful with
5798 projects accessed over a network from different
5799 systems)
5800 slash backslashes in file names replaced with forward
5801 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005802 tabpages all tab pages; without this only the current tab page
5803 is restored, so that you can make a session for each
5804 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005805 unix with Unix end-of-line format (single <NL>), even when
5806 on Windows or DOS
5807 winpos position of the whole Vim window
5808 winsize window sizes
5809
5810 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005811 When neither "curdir" nor "sesdir" is included, file names are stored
5812 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005813 "slash" and "unix" are useful on Windows when sharing session files
5814 with Unix. The Unix version of Vim cannot source dos format scripts,
5815 but the Windows version of Vim can source unix format scripts.
5816
5817 *'shell'* *'sh'* *E91*
5818'shell' 'sh' string (default $SHELL or "sh",
5819 MS-DOS and Win32: "command.com" or
5820 "cmd.exe", OS/2: "cmd")
5821 global
5822 Name of the shell to use for ! and :! commands. When changing the
5823 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5824 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005825 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 See |option-backslash| about including spaces and backslashes.
5827 Environment variables are expanded |:set_env|.
5828 If the name of the shell contains a space, you might need to enclose
5829 it in quotes. Example: >
5830 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5831< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005832 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005833 "-f" is not inside the quotes, because it is not part of the command
5834 name. And Vim automagically recognizes the backslashes that are path
5835 separators.
5836 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5837 variable to change the way external commands are executed. See the
5838 libc.inf file of DJGPP.
5839 Under MS-Windows, when the executable ends in ".com" it must be
5840 included. Thus setting the shell to "command.com" or "4dos.com"
5841 works, but "command" and "4dos" do not work for all commands (e.g.,
5842 filtering).
5843 For unknown reasons, when using "4dos.com" the current directory is
5844 changed to "C:\". To avoid this set 'shell' like this: >
5845 :set shell=command.com\ /c\ 4dos
5846< This option cannot be set from a |modeline| or in the |sandbox|, for
5847 security reasons.
5848
5849 *'shellcmdflag'* *'shcf'*
5850'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5851 does not contain "sh" somewhere: "/c")
5852 global
5853 {not in Vi}
5854 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5855 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5856 systems, the default is set according to the value of 'shell', to
5857 reduce the need to set this option by the user. It's not used for
5858 OS/2 (EMX figures this out itself). See |option-backslash| about
5859 including spaces and backslashes. See |dos-shell|.
5860 This option cannot be set from a |modeline| or in the |sandbox|, for
5861 security reasons.
5862
5863 *'shellpipe'* *'sp'*
5864'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5865 global
5866 {not in Vi}
5867 {not available when compiled without the |+quickfix|
5868 feature}
5869 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005870 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005871 including spaces and backslashes.
5872 The name of the temporary file can be represented by "%s" if necessary
5873 (the file name is appended automatically if no %s appears in the value
5874 of this option).
5875 For the Amiga and MS-DOS the default is ">". The output is directly
5876 saved in a file and not echoed to the screen.
5877 For Unix the default it "| tee". The stdout of the compiler is saved
5878 in a file and echoed to the screen. If the 'shell' option is "csh" or
5879 "tcsh" after initializations, the default becomes "|& tee". If the
5880 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005881 "2>&1| tee". This means that stderr is also included. Before using
5882 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005883 The initialization of this option is done after reading the ".vimrc"
5884 and the other initializations, so that when the 'shell' option is set
5885 there, the 'shellpipe' option changes automatically, unless it was
5886 explicitly set before.
5887 When 'shellpipe' is set to an empty string, no redirection of the
5888 ":make" output will be done. This is useful if you use a 'makeprg'
5889 that writes to 'makeef' by itself. If you want no piping, but do
5890 want to include the 'makeef', set 'shellpipe' to a single space.
5891 Don't forget to precede the space with a backslash: ":set sp=\ ".
5892 In the future pipes may be used for filtering and this option will
5893 become obsolete (at least for Unix).
5894 This option cannot be set from a |modeline| or in the |sandbox|, for
5895 security reasons.
5896
5897 *'shellquote'* *'shq'*
5898'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5899 contains "sh" somewhere: "\"")
5900 global
5901 {not in Vi}
5902 Quoting character(s), put around the command passed to the shell, for
5903 the "!" and ":!" commands. The redirection is kept outside of the
5904 quoting. See 'shellxquote' to include the redirection. It's
5905 probably not useful to set both options.
5906 This is an empty string by default. Only known to be useful for
5907 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5908 or bash, where it should be "\"". The default is adjusted according
5909 the value of 'shell', to reduce the need to set this option by the
5910 user. See |dos-shell|.
5911 This option cannot be set from a |modeline| or in the |sandbox|, for
5912 security reasons.
5913
5914 *'shellredir'* *'srr'*
5915'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5916 global
5917 {not in Vi}
5918 String to be used to put the output of a filter command in a temporary
5919 file. See also |:!|. See |option-backslash| about including spaces
5920 and backslashes.
5921 The name of the temporary file can be represented by "%s" if necessary
5922 (the file name is appended automatically if no %s appears in the value
5923 of this option).
5924 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5925 or "zsh" during initializations, the default becomes ">&". If the
5926 'shell' option is "sh", "ksh" or "bash" the default becomes
5927 ">%s 2>&1". This means that stderr is also included.
5928 For Win32, the Unix checks are done and additionally "cmd" is checked
5929 for, which makes the default ">%s 2>&1". Also, the same names with
5930 ".exe" appended are checked for.
5931 The initialization of this option is done after reading the ".vimrc"
5932 and the other initializations, so that when the 'shell' option is set
5933 there, the 'shellredir' option changes automatically unless it was
5934 explicitly set before.
5935 In the future pipes may be used for filtering and this option will
5936 become obsolete (at least for Unix).
5937 This option cannot be set from a |modeline| or in the |sandbox|, for
5938 security reasons.
5939
5940 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5941'shellslash' 'ssl' boolean (default off)
5942 global
5943 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5944 When set, a forward slash is used when expanding file names. This is
5945 useful when a Unix-like shell is used instead of command.com or
5946 cmd.exe. Backward slashes can still be typed, but they are changed to
5947 forward slashes by Vim.
5948 Note that setting or resetting this option has no effect for some
5949 existing file names, thus this option needs to be set before opening
5950 any file for best results. This might change in the future.
5951 'shellslash' only works when a backslash can be used as a path
5952 separator. To test if this is so use: >
5953 if exists('+shellslash')
5954<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005955 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5956'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5957 global
5958 {not in Vi}
5959 When on, use temp files for shell commands. When off use a pipe.
5960 When using a pipe is not possible temp files are used anyway.
5961 Currently a pipe is only supported on Unix. You can check it with: >
5962 :if has("filterpipe")
5963< The advantage of using a pipe is that nobody can read the temp file
5964 and the 'shell' command does not need to support redirection.
5965 The advantage of using a temp file is that the file type and encoding
5966 can be detected.
5967 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5968 |FilterWritePost| autocommands event are not triggered when
5969 'shelltemp' is off.
5970
Bram Moolenaar071d4272004-06-13 20:20:40 +00005971 *'shelltype'* *'st'*
5972'shelltype' 'st' number (default 0)
5973 global
5974 {not in Vi} {only for the Amiga}
5975 On the Amiga this option influences the way how the commands work
5976 which use a shell.
5977 0 and 1: always use the shell
5978 2 and 3: use the shell only to filter lines
5979 4 and 5: use shell only for ':sh' command
5980 When not using the shell, the command is executed directly.
5981
5982 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5983 1 and 3: use "shell cmd" to start external commands
5984
5985 *'shellxquote'* *'sxq'*
5986'shellxquote' 'sxq' string (default: "";
5987 for Win32, when 'shell' contains "sh"
5988 somewhere: "\""
5989 for Unix, when using system(): "\"")
5990 global
5991 {not in Vi}
5992 Quoting character(s), put around the command passed to the shell, for
5993 the "!" and ":!" commands. Includes the redirection. See
5994 'shellquote' to exclude the redirection. It's probably not useful
5995 to set both options.
5996 This is an empty string by default. Known to be useful for
5997 third-party shells when using the Win32 version, such as the MKS Korn
5998 Shell or bash, where it should be "\"". The default is adjusted
5999 according the value of 'shell', to reduce the need to set this option
6000 by the user. See |dos-shell|.
6001 This option cannot be set from a |modeline| or in the |sandbox|, for
6002 security reasons.
6003
6004 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6005'shiftround' 'sr' boolean (default off)
6006 global
6007 {not in Vi}
6008 Round indent to multiple of 'shiftwidth'. Applies to > and <
6009 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6010 a multiple of 'shiftwidth' (this is Vi compatible).
6011 NOTE: This option is reset when 'compatible' is set.
6012
6013 *'shiftwidth'* *'sw'*
6014'shiftwidth' 'sw' number (default 8)
6015 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006016 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006017 |'cindent'|, |>>|, |<<|, etc.
6018
6019 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006020'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6021 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006022 global
6023 {not in Vi}
6024 This option helps to avoid all the |hit-enter| prompts caused by file
6025 messages, for example with CTRL-G, and to avoid some other messages.
6026 It is a list of flags:
6027 flag meaning when present ~
6028 f use "(3 of 5)" instead of "(file 3 of 5)"
6029 i use "[noeol]" instead of "[Incomplete last line]"
6030 l use "999L, 888C" instead of "999 lines, 888 characters"
6031 m use "[+]" instead of "[Modified]"
6032 n use "[New]" instead of "[New File]"
6033 r use "[RO]" instead of "[readonly]"
6034 w use "[w]" instead of "written" for file write message
6035 and "[a]" instead of "appended" for ':w >> file' command
6036 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6037 "[unix format]" and "[mac]" instead of "[mac format]".
6038 a all of the above abbreviations
6039
6040 o overwrite message for writing a file with subsequent message
6041 for reading a file (useful for ":wn" or when 'autowrite' on)
6042 O message for reading a file overwrites any previous message.
6043 Also for quickfix message (e.g., ":cn").
6044 s don't give "search hit BOTTOM, continuing at TOP" or "search
6045 hit TOP, continuing at BOTTOM" messages
6046 t truncate file message at the start if it is too long to fit
6047 on the command-line, "<" will appear in the left most column.
6048 Ignored in Ex mode.
6049 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006050 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006051 Ignored in Ex mode.
6052 W don't give "written" or "[w]" when writing a file
6053 A don't give the "ATTENTION" message when an existing swap file
6054 is found.
6055 I don't give the intro message when starting Vim |:intro|.
6056
6057 This gives you the opportunity to avoid that a change between buffers
6058 requires you to hit <Enter>, but still gives as useful a message as
6059 possible for the space available. To get the whole message that you
6060 would have got with 'shm' empty, use ":file!"
6061 Useful values:
6062 shm= No abbreviation of message.
6063 shm=a Abbreviation, but no loss of information.
6064 shm=at Abbreviation, and truncate message when necessary.
6065
6066 NOTE: This option is set to the Vi default value when 'compatible' is
6067 set and to the Vim default value when 'compatible' is reset.
6068
6069 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6070'shortname' 'sn' boolean (default off)
6071 local to buffer
6072 {not in Vi, not in MS-DOS versions}
6073 Filenames are assumed to be 8 characters plus one extension of 3
6074 characters. Multiple dots in file names are not allowed. When this
6075 option is on, dots in file names are replaced with underscores when
6076 adding an extension (".~" or ".swp"). This option is not available
6077 for MS-DOS, because then it would always be on. This option is useful
6078 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6079 or crossdos. When running the Win32 GUI version under Win32s, this
6080 option is always on by default.
6081
6082 *'showbreak'* *'sbr'* *E595*
6083'showbreak' 'sbr' string (default "")
6084 global
6085 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006086 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006087 feature}
6088 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006089 values are "> " or "+++ ": >
6090 :set showbreak=>\
6091< Note the backslash to escape the trailing space. It's easier like
6092 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006093 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006094< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095 comma (in a future version the comma might be used to separate the
6096 part that is shown at the end and at the start of a line).
6097 The characters are highlighted according to the '@' flag in
6098 'highlight'.
6099 Note that tabs after the showbreak will be displayed differently.
6100 If you want the 'showbreak' to appear in between line numbers, add the
6101 "n" flag to 'cpoptions'.
6102
6103 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6104'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6105 off)
6106 global
6107 {not in Vi}
6108 {not available when compiled without the
6109 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006110 Show (partial) command in the last line of the screen. Set this
6111 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006112 In Visual mode the size of the selected area is shown:
6113 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006114 If the number of bytes is different it is also displayed: "2-6"
6115 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006117 - When selecting a block, the size in screen characters:
6118 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119 NOTE: This option is set to the Vi default value when 'compatible' is
6120 set and to the Vim default value when 'compatible' is reset.
6121
6122 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6123'showfulltag' 'sft' boolean (default off)
6124 global
6125 {not in Vi}
6126 When completing a word in insert mode (see |ins-completion|) from the
6127 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006128 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 matched a C function, you can see a template for what arguments are
6130 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006131 Note that this doesn't work well together with having "longest" in
6132 'completeopt', because the completion from the search pattern may not
6133 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134
6135 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6136'showmatch' 'sm' boolean (default off)
6137 global
6138 When a bracket is inserted, briefly jump to the matching one. The
6139 jump is only done if the match can be seen on the screen. The time to
6140 show the match can be set with 'matchtime'.
6141 A Beep is given if there is no match (no matter if the match can be
6142 seen or not). This option is reset when the 'paste' option is set.
6143 When the 'm' flag is not included in 'cpoptions', typing a character
6144 will immediately move the cursor back to where it belongs.
6145 See the "sm" field in 'guicursor' for setting the cursor shape and
6146 blinking when showing the match.
6147 The 'matchpairs' option can be used to specify the characters to show
6148 matches for. 'rightleft' and 'revins' are used to look for opposite
6149 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006150 Also see the matchparen plugin for highlighting the match when moving
6151 around |pi_paren.txt|.
6152 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153
6154 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6155'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6156 global
6157 If in Insert, Replace or Visual mode put a message on the last line.
6158 Use the 'M' flag in 'highlight' to set the type of highlighting for
6159 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006160 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006161 doesn't mean XIM is really active, especially when 'imactivatekey' is
6162 not set.
6163 NOTE: This option is set to the Vi default value when 'compatible' is
6164 set and to the Vim default value when 'compatible' is reset.
6165
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006166 *'showtabline'* *'stal'*
6167'showtabline' 'stal' number (default 1)
6168 global
6169 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006170 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006171 feature}
6172 The value of this option specifies when the line with tab page labels
6173 will be displayed:
6174 0: never
6175 1: only if there are at least two tab pages
6176 2: always
6177 This is both for the GUI and non-GUI implementation of the tab pages
6178 line.
6179 See |tab-page| for more information about tab pages.
6180
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 *'sidescroll'* *'ss'*
6182'sidescroll' 'ss' number (default 0)
6183 global
6184 {not in Vi}
6185 The minimal number of columns to scroll horizontally. Used only when
6186 the 'wrap' option is off and the cursor is moved off of the screen.
6187 When it is zero the cursor will be put in the middle of the screen.
6188 When using a slow terminal set it to a large number or 0. When using
6189 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6190 commands.
6191
6192 *'sidescrolloff'* *'siso'*
6193'sidescrolloff' 'siso' number (default 0)
6194 global
6195 {not in Vi}
6196 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006197 right of the cursor if 'nowrap' is set. Setting this option to a
6198 value greater than 0 while having |'sidescroll'| also at a non-zero
6199 value makes some context visible in the line you are scrolling in
6200 horizontally (except at beginning of the line). Setting this option
6201 to a large value (like 999) has the effect of keeping the cursor
6202 horizontally centered in the window, as long as one does not come too
6203 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 NOTE: This option is set to 0 when 'compatible' is set.
6205
6206 Example: Try this together with 'sidescroll' and 'listchars' as
6207 in the following example to never allow the cursor to move
6208 onto the "extends" character:
6209
6210 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6211 :set sidescrolloff=1
6212
6213
6214 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6215'smartcase' 'scs' boolean (default off)
6216 global
6217 {not in Vi}
6218 Override the 'ignorecase' option if the search pattern contains upper
6219 case characters. Only used when the search pattern is typed and
6220 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006221 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006222 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6223 recalling the search pattern from history and hitting <Enter>.
6224 NOTE: This option is reset when 'compatible' is set.
6225
6226 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6227'smartindent' 'si' boolean (default off)
6228 local to buffer
6229 {not in Vi}
6230 {not available when compiled without the
6231 |+smartindent| feature}
6232 Do smart autoindenting when starting a new line. Works for C-like
6233 programs, but can also be used for other languages. 'cindent' does
6234 something like this, works better in most cases, but is more strict,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006235 see |C-indenting|. When 'cindent' is on or 'smartindent' is set,
6236 setting 'si' has no effect. 'indentexpr' is a more advanced
6237 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006238 Normally 'autoindent' should also be on when using 'smartindent'.
6239 An indent is automatically inserted:
6240 - After a line ending in '{'.
6241 - After a line starting with a keyword from 'cinwords'.
6242 - Before a line starting with '}' (only with the "O" command).
6243 When typing '}' as the first character in a new line, that line is
6244 given the same indent as the matching '{'.
6245 When typing '#' as the first character in a new line, the indent for
6246 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006247 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6249 When using the ">>" command, lines starting with '#' are not shifted
6250 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006251 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006252 is set smart indenting is disabled.
6253
6254 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6255'smarttab' 'sta' boolean (default off)
6256 global
6257 {not in Vi}
6258 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006259 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6260 <BS> will delete a 'shiftwidth' worth of space at the start of the
6261 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006262 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006263 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6264 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006265 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006267 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006268 NOTE: This option is reset when 'compatible' is set.
6269
6270 *'softtabstop'* *'sts'*
6271'softtabstop' 'sts' number (default 0)
6272 local to buffer
6273 {not in Vi}
6274 Number of spaces that a <Tab> counts for while performing editing
6275 operations, like inserting a <Tab> or using <BS>. It "feels" like
6276 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6277 used. This is useful to keep the 'ts' setting at its standard value
6278 of 8, while being able to edit like it is set to 'sts'. However,
6279 commands like "x" still work on the actual characters.
6280 When 'sts' is zero, this feature is off.
6281 'softtabstop' is set to 0 when the 'paste' option is set.
6282 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6283 spaces is minimized by using <Tab>s.
6284 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6285 set.
6286 NOTE: This option is set to 0 when 'compatible' is set.
6287
Bram Moolenaar217ad922005-03-20 22:37:15 +00006288 *'spell'* *'nospell'*
6289'spell' boolean (default off)
6290 local to window
6291 {not in Vi}
6292 {not available when compiled without the |+syntax|
6293 feature}
6294 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006295 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006296
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006297 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006298'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006299 local to buffer
6300 {not in Vi}
6301 {not available when compiled without the |+syntax|
6302 feature}
6303 Pattern to locate the end of a sentence. The following word will be
6304 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006305 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006306 When this check is not wanted make this option empty.
6307 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006308 Be careful with special characters, see |option-backslash| about
6309 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006310 To set this option automatically depending on the language, see
6311 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006312
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006313 *'spellfile'* *'spf'*
6314'spellfile' 'spf' string (default empty)
6315 local to buffer
6316 {not in Vi}
6317 {not available when compiled without the |+syntax|
6318 feature}
6319 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006320 commands. It must end in ".{encoding}.add". You need to include the
6321 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006322 *E765*
6323 It may also be a comma separated list of names. A count before the
6324 |zg| and |zw| commands can be used to access each. This allows using
6325 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006326 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006327 you: Using the first directory in 'runtimepath' that is writable. If
6328 there is no "spell" directory yet it will be created. For the file
6329 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006330 ignoring the region.
6331 The resulting ".spl" file will be used for spell checking, it does not
6332 have to appear in 'spelllang'.
6333 Normally one file is used for all regions, but you can add the region
6334 name if you want to. However, it will then only be used when
6335 'spellfile' is set to it, for entries in 'spelllang' only files
6336 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006337 This option cannot be set from a |modeline| or in the |sandbox|, for
6338 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006339
Bram Moolenaar217ad922005-03-20 22:37:15 +00006340 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006341'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006342 local to buffer
6343 {not in Vi}
6344 {not available when compiled without the |+syntax|
6345 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006346 A comma separated list of word list names. When the 'spell' option is
6347 on spellchecking will be done for these languages. Example: >
6348 set spelllang=en_us,nl,medical
6349< This means US English, Dutch and medical words are recognized. Words
6350 that are not recognized will be highlighted.
6351 The word list name must not include a comma or dot. Using a dash is
6352 recommended to separate the two letter language name from a
6353 specification. Thus "en-rare" is used for rare English words.
6354 A region name must come last and have the form "_xx", where "xx" is
6355 the two-letter, lower case region name. You can use more than one
6356 region by listing them: "en_us,en_ca" supports both US and Canadian
6357 English, but not words specific for Australia, New Zealand or Great
6358 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006359 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006360 As a special case the name of a .spl file can be given as-is. The
6361 first "_xx" in the name is removed and used as the region name
6362 (_xx is an underscore, two letters and followed by a non-letter).
6363 This is mainly for testing purposes. You must make sure the correct
6364 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006365 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006366 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6367 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006368 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006369
Bram Moolenaar98692072006-02-04 00:57:42 +00006370 If the |spellfile.vim| plugin is active and you use a language name
6371 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6372 will ask you if you want to download the file.
6373
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006374 After this option has been set successfully, Vim will source the files
6375 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006376 up to the first comma, dot or underscore.
6377 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006378
6379
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006380 *'spellsuggest'* *'sps'*
6381'spellsuggest' 'sps' string (default "best")
6382 global
6383 {not in Vi}
6384 {not available when compiled without the |+syntax|
6385 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006386 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006387 the |spellsuggest()| function. This is a comma-separated list of
6388 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006389
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006390 best Internal method that works best for English. Finds
6391 changes like "fast" and uses a bit of sound-a-like
6392 scoring to improve the ordering.
6393
6394 double Internal method that uses two methods and mixes the
6395 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006396 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006397 word. That only works when the language specifies
6398 sound folding. Can be slow and doesn't always give
6399 better results.
6400
6401 fast Internal method that only checks for simple changes:
6402 character inserts/deletes/swaps. Works well for
6403 simple typing mistakes.
6404
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006405 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006406 Not used for |spellsuggest()|. The number of
6407 suggestions is never more than the value of 'lines'
6408 minus two.
6409
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006410 file:{filename} Read file {filename}, which must have two columns,
6411 separated by a slash. The first column contains the
6412 bad word, the second column the suggested good word.
6413 Example:
6414 theribal/terrible ~
6415 Use this for common mistakes that do not appear at the
6416 top of the suggestion list with the internal methods.
6417 Lines without a slash are ignored, use this for
6418 comments.
6419 The file is used for all languages.
6420
6421 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6422 trouble with spaces. |v:val| holds the badly spelled
6423 word. The expression must evaluate to a List of
6424 Lists, each with a suggestion and a score.
6425 Example:
6426 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006427 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006428 internal methods use. A lower score is better.
6429 This may invoke |spellsuggest()| if you temporarily
6430 set 'spellsuggest' to exclude the "expr:" part.
6431 Errors are silently ignored, unless you set the
6432 'verbose' option to a non-zero value.
6433
6434 Only one of "best", "double" or "fast" may be used. The others may
6435 appear several times in any order. Example: >
6436 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6437<
6438 This option cannot be set from a |modeline| or in the |sandbox|, for
6439 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006440
6441
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6443'splitbelow' 'sb' boolean (default off)
6444 global
6445 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006446 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 feature}
6448 When on, splitting a window will put the new window below the current
6449 one. |:split|
6450
6451 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6452'splitright' 'spr' boolean (default off)
6453 global
6454 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006455 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 feature}
6457 When on, splitting a window will put the new window right of the
6458 current one. |:vsplit|
6459
6460 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6461'startofline' 'sol' boolean (default on)
6462 global
6463 {not in Vi}
6464 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006465 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006466 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006467 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 with a linewise operator, with "%" with a count and to buffer changing
6469 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6470 only has a line number, e.g., ":25" or ":+".
6471 In case of buffer changing commands the cursor is placed at the column
6472 where it was the last time the buffer was edited.
6473 NOTE: This option is set when 'compatible' is set.
6474
6475 *'statusline'* *'stl'* *E540* *E541* *E542*
6476'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006477 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006478 {not in Vi}
6479 {not available when compiled without the |+statusline|
6480 feature}
6481 When nonempty, this option determines the content of the status line.
6482 Also see |status-line|.
6483
6484 The option consists of printf style '%' items interspersed with
6485 normal text. Each status line item is of the form:
6486 %-0{minwid}.{maxwid}{item}
6487 All fields except the {item} is optional. A single percent sign can
6488 be given as "%%". Up to 80 items can be specified.
6489
Bram Moolenaar238a5642006-02-21 22:12:05 +00006490 When the option starts with "%!" then it is used as an expression,
6491 evaluated and the result is used as the option value. Example: >
6492 :set statusline=%!MyStatusLine()
6493< The result can contain %{} items that will be evaluated too.
6494
6495 When there is error while evaluating the option then it will be made
6496 empty to avoid further errors. Otherwise screen updating would loop.
6497
Bram Moolenaar071d4272004-06-13 20:20:40 +00006498 Note that the only effect of 'ruler' when this option is set (and
6499 'laststatus' is 2) is controlling the output of |CTRL-G|.
6500
6501 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006502 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006504 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 minwid Minimum width of the item, padding as set by '-' & '0'.
6506 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006507 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006508 on the left for text items. Numeric items will be
6509 shifted down to maxwid-2 digits followed by '>'number
6510 where number is the amount of missing digits, much like
6511 an exponential notation.
6512 item A one letter code as described below.
6513
6514 Following is a description of the possible statusline items. The
6515 second character in "item" is the type:
6516 N for number
6517 S for string
6518 F for flags as described below
6519 - not applicable
6520
6521 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006522 f S Path to the file in the buffer, as typed or relative to current
6523 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 F S Full path to the file in the buffer.
6525 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006526 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006527 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006528 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006529 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006530 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006531 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006532 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006534 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6536 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006537 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006538 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6539 being used: "<keymap>"
6540 n N Buffer number.
6541 b N Value of byte under cursor.
6542 B N As above, in hexadecimal.
6543 o N Byte number in file of byte under cursor, first byte is 1.
6544 Mnemonic: Offset from start of file (with one added)
6545 {not available when compiled without |+byte_offset| feature}
6546 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006547 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 l N Line number.
6549 L N Number of lines in buffer.
6550 c N Column number.
6551 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006552 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006553 p N Percentage through file in lines as in |CTRL-G|.
6554 P S Percentage through file of displayed window. This is like the
6555 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006556 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006558 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006559 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006560 ( - Start of item group. Can be used for setting the width and
6561 alignment of a section. Must be followed by %) somewhere.
6562 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006563 T N For 'tabline': start of tab page N label. Use %T after the last
6564 label. This information is used for mouse clicks.
6565 X N For 'tabline': start of close tab N label. Use %X after the
6566 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6567 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006568 < - Where to truncate line if too long. Default is at the start.
6569 No width fields allowed.
6570 = - Separation point between left and right aligned items.
6571 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006572 # - Set highlight group. The name must follow and then a # again.
6573 Thus use %#HLname# for highlight group HLname. The same
6574 highlighting is used, also for the statusline of non-current
6575 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006576 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006577 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006578 The difference between User{N} and StatusLine will be applied
6579 to StatusLineNC for the statusline of non-current windows.
6580 The number N must be between 1 and 9. See |hl-User1..9|
6581
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006582 When displaying a flag, Vim removes the leading comma, if any, when
6583 that flag comes right after plaintext. This will make a nice display
6584 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006585
Bram Moolenaar582fd852005-03-28 20:58:01 +00006586 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006587 not set) and a minwid is not set for the group, the whole group will
6588 become empty. This will make a group like the following disappear
6589 completely from the statusline when none of the flags are set. >
6590 :set statusline=...%(\ [%M%R%H]%)...
6591<
6592 Beware that an expression is evaluated each and every time the status
6593 line is displayed. The current buffer and current window will be set
6594 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006595 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006597 real current buffer.
6598
6599 The 'statusline' option may be evaluated in the |sandbox|, see
6600 |sandbox-option|.
6601
6602 It is not allowed to change text or jump to another window while
6603 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006604
6605 If the statusline is not updated when you want it (e.g., after setting
6606 a variable that's used in an expression), you can force an update by
6607 setting an option without changing its value. Example: >
6608 :let &ro = &ro
6609
6610< A result of all digits is regarded a number for display purposes.
6611 Otherwise the result is taken as flag text and applied to the rules
6612 described above.
6613
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006614 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006615 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6616 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6617
6618 Examples:
6619 Emulate standard status line with 'ruler' set >
6620 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6621< Similar, but add ASCII value of char under the cursor (like "ga") >
6622 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6623< Display byte count and byte value, modified flag in red. >
6624 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6625 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6626< Display a ,GZ flag if a compressed file is loaded >
6627 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6628< In the |:autocmd|'s: >
6629 :let b:gzflag = 1
6630< And: >
6631 :unlet b:gzflag
6632< And define this function: >
6633 :function VarExists(var, val)
6634 : if exists(a:var) | return a:val | else | return '' | endif
6635 :endfunction
6636<
6637 *'suffixes'* *'su'*
6638'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6639 global
6640 {not in Vi}
6641 Files with these suffixes get a lower priority when multiple files
6642 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006643 suffixes. Spaces after the comma are ignored. A dot is also seen as
6644 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006645 separator, precede it with a backslash (see |option-backslash| about
6646 including spaces and backslashes).
6647 See 'wildignore' for completely ignoring files.
6648 The use of |:set+=| and |:set-=| is preferred when adding or removing
6649 suffixes from the list. This avoids problems when a future version
6650 uses another default.
6651
6652 *'suffixesadd'* *'sua'*
6653'suffixesadd' 'sua' string (default "")
6654 local to buffer
6655 {not in Vi}
6656 {not available when compiled without the
6657 |+file_in_path| feature}
6658 Comma separated list of suffixes, which are used when searching for a
6659 file for the "gf", "[I", etc. commands. Example: >
6660 :set suffixesadd=.java
6661<
6662 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6663'swapfile' 'swf' boolean (default on)
6664 local to buffer
6665 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006666 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 swapfile is not wanted for a specific buffer. For example, with
6668 confidential information that even root must not be able to access.
6669 Careful: All text will be in memory:
6670 - Don't use this for big files.
6671 - Recovery will be impossible!
6672 A swapfile will only be present when |'updatecount'| is non-zero and
6673 'swapfile' is set.
6674 When 'swapfile' is reset, the swap file for the current buffer is
6675 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6676 non-zero, a swap file is immediately created.
6677 Also see |swap-file| and |'swapsync'|.
6678
6679 This option is used together with 'bufhidden' and 'buftype' to
6680 specify special kinds of buffers. See |special-buffers|.
6681
6682 *'swapsync'* *'sws'*
6683'swapsync' 'sws' string (default "fsync")
6684 global
6685 {not in Vi}
6686 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006687 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 When this option is empty parts of the swap file may be in memory and
6689 not written to disk. When the system crashes you may lose more work.
6690 On Unix the system does a sync now and then without Vim asking for it,
6691 so the disadvantage of setting this option off is small. On some
6692 systems the swap file will not be written at all. For a unix system
6693 setting it to "sync" will use the sync() call instead of the default
6694 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006695 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006696
6697 *'switchbuf'* *'swb'*
6698'switchbuf' 'swb' string (default "")
6699 global
6700 {not in Vi}
6701 This option controls the behavior when switching between buffers.
6702 Possible values (comma separated list):
6703 useopen If included, jump to the first open window that
6704 contains the specified buffer (if there is one).
6705 Otherwise: Do not examine other windows.
6706 This setting is checked with |quickfix| commands, when
6707 jumping to errors (":cc", ":cn", "cp", etc.). It is
6708 also used in all buffer related split commands, for
6709 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006710 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006711 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006712 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006713 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006715 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006716 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006717
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006718 *'synmaxcol'* *'smc'*
6719'synmaxcol' 'smc' number (default 3000)
6720 local to buffer
6721 {not in Vi}
6722 {not available when compiled without the |+syntax|
6723 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006724 Maximum column in which to search for syntax items. In long lines the
6725 text after this column is not highlighted and following lines may not
6726 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006727 This helps to avoid very slow redrawing for an XML file that is one
6728 long line.
6729 Set to zero to remove the limit.
6730
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 *'syntax'* *'syn'*
6732'syntax' 'syn' string (default empty)
6733 local to buffer
6734 {not in Vi}
6735 {not available when compiled without the |+syntax|
6736 feature}
6737 When this option is set, the syntax with this name is loaded, unless
6738 syntax highlighting has been switched off with ":syntax off".
6739 Otherwise this option does not always reflect the current syntax (the
6740 b:current_syntax variable does).
6741 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006742 not automatically recognized. Example, in an IDL file:
6743 /* vim: set syntax=idl : */ ~
6744 When a dot appears in the value then this separates two filetype
6745 names. Example:
6746 /* vim: set syntax=c.doxygen : */ ~
6747 This will use the "c" syntax first, then the "doxygen" syntax.
6748 Note that the second one must be prepared to be loaded as an addition,
6749 otherwise it will be skipped. More than one dot may appear.
6750 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 :set syntax=OFF
6752< To switch syntax highlighting on according to the current value of the
6753 'filetype' option: >
6754 :set syntax=ON
6755< What actually happens when setting the 'syntax' option is that the
6756 Syntax autocommand event is triggered with the value as argument.
6757 This option is not copied to another buffer, independent of the 's' or
6758 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006759 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006761 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006762'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006763 global
6764 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006765 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006766 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006767 When nonempty, this option determines the content of the tab pages
6768 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006769 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006770
6771 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006772 option and only when there is no GUI tab line. When 'e' is in
6773 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006774 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006775
6776 The value is evaluated like with 'statusline'. You can use
6777 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006778 the text to be displayed. Use "%1T" for the first label, "%2T" for
6779 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006780
6781 Keep in mind that only one of the tab pages is the current one, others
6782 are invisible and you can't jump to their windows.
6783
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006784
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006785 *'tabpagemax'* *'tpm'*
6786'tabpagemax' 'tpm' number (default 10)
6787 global
6788 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006789 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006790 feature}
6791 Maximum number of tab pages to be opened by the |-p| command line
6792 argument or the ":tab all" command. |tabpage|
6793
6794
6795 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796'tabstop' 'ts' number (default 8)
6797 local to buffer
6798 Number of spaces that a <Tab> in the file counts for. Also see
6799 |:retab| command, and 'softtabstop' option.
6800
6801 Note: Setting 'tabstop' to any other value than 8 can make your file
6802 appear wrong in many places (e.g., when printing it).
6803
6804 There are four main ways to use tabs in Vim:
6805 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6806 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006807 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006808 behave like a tab appears every 4 (or 3) characters.
6809 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6810 'expandtab'. This way you will always insert spaces. The
6811 formatting will never be messed up when 'tabstop' is changed.
6812 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006813 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006814 works when using Vim to edit the file.
6815 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6816 'noexpandtab'. This should then work (for initial indents only)
6817 for any tabstop setting that people use. It might be nice to have
6818 tabs after the first non-blank inserted as spaces if you do this
6819 though. Otherwise aligned comments will be wrong when 'tabstop' is
6820 changed.
6821
6822 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6823'tagbsearch' 'tbs' boolean (default on)
6824 global
6825 {not in Vi}
6826 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006827 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006828 searching makes searching for a tag a LOT faster, but a linear search
6829 will find more tags if the tags file wasn't properly sorted.
6830 Vim normally assumes that your tags files are sorted, or indicate that
6831 they are not sorted. Only when this is not the case does the
6832 'tagbsearch' option need to be switched off.
6833
6834 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006835 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836 certain files, or retry all files with a linear search. When
6837 'tagbsearch' is off, only a linear search is done.
6838
6839 Linear searching is done anyway, for one file, when Vim finds a line
6840 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006841 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006842< [The whitespace before and after the '0' must be a single <Tab>]
6843
6844 When a binary search was done and no match was found in any of the
6845 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6846 instead of a normal tag name, a retry is done with a linear search.
6847 Tags in unsorted tags files, and matches with different case will only
6848 be found in the retry.
6849
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006850 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851 linear search can be avoided for the 'ignorecase' case. Use a value
6852 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6853 case-fold sorted with the -f switch to "sort" in most unices, as in
6854 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006855 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6856 for this as well. Note that case must be folded to uppercase for this
6857 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858
6859 When 'tagbsearch' is off, tags searching is slower when a full match
6860 exists, but faster when no full match exists. Tags in unsorted tags
6861 files may only be found with 'tagbsearch' off.
6862 When the tags file is not sorted, or sorted in a wrong way (not on
6863 ASCII byte value), 'tagbsearch' should be off, or the line given above
6864 must be included in the tags file.
6865 This option doesn't affect commands that find all matching tags (e.g.,
6866 command-line completion and ":help").
6867 {Vi: always uses binary search in some versions}
6868
6869 *'taglength'* *'tl'*
6870'taglength' 'tl' number (default 0)
6871 global
6872 If non-zero, tags are significant up to this number of characters.
6873
6874 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6875'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6876 global
6877 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006878 If on and using a tags file in another directory, file names in that
6879 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006880 NOTE: This option is set to the Vi default value when 'compatible' is
6881 set and to the Vim default value when 'compatible' is reset.
6882
6883 *'tags'* *'tag'* *E433*
6884'tags' 'tag' string (default "./tags,tags", when compiled with
6885 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6886 global or local to buffer |global-local|
6887 Filenames for the tag command, separated by spaces or commas. To
6888 include a space or comma in a file name, precede it with a backslash
6889 (see |option-backslash| about including spaces and backslashes).
6890 When a file name starts with "./", the '.' is replaced with the path
6891 of the current file. But only when the 'd' flag is not included in
6892 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6893 |tags-option|.
6894 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006895 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6896 find all files named "tags" below "/lib". The filename itself cannot
6897 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6898 files called "tags?". {not available when compiled without the
6899 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006900 The |tagfiles()| function can be used to get a list of the file names
6901 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006902 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6903 files are also supported. They are automatically recognized. The
6904 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6905 differences are ignored (MS-Windows). |emacs-tags|
6906 The use of |:set+=| and |:set-=| is preferred when adding or removing
6907 file names from the list. This avoids problems when a future version
6908 uses another default.
6909 {Vi: default is "tags /usr/lib/tags"}
6910
6911 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6912'tagstack' 'tgst' boolean (default on)
6913 global
6914 {not in all versions of Vi}
6915 When on, the |tagstack| is used normally. When off, a ":tag" or
6916 ":tselect" command with an argument will not push the tag onto the
6917 tagstack. A following ":tag" without an argument, a ":pop" command or
6918 any other command that uses the tagstack will use the unmodified
6919 tagstack, but does change the pointer to the active entry.
6920 Resetting this option is useful when using a ":tag" command in a
6921 mapping which should not change the tagstack.
6922
6923 *'term'* *E529* *E530* *E531*
6924'term' string (default is $TERM, if that fails:
6925 in the GUI: "builtin_gui"
6926 on Amiga: "amiga"
6927 on BeOS: "beos-ansi"
6928 on Mac: "mac-ansi"
6929 on MiNT: "vt52"
6930 on MS-DOS: "pcterm"
6931 on OS/2: "os2ansi"
6932 on Unix: "ansi"
6933 on VMS: "ansi"
6934 on Win 32: "win32")
6935 global
6936 Name of the terminal. Used for choosing the terminal control
6937 characters. Environment variables are expanded |:set_env|.
6938 For example: >
6939 :set term=$TERM
6940< See |termcap|.
6941
6942 *'termbidi'* *'tbidi'*
6943 *'notermbidi'* *'notbidi'*
6944'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6945 global
6946 {not in Vi}
6947 {only available when compiled with the |+arabic|
6948 feature}
6949 The terminal is in charge of Bi-directionality of text (as specified
6950 by Unicode). The terminal is also expected to do the required shaping
6951 that some languages (such as Arabic) require.
6952 Setting this option implies that 'rightleft' will not be set when
6953 'arabic' is set and the value of 'arabicshape' will be ignored.
6954 Note that setting 'termbidi' has the immediate effect that
6955 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6956 This option is reset when the GUI is started.
6957 For further details see |arabic.txt|.
6958
6959 *'termencoding'* *'tenc'*
6960'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6961 Macintosh GUI: "macroman")
6962 global
6963 {only available when compiled with the |+multi_byte|
6964 feature}
6965 {not in Vi}
6966 Encoding used for the terminal. This specifies what character
6967 encoding the keyboard produces and the display will understand. For
6968 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006969 display). Except for the Mac when 'macatsui' is off, then
6970 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006971 In the Win32 console version the default value is the console codepage
6972 when it differs from the ANSI codepage.
6973 *E617*
6974 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6975 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6976 Any attempts to set a different value will be rejected, and an error
6977 message is shown.
6978 For the Win32 GUI 'termencoding' is not used for typed characters,
6979 because the Win32 system always passes Unicode characters.
6980 When empty, the same encoding is used as for the 'encoding' option.
6981 This is the normal value.
6982 Not all combinations for 'termencoding' and 'encoding' are valid. See
6983 |encoding-table|.
6984 The value for this option must be supported by internal conversions or
6985 iconv(). When this is not possible no conversion will be done and you
6986 will probably experience problems with non-ASCII characters.
6987 Example: You are working with the locale set to euc-jp (Japanese) and
6988 want to edit a UTF-8 file: >
6989 :let &termencoding = &encoding
6990 :set encoding=utf-8
6991< You need to do this when your system has no locale support for UTF-8.
6992
6993 *'terse'* *'noterse'*
6994'terse' boolean (default off)
6995 global
6996 When set: Add 's' flag to 'shortmess' option (this makes the message
6997 for a search that hits the start or end of the file not being
6998 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6999 shortens a lot of messages}
7000
7001 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7002'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7003 global
7004 {not in Vi}
7005 This option is obsolete. Use 'fileformats'.
7006 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7007 set to the default value for the current system. When 'textauto' is
7008 reset, 'fileformats' is made empty.
7009 NOTE: This option is set to the Vi default value when 'compatible' is
7010 set and to the Vim default value when 'compatible' is reset.
7011
7012 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7013'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7014 others: default off)
7015 local to buffer
7016 {not in Vi}
7017 This option is obsolete. Use 'fileformat'.
7018 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7019 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7020 "unix".
7021
7022 *'textwidth'* *'tw'*
7023'textwidth' 'tw' number (default 0)
7024 local to buffer
7025 {not in Vi}
7026 Maximum width of text that is being inserted. A longer line will be
7027 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007028 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7029 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007030 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007031 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007032 NOTE: This option is set to 0 when 'compatible' is set.
7033
7034 *'thesaurus'* *'tsr'*
7035'thesaurus' 'tsr' string (default "")
7036 global or local to buffer |global-local|
7037 {not in Vi}
7038 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007039 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007040 the file should contain words with similar meaning, separated by
7041 non-keyword characters (white space is preferred). Maximum line
7042 length is 510 bytes.
7043 To obtain a file to be used here, check out the wordlist FAQ at
7044 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007045 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007046 after a comma are ignored, otherwise spaces are included in the file
7047 name. See |option-backslash| about using backslashes.
7048 The use of |:set+=| and |:set-=| is preferred when adding or removing
7049 directories from the list. This avoids problems when a future version
7050 uses another default.
7051 Backticks cannot be used in this option for security reasons.
7052
7053 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7054'tildeop' 'top' boolean (default off)
7055 global
7056 {not in Vi}
7057 When on: The tilde command "~" behaves like an operator.
7058 NOTE: This option is reset when 'compatible' is set.
7059
7060 *'timeout'* *'to'* *'notimeout'* *'noto'*
7061'timeout' 'to' boolean (default on)
7062 global
7063 *'ttimeout'* *'nottimeout'*
7064'ttimeout' boolean (default off)
7065 global
7066 {not in Vi}
7067 These two options together determine the behavior when part of a
7068 mapped key sequence or keyboard code has been received:
7069
7070 'timeout' 'ttimeout' action ~
7071 off off do not time out
7072 on on or off time out on :mappings and key codes
7073 off on time out on key codes
7074
7075 If both options are off, Vim will wait until either the complete
7076 mapping or key sequence has been received, or it is clear that there
7077 is no mapping or key sequence for the received characters. For
7078 example: if you have mapped "vl" and Vim has received 'v', the next
7079 character is needed to see if the 'v' is followed by an 'l'.
7080 When one of the options is on, Vim will wait for about 1 second for
7081 the next character to arrive. After that the already received
7082 characters are interpreted as single characters. The waiting time can
7083 be changed with the 'timeoutlen' option.
7084 On slow terminals or very busy systems timing out may cause
7085 malfunctioning cursor keys. If both options are off, Vim waits
7086 forever after an entered <Esc> if there are key codes that start
7087 with <Esc>. You will have to type <Esc> twice. If you do not have
7088 problems with key codes, but would like to have :mapped key
7089 sequences not timing out in 1 second, set the 'ttimeout' option and
7090 reset the 'timeout' option.
7091
7092 NOTE: 'ttimeout' is reset when 'compatible' is set.
7093
7094 *'timeoutlen'* *'tm'*
7095'timeoutlen' 'tm' number (default 1000)
7096 global
7097 {not in all versions of Vi}
7098 *'ttimeoutlen'* *'ttm'*
7099'ttimeoutlen' 'ttm' number (default -1)
7100 global
7101 {not in Vi}
7102 The time in milliseconds that is waited for a key code or mapped key
7103 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7104 when part of a command has been typed.
7105 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7106 different timeout value for key codes is desired set 'ttimeoutlen' to
7107 a non-negative number.
7108
7109 ttimeoutlen mapping delay key code delay ~
7110 < 0 'timeoutlen' 'timeoutlen'
7111 >= 0 'timeoutlen' 'ttimeoutlen'
7112
7113 The timeout only happens when the 'timeout' and 'ttimeout' options
7114 tell so. A useful setting would be >
7115 :set timeout timeoutlen=3000 ttimeoutlen=100
7116< (time out on mapping after three seconds, time out on key codes after
7117 a tenth of a second).
7118
7119 *'title'* *'notitle'*
7120'title' boolean (default off, on when title can be restored)
7121 global
7122 {not in Vi}
7123 {not available when compiled without the |+title|
7124 feature}
7125 When on, the title of the window will be set to the value of
7126 'titlestring' (if it is not empty), or to:
7127 filename [+=-] (path) - VIM
7128 Where:
7129 filename the name of the file being edited
7130 - indicates the file cannot be modified, 'ma' off
7131 + indicates the file was modified
7132 = indicates the file is read-only
7133 =+ indicates the file is read-only and modified
7134 (path) is the path of the file being edited
7135 - VIM the server name |v:servername| or "VIM"
7136 Only works if the terminal supports setting window titles
7137 (currently Amiga console, Win32 console, all GUI versions and
7138 terminals with a non- empty 't_ts' option - these are Unix xterm and
7139 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7140 *X11*
7141 When Vim was compiled with HAVE_X11 defined, the original title will
7142 be restored if possible. The output of ":version" will include "+X11"
7143 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7144 works for the icon name |'icon'|.
7145 But: When Vim was started with the |-X| argument, restoring the title
7146 will not work (except in the GUI).
7147 If the title cannot be restored, it is set to the value of 'titleold'.
7148 You might want to restore the title outside of Vim then.
7149 When using an xterm from a remote machine you can use this command:
7150 rsh machine_name xterm -display $DISPLAY &
7151 then the WINDOWID environment variable should be inherited and the
7152 title of the window should change back to what it should be after
7153 exiting Vim.
7154
7155 *'titlelen'*
7156'titlelen' number (default 85)
7157 global
7158 {not in Vi}
7159 {not available when compiled without the |+title|
7160 feature}
7161 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007162 title. When the title is longer, only the end of the path name is
7163 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 Using a percentage makes this adapt to the width of the window. But
7165 it won't work perfectly, because the actual number of characters
7166 available also depends on the font used and other things in the title
7167 bar. When 'titlelen' is zero the full path is used. Otherwise,
7168 values from 1 to 30000 percent can be used.
7169 'titlelen' is also used for the 'titlestring' option.
7170
7171 *'titleold'*
7172'titleold' string (default "Thanks for flying Vim")
7173 global
7174 {not in Vi}
7175 {only available when compiled with the |+title|
7176 feature}
7177 This option will be used for the window title when exiting Vim if the
7178 original title cannot be restored. Only happens if 'title' is on or
7179 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007180 This option cannot be set from a |modeline| or in the |sandbox|, for
7181 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 *'titlestring'*
7183'titlestring' string (default "")
7184 global
7185 {not in Vi}
7186 {not available when compiled without the |+title|
7187 feature}
7188 When this option is not empty, it will be used for the title of the
7189 window. This happens only when the 'title' option is on.
7190 Only works if the terminal supports setting window titles (currently
7191 Amiga console, Win32 console, all GUI versions and terminals with a
7192 non-empty 't_ts' option).
7193 When Vim was compiled with HAVE_X11 defined, the original title will
7194 be restored if possible |X11|.
7195 When this option contains printf-style '%' items, they will be
7196 expanded according to the rules used for 'statusline'.
7197 Example: >
7198 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7199 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7200< The value of 'titlelen' is used to align items in the middle or right
7201 of the available space.
7202 Some people prefer to have the file name first: >
7203 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7204< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007205 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007206 separating space only when needed.
7207 NOTE: Use of special characters in 'titlestring' may cause the display
7208 to be garbled (e.g., when it contains a CR or NL character).
7209 {not available when compiled without the |+statusline| feature}
7210
7211 *'toolbar'* *'tb'*
7212'toolbar' 'tb' string (default "icons,tooltips")
7213 global
7214 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7215 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007216 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007217 possible values are:
7218 icons Toolbar buttons are shown with icons.
7219 text Toolbar buttons shown with text.
7220 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007221 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 tooltips Tooltips are active for toolbar buttons.
7223 Tooltips refer to the popup help text which appears after the mouse
7224 cursor is placed over a toolbar button for a brief moment.
7225
7226 If you want the toolbar to be shown with icons as well as text, do the
7227 following: >
7228 :set tb=icons,text
7229< Motif and Athena cannot display icons and text at the same time. They
7230 will show icons if both are requested.
7231
7232 If none of the strings specified in 'toolbar' are valid or if
7233 'toolbar' is empty, this option is ignored. If you want to disable
7234 the toolbar, you need to set the 'guioptions' option. For example: >
7235 :set guioptions-=T
7236< Also see |gui-toolbar|.
7237
7238 *'toolbariconsize'* *'tbis'*
7239'toolbariconsize' 'tbis' string (default "small")
7240 global
7241 {not in Vi}
7242 {only in the GTK+ 2 GUI}
7243 Controls the size of toolbar icons. The possible values are:
7244 tiny Use tiny toolbar icons.
7245 small Use small toolbar icons (default).
7246 medium Use medium-sized toolbar icons.
7247 large Use large toolbar icons.
7248 The exact dimensions in pixels of the various icon sizes depend on
7249 the current theme. Common dimensions are large=32x32, medium=24x24,
7250 small=20x20 and tiny=16x16.
7251
7252 If 'toolbariconsize' is empty, the global default size as determined
7253 by user preferences or the current theme is used.
7254
7255 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7256'ttybuiltin' 'tbi' boolean (default on)
7257 global
7258 {not in Vi}
7259 When on, the builtin termcaps are searched before the external ones.
7260 When off the builtin termcaps are searched after the external ones.
7261 When this option is changed, you should set the 'term' option next for
7262 the change to take effect, for example: >
7263 :set notbi term=$TERM
7264< See also |termcap|.
7265 Rationale: The default for this option is "on", because the builtin
7266 termcap entries are generally better (many systems contain faulty
7267 xterm entries...).
7268
7269 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7270'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7271 sun-cmd, screen, rxvt, dtterm or
7272 iris-ansi; also on when running Vim in
7273 a DOS console)
7274 global
7275 {not in Vi}
7276 Indicates a fast terminal connection. More characters will be sent to
7277 the screen for redrawing, instead of using insert/delete line
7278 commands. Improves smoothness of redrawing when there are multiple
7279 windows and the terminal does not support a scrolling region.
7280 Also enables the extra writing of characters at the end of each screen
7281 line for lines that wrap. This helps when using copy/paste with the
7282 mouse in an xterm and other terminals.
7283
7284 *'ttymouse'* *'ttym'*
7285'ttymouse' 'ttym' string (default depends on 'term')
7286 global
7287 {not in Vi}
7288 {only in Unix and VMS, doesn't work in the GUI; not
7289 available when compiled without |+mouse|}
7290 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007291 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007292 *xterm-mouse*
7293 xterm xterm-like mouse handling. The mouse generates
7294 "<Esc>[Mscr", where "scr" is three bytes:
7295 "s" = button state
7296 "c" = column plus 33
7297 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007298 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007299 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007300 xterm2 Works like "xterm", but with the xterm reporting the
7301 mouse position while the mouse is dragged. This works
7302 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007303 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 work. See below for how Vim detects this
7305 automatically.
7306 *netterm-mouse*
7307 netterm NetTerm mouse handling. The mouse generates
7308 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7309 for the row and column.
7310 *dec-mouse*
7311 dec DEC terminal mouse handling. The mouse generates a
7312 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007313 This is also available for an Xterm, if it was
7314 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 *jsbterm-mouse*
7316 jsbterm JSB term mouse handling.
7317 *pterm-mouse*
7318 pterm QNX pterm mouse handling.
7319
7320 The mouse handling must be enabled at compile time |+mouse_xterm|
7321 |+mouse_dec| |+mouse_netterm|.
7322 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7323 recognized, if enabled at compile time. DEC terminal mouse codes
7324 are recognized if enabled at compile time, and 'ttymouse' is not
7325 "xterm" (because the xterm and dec mouse codes conflict).
7326 This option is automatically set to "xterm", when the 'term' option is
7327 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7328 or "xterm2" already. The main use of this option is to set it to
7329 "xterm", when the terminal name doesn't start with "xterm", but it can
7330 handle xterm mouse codes.
7331 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007332 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007333 feature and if |t_RV| is set to the escape sequence to request the
7334 xterm version number. Otherwise "xterm2" must be set explicitly.
7335 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7336 t_RV to an empty string: >
7337 :set t_RV=
7338<
7339 *'ttyscroll'* *'tsl'*
7340'ttyscroll' 'tsl' number (default 999)
7341 global
7342 Maximum number of lines to scroll the screen. If there are more lines
7343 to scroll the window is redrawn. For terminals where scrolling is
7344 very slow and redrawing is not slow this can be set to a small number,
7345 e.g., 3, to speed up displaying.
7346
7347 *'ttytype'* *'tty'*
7348'ttytype' 'tty' string (default from $TERM)
7349 global
7350 Alias for 'term', see above.
7351
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007352 *'undodir'* *'udir'*
7353'undodir' 'udir' string (default ".")
7354 global
7355 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007356 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007357 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007358 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007359 "." means using the directory of the file. The undo file name for
7360 "file.txt" is ".file.txt.un~".
7361 For other directories the file name is the full path of the edited
7362 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007363 When writing: The first directory that exists is used. "." always
7364 works, no directories after "." will be used for writing.
7365 When reading all entries are tried to find an undo file. The first
7366 undo file that exists is used. When it cannot be read an error is
7367 given, no further entry is used.
7368 See |undo-persistence|.
7369
7370 *'undofile'* *'udf'*
7371'undofile' 'udf' boolean (default off)
7372 local to buffer
7373 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007374 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007375 When on, Vim automatically saves undo history to an undo file when
7376 writing a buffer to a file, and restores undo history from the same
7377 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007378 The directory where the undo file is stored is specified by 'undodir'.
7379 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007380 The undo file is not read when 'undoreload' causes the buffer from
7381 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007382 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007383
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 *'undolevels'* *'ul'*
7385'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7386 Win32 and OS/2)
7387 global
7388 {not in Vi}
7389 Maximum number of changes that can be undone. Since undo information
7390 is kept in memory, higher numbers will cause more memory to be used
7391 (nevertheless, a single change can use an unlimited amount of memory).
7392 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7393 itself: >
7394 set ul=0
7395< But you can also get Vi compatibility by including the 'u' flag in
7396 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007397 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007398 Set to a negative number for no undo at all: >
7399 set ul=-1
7400< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007401 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007402
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007403 *'undoreload'* *'ur'*
7404'undoreload' 'ur' number (default 10000)
7405 global
7406 {not in Vi}
7407 Save the whole buffer for undo when reloading it. This applies to the
7408 ":e!" command and reloading for when the buffer changed outside of
7409 Vim. |FileChangedShell|
7410 The save only happens when this options is negative or when the number
7411 of lines is smaller than the value of this option.
7412 Set this option to zero to disable undo for a reload.
7413
7414 When saving undo for a reload, any undo file is not read.
7415
7416 Note that this causes the whole buffer to be stored in memory. Set
7417 this option to a lower value if you run out of memory.
7418
Bram Moolenaar071d4272004-06-13 20:20:40 +00007419 *'updatecount'* *'uc'*
7420'updatecount' 'uc' number (default: 200)
7421 global
7422 {not in Vi}
7423 After typing this many characters the swap file will be written to
7424 disk. When zero, no swap file will be created at all (see chapter on
7425 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7426 Vim with the "-n" option, see |startup|. When editing in readonly
7427 mode this option will be initialized to 10000.
7428 The swapfile can be disabled per buffer with |'swapfile'|.
7429 When 'updatecount' is set from zero to non-zero, swap files are
7430 created for all buffers that have 'swapfile' set. When 'updatecount'
7431 is set to zero, existing swap files are not deleted.
7432 Also see |'swapsync'|.
7433 This option has no meaning in buffers where |'buftype'| is "nofile"
7434 or "nowrite".
7435
7436 *'updatetime'* *'ut'*
7437'updatetime' 'ut' number (default 4000)
7438 global
7439 {not in Vi}
7440 If this many milliseconds nothing is typed the swap file will be
7441 written to disk (see |crash-recovery|). Also used for the
7442 |CursorHold| autocommand event.
7443
7444 *'verbose'* *'vbs'*
7445'verbose' 'vbs' number (default 0)
7446 global
7447 {not in Vi, although some versions have a boolean
7448 verbose option}
7449 When bigger than zero, Vim will give messages about what it is doing.
7450 Currently, these messages are given:
7451 >= 1 When the viminfo file is read or written.
7452 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007453 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 >= 8 Files for which a group of autocommands is executed.
7455 >= 9 Every executed autocommand.
7456 >= 12 Every executed function.
7457 >= 13 When an exception is thrown, caught, finished, or discarded.
7458 >= 14 Anything pending in a ":finally" clause.
7459 >= 15 Every executed Ex command (truncated at 200 characters).
7460
7461 This option can also be set with the "-V" argument. See |-V|.
7462 This option is also set by the |:verbose| command.
7463
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007464 When the 'verbosefile' option is set then the verbose messages are not
7465 displayed.
7466
7467 *'verbosefile'* *'vfile'*
7468'verbosefile' 'vfile' string (default empty)
7469 global
7470 {not in Vi}
7471 When not empty all messages are written in a file with this name.
7472 When the file exists messages are appended.
7473 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007474 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007475 Setting 'verbosefile' to a new value is like making it empty first.
7476 The difference with |:redir| is that verbose messages are not
7477 displayed when 'verbosefile' is set.
7478
Bram Moolenaar071d4272004-06-13 20:20:40 +00007479 *'viewdir'* *'vdir'*
7480'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7481 "$VIM/vimfiles/view",
7482 for Unix: "~/.vim/view",
7483 for Macintosh: "$VIM:vimfiles:view"
7484 for VMS: "sys$login:vimfiles/view"
7485 for RiscOS: "Choices:vimfiles/view")
7486 global
7487 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007488 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 feature}
7490 Name of the directory where to store files for |:mkview|.
7491 This option cannot be set from a |modeline| or in the |sandbox|, for
7492 security reasons.
7493
7494 *'viewoptions'* *'vop'*
7495'viewoptions' 'vop' string (default: "folds,options,cursor")
7496 global
7497 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007498 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 feature}
7500 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007501 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 word save and restore ~
7503 cursor cursor position in file and in window
7504 folds manually created folds, opened/closed folds and local
7505 fold options
7506 options options and mappings local to a window or buffer (not
7507 global values for local options)
7508 slash backslashes in file names replaced with forward
7509 slashes
7510 unix with Unix end-of-line format (single <NL>), even when
7511 on Windows or DOS
7512
7513 "slash" and "unix" are useful on Windows when sharing view files
7514 with Unix. The Unix version of Vim cannot source dos format scripts,
7515 but the Windows version of Vim can source unix format scripts.
7516
7517 *'viminfo'* *'vi'* *E526* *E527* *E528*
7518'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007519 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7520 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7521 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 global
7523 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007524 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 feature}
7526 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007527 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 separated list of parameters, each consisting of a single character
7529 identifying the particular parameter, followed by a number or string
7530 which specifies the value of that parameter. If a particular
7531 character is left out, then the default value is used for that
7532 parameter. The following is a list of the identifying characters and
7533 the effect of their value.
7534 CHAR VALUE ~
7535 ! When included, save and restore global variables that start
7536 with an uppercase letter, and don't contain a lowercase
7537 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007538 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007539 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 " Maximum number of lines saved for each register. Old name of
7541 the '<' item, with the disadvantage that you need to put a
7542 backslash before the ", otherwise it will be recognized as the
7543 start of a comment!
7544 % When included, save and restore the buffer list. If Vim is
7545 started with a file name argument, the buffer list is not
7546 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007547 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007548 without a file name and buffers for help files are not written
7549 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007550 When followed by a number, the number specifies the maximum
7551 number of buffers that are stored. Without a number all
7552 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 ' Maximum number of previously edited files for which the marks
7554 are remembered. This parameter must always be included when
7555 'viminfo' is non-empty.
7556 Including this item also means that the |jumplist| and the
7557 |changelist| are stored in the viminfo file.
7558 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007559 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007560 patterns are also saved. When not included, the value of
7561 'history' is used.
7562 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007563 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564 < Maximum number of lines saved for each register. If zero then
7565 registers are not saved. When not included, all lines are
7566 saved. '"' is the old name for this item.
7567 Also see the 's' item below: limit specified in Kbyte.
7568 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007569 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007570 c When included, convert the text in the viminfo file from the
7571 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007572 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 f Whether file marks need to be stored. If zero, file marks ('0
7574 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007575 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007576 cursor position (when exiting or when doing ":wviminfo").
7577 h Disable the effect of 'hlsearch' when loading the viminfo
7578 file. When not included, it depends on whether ":nohlsearch"
7579 has been used since the last search command.
7580 n Name of the viminfo file. The name must immediately follow
7581 the 'n'. Must be the last one! If the "-i" argument was
7582 given when starting Vim, that file name overrides the one
7583 given here with 'viminfo'. Environment variables are expanded
7584 when opening the file, not when setting the option.
7585 r Removable media. The argument is a string (up to the next
7586 ','). This parameter can be given several times. Each
7587 specifies the start of a path for which no marks will be
7588 stored. This is to avoid removable media. For MS-DOS you
7589 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7590 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7591 ignored. Maximum length of each 'r' argument is 50
7592 characters.
7593 s Maximum size of an item in Kbyte. If zero then registers are
7594 not saved. Currently only applies to registers. The default
7595 "s10" will exclude registers with more than 10 Kbyte of text.
7596 Also see the '<' item above: line count limit.
7597
7598 Example: >
7599 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7600<
7601 '50 Marks will be remembered for the last 50 files you
7602 edited.
7603 <1000 Contents of registers (up to 1000 lines each) will be
7604 remembered.
7605 s100 Registers with more than 100 Kbyte text are skipped.
7606 :0 Command-line history will not be saved.
7607 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7608 no / Since '/' is not specified, the default will be used,
7609 that is, save all of the search history, and also the
7610 previous search and substitute patterns.
7611 no % The buffer list will not be saved nor read back.
7612 no h 'hlsearch' highlighting will be restored.
7613
7614 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7615 load the contents of the file, this is not done automatically.
7616
7617 This option cannot be set from a |modeline| or in the |sandbox|, for
7618 security reasons.
7619
7620 *'virtualedit'* *'ve'*
7621'virtualedit' 've' string (default "")
7622 global
7623 {not in Vi}
7624 {not available when compiled without the
7625 |+virtualedit| feature}
7626 A comma separated list of these words:
7627 block Allow virtual editing in Visual block mode.
7628 insert Allow virtual editing in Insert mode.
7629 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007630 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007631
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007633 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007634 of the line. Useful for selecting a rectangle in Visual mode and
7635 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007636 "onemore" is not the same, it will only allow moving the cursor just
7637 after the last character of the line. This makes some commands more
7638 consistent. Previously the cursor was always past the end of the line
7639 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007640 break some plugins or Vim scripts. For example because |l| can move
7641 the cursor after the last character. Use with care!
7642 Using the |$| command will move to the last character in the line, not
7643 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007644 It doesn't make sense to combine "all" with "onemore", but you will
7645 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646
7647 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7648'visualbell' 'vb' boolean (default off)
7649 global
7650 {not in Vi}
7651 Use visual bell instead of beeping. The terminal code to display the
7652 visual bell is given with 't_vb'. When no beep or flash is wanted,
7653 use ":set vb t_vb=".
7654 Note: When the GUI starts, 't_vb' is reset to its default value. You
7655 might want to set it again in your |gvimrc|.
7656 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7657 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7658 where 40 is the time in msec.
7659 Does not work on the Amiga, you always get a screen flash.
7660 Also see 'errorbells'.
7661
7662 *'warn'* *'nowarn'*
7663'warn' boolean (default on)
7664 global
7665 Give a warning message when a shell command is used while the buffer
7666 has been changed.
7667
7668 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7669'weirdinvert' 'wiv' boolean (default off)
7670 global
7671 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007672 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007673 It is provided for backwards compatibility with version 4.x.
7674 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7675 vice versa. Has no effect when the GUI is running.
7676
7677 *'whichwrap'* *'ww'*
7678'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7679 global
7680 {not in Vi}
7681 Allow specified keys that move the cursor left/right to move to the
7682 previous/next line when the cursor is on the first/last character in
7683 the line. Concatenate characters to allow this for these keys:
7684 char key mode ~
7685 b <BS> Normal and Visual
7686 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007687 h "h" Normal and Visual (not recommended)
7688 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007689 < <Left> Normal and Visual
7690 > <Right> Normal and Visual
7691 ~ "~" Normal
7692 [ <Left> Insert and Replace
7693 ] <Right> Insert and Replace
7694 For example: >
7695 :set ww=<,>,[,]
7696< allows wrap only when cursor keys are used.
7697 When the movement keys are used in combination with a delete or change
7698 operator, the <EOL> also counts for a character. This makes "3h"
7699 different from "3dh" when the cursor crosses the end of a line. This
7700 is also true for "x" and "X", because they do the same as "dl" and
7701 "dh". If you use this, you may also want to use the mapping
7702 ":map <BS> X" to make backspace delete the character in front of the
7703 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007704 When 'l' is included and it is used after an operator at the end of a
7705 line then it will not move to the next line. This makes "dl", "cl",
7706 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 NOTE: This option is set to the Vi default value when 'compatible' is
7708 set and to the Vim default value when 'compatible' is reset.
7709
7710 *'wildchar'* *'wc'*
7711'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7712 global
7713 {not in Vi}
7714 Character you have to type to start wildcard expansion in the
7715 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007716 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007717 The character is not recognized when used inside a macro. See
7718 'wildcharm' for that.
7719 Although 'wc' is a number option, you can set it to a special key: >
7720 :set wc=<Esc>
7721< NOTE: This option is set to the Vi default value when 'compatible' is
7722 set and to the Vim default value when 'compatible' is reset.
7723
7724 *'wildcharm'* *'wcm'*
7725'wildcharm' 'wcm' number (default: none (0))
7726 global
7727 {not in Vi}
7728 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007729 recognized when used inside a macro. You can find "spare" command-line
7730 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007731 you'll never actually type 'wildcharm', just use it in mappings that
7732 automatically invoke completion mode, e.g.: >
7733 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007734 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007735< Then after typing :ss you can use CTRL-P & CTRL-N.
7736
7737 *'wildignore'* *'wig'*
7738'wildignore' 'wig' string (default "")
7739 global
7740 {not in Vi}
7741 {not available when compiled without the |+wildignore|
7742 feature}
7743 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007744 patterns is ignored when completing file or directory names, and
7745 influences the result of |expand()|, |glob()| and |globpath()| unless
7746 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007747 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7748 Also see 'suffixes'.
7749 Example: >
7750 :set wildignore=*.o,*.obj
7751< The use of |:set+=| and |:set-=| is preferred when adding or removing
7752 a pattern from the list. This avoids problems when a future version
7753 uses another default.
7754
7755 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7756'wildmenu' 'wmnu' boolean (default off)
7757 global
7758 {not in Vi}
7759 {not available if compiled without the |+wildmenu|
7760 feature}
7761 When 'wildmenu' is on, command-line completion operates in an enhanced
7762 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7763 the possible matches are shown just above the command line, with the
7764 first match highlighted (overwriting the status line, if there is
7765 one). Keys that show the previous/next match, such as <Tab> or
7766 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7767 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7768 specified. "longest" and "list" do not start "wildmenu" mode.
7769 If there are more matches than can fit in the line, a ">" is shown on
7770 the right and/or a "<" is shown on the left. The status line scrolls
7771 as needed.
7772 The "wildmenu" mode is abandoned when a key is hit that is not used
7773 for selecting a completion.
7774 While the "wildmenu" is active the following keys have special
7775 meanings:
7776
7777 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7778 <Down> - in filename/menu name completion: move into a
7779 subdirectory or submenu.
7780 <CR> - in menu completion, when the cursor is just after a
7781 dot: move into a submenu.
7782 <Up> - in filename/menu name completion: move up into
7783 parent directory or parent menu.
7784
7785 This makes the menus accessible from the console |console-menus|.
7786
7787 If you prefer the <Left> and <Right> keys to move the cursor instead
7788 of selecting a different match, use this: >
7789 :cnoremap <Left> <Space><BS><Left>
7790 :cnoremap <Right> <Space><BS><Right>
7791<
7792 The "WildMenu" highlighting is used for displaying the current match
7793 |hl-WildMenu|.
7794
7795 *'wildmode'* *'wim'*
7796'wildmode' 'wim' string (Vim default: "full")
7797 global
7798 {not in Vi}
7799 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007800 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007801 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007802 first part specifies the behavior for the first use of 'wildchar',
7803 The second part for the second use, etc.
7804 These are the possible values for each part:
7805 "" Complete only the first match.
7806 "full" Complete the next full match. After the last match,
7807 the original string is used and then the first match
7808 again.
7809 "longest" Complete till longest common string. If this doesn't
7810 result in a longer string, use the next part.
7811 "longest:full" Like "longest", but also start 'wildmenu' if it is
7812 enabled.
7813 "list" When more than one match, list all matches.
7814 "list:full" When more than one match, list all matches and
7815 complete first match.
7816 "list:longest" When more than one match, list all matches and
7817 complete till longest common string.
7818 When there is only a single match, it is fully completed in all cases.
7819
7820 Examples: >
7821 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007822< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007823 :set wildmode=longest,full
7824< Complete longest common string, then each full match >
7825 :set wildmode=list:full
7826< List all matches and complete each full match >
7827 :set wildmode=list,full
7828< List all matches without completing, then each full match >
7829 :set wildmode=longest,list
7830< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007831 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007833 *'wildoptions'* *'wop'*
7834'wildoptions' 'wop' string (default "")
7835 global
7836 {not in Vi}
7837 {not available when compiled without the |+wildignore|
7838 feature}
7839 A list of words that change how command line completion is done.
7840 Currently only one word is allowed:
7841 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007842 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007843 is displayed per line. Often used tag kinds are:
7844 d #define
7845 f function
7846 Also see |cmdline-completion|.
7847
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 *'winaltkeys'* *'wak'*
7849'winaltkeys' 'wak' string (default "menu")
7850 global
7851 {not in Vi}
7852 {only used in Win32, Motif, GTK and Photon GUI}
7853 Some GUI versions allow the access to menu entries by using the ALT
7854 key in combination with a character that appears underlined in the
7855 menu. This conflicts with the use of the ALT key for mappings and
7856 entering special characters. This option tells what to do:
7857 no Don't use ALT keys for menus. ALT key combinations can be
7858 mapped, but there is no automatic handling. This can then be
7859 done with the |:simalt| command.
7860 yes ALT key handling is done by the windowing system. ALT key
7861 combinations cannot be mapped.
7862 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007863 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 keys can be mapped.
7865 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7866 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007867 This option is not used for <F10>; on Win32 and with GTK <F10> will
7868 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007869
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007870 *'window'* *'wi'*
7871'window' 'wi' number (default screen height - 1)
7872 global
7873 Window height. Do not confuse this with the height of the Vim window,
7874 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007875 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7876 value is smaller than 'lines' minus one. The screen will scroll
7877 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007878 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7879 in a much smarter way, taking care of wrapping lines.
7880 When resizing the Vim window, the value is smaller than 1 or more than
7881 or equal to 'lines' it will be set to 'lines' minus 1.
7882 {Vi also uses the option to specify the number of displayed lines}
7883
Bram Moolenaar071d4272004-06-13 20:20:40 +00007884 *'winheight'* *'wh'* *E591*
7885'winheight' 'wh' number (default 1)
7886 global
7887 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007888 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007889 feature}
7890 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007891 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007892 focus goes to a window that is smaller, its size is increased, at the
7893 cost of the height of other windows.
7894 Set 'winheight' to a small number for normal editing.
7895 Set it to 999 to make the current window fill most of the screen.
7896 Other windows will be only 'winminheight' high. This has the drawback
7897 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7898 to create only two windows, set the option after startup is done,
7899 using the |VimEnter| event: >
7900 au VimEnter * set winheight=999
7901< Minimum value is 1.
7902 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 height of the current window.
7904 'winheight' applies to the current window. Use 'winminheight' to set
7905 the minimal height for other windows.
7906
7907 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7908'winfixheight' 'wfh' boolean (default off)
7909 local to window
7910 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007911 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007912 feature}
7913 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007914 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7915 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 The height may be changed anyway when running out of room.
7917
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007918 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7919'winfixwidth' 'wfw' boolean (default off)
7920 local to window
7921 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007922 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007923 feature}
7924 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007925 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007926 The width may be changed anyway when running out of room.
7927
Bram Moolenaar071d4272004-06-13 20:20:40 +00007928 *'winminheight'* *'wmh'*
7929'winminheight' 'wmh' number (default 1)
7930 global
7931 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007932 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007933 feature}
7934 The minimal height of a window, when it's not the current window.
7935 This is a hard minimum, windows will never become smaller.
7936 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7937 status bar) if necessary. They will return to at least one line when
7938 they become active (since the cursor has to have somewhere to go.)
7939 Use 'winheight' to set the minimal height of the current window.
7940 This option is only checked when making a window smaller. Don't use a
7941 large number, it will cause errors when opening more than a few
7942 windows. A value of 0 to 3 is reasonable.
7943
7944 *'winminwidth'* *'wmw'*
7945'winminwidth' 'wmw' number (default 1)
7946 global
7947 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007948 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 feature}
7950 The minimal width of a window, when it's not the current window.
7951 This is a hard minimum, windows will never become smaller.
7952 When set to zero, windows may be "squashed" to zero columns (i.e. just
7953 a vertical separator) if necessary. They will return to at least one
7954 line when they become active (since the cursor has to have somewhere
7955 to go.)
7956 Use 'winwidth' to set the minimal width of the current window.
7957 This option is only checked when making a window smaller. Don't use a
7958 large number, it will cause errors when opening more than a few
7959 windows. A value of 0 to 12 is reasonable.
7960
7961 *'winwidth'* *'wiw'* *E592*
7962'winwidth' 'wiw' number (default 20)
7963 global
7964 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007965 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007966 feature}
7967 Minimal number of columns for the current window. This is not a hard
7968 minimum, Vim will use fewer columns if there is not enough room. If
7969 the current window is smaller, its size is increased, at the cost of
7970 the width of other windows. Set it to 999 to make the current window
7971 always fill the screen. Set it to a small number for normal editing.
7972 The width is not adjusted after one of the commands to change the
7973 width of the current window.
7974 'winwidth' applies to the current window. Use 'winminwidth' to set
7975 the minimal width for other windows.
7976
7977 *'wrap'* *'nowrap'*
7978'wrap' boolean (default on)
7979 local to window
7980 {not in Vi}
7981 This option changes how text is displayed. It doesn't change the text
7982 in the buffer, see 'textwidth' for that.
7983 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007984 displaying continues on the next line. When off lines will not wrap
7985 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 moved to a part that is not shown, the screen will scroll
7987 horizontally.
7988 The line will be broken in the middle of a word if necessary. See
7989 'linebreak' to get the break at a word boundary.
7990 To make scrolling horizontally a bit more useful, try this: >
7991 :set sidescroll=5
7992 :set listchars+=precedes:<,extends:>
7993< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007994 This option can't be set from a |modeline| when the 'diff' option is
7995 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007996
7997 *'wrapmargin'* *'wm'*
7998'wrapmargin' 'wm' number (default 0)
7999 local to buffer
8000 Number of characters from the right window border where wrapping
8001 starts. When typing text beyond this limit, an <EOL> will be inserted
8002 and inserting continues on the next line.
8003 Options that add a margin, such as 'number' and 'foldcolumn', cause
8004 the text width to be further reduced. This is Vi compatible.
8005 When 'textwidth' is non-zero, this option is not used.
8006 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8007 and less usefully}
8008
8009 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8010'wrapscan' 'ws' boolean (default on) *E384* *E385*
8011 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008012 Searches wrap around the end of the file. Also applies to |]s| and
8013 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008014
8015 *'write'* *'nowrite'*
8016'write' boolean (default on)
8017 global
8018 {not in Vi}
8019 Allows writing files. When not set, writing a file is not allowed.
8020 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008021 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 argument. Filtering text is still possible, even though this requires
8023 writing a temporary file.
8024
8025 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8026'writeany' 'wa' boolean (default off)
8027 global
8028 Allows writing to any file with no need for "!" override.
8029
8030 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8031'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8032 otherwise)
8033 global
8034 {not in Vi}
8035 Make a backup before overwriting a file. The backup is removed after
8036 the file was successfully written, unless the 'backup' option is
8037 also on. Reset this option if your file system is almost full. See
8038 |backup-table| for another explanation.
8039 When the 'backupskip' pattern matches, a backup is not made anyway.
8040 NOTE: This option is set to the default value when 'compatible' is
8041 set.
8042
8043 *'writedelay'* *'wd'*
8044'writedelay' 'wd' number (default 0)
8045 global
8046 {not in Vi}
8047 The number of microseconds to wait for each character sent to the
8048 screen. When non-zero, characters are sent to the terminal one by
8049 one. For MS-DOS pcterm this does not work. For debugging purposes.
8050
8051 vim:tw=78:ts=8:ft=help:norl: