blob: 12bedd5912bd81ae1b13f26a1f60881d53e35c87 [file] [log] [blame]
Bram Moolenaar05365702010-10-27 18:34:44 +02001*options.txt* For Vim version 7.3. Last change: 2010 Oct 23
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 Moolenaar5a8684e2005-07-30 22:43:24 +00001702
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001703
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001704 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001705'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001706 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001707 {not available when compiled without the
1708 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001709 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001710 A comma separated list of options for Insert mode completion
1711 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001712
1713 menu Use a popup menu to show the possible completions. The
1714 menu is only shown when there is more than one match and
1715 sufficient colors are available. |ins-completion-menu|
1716
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001717 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001718 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001719 match, e.g., what file it comes from.
1720
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001721 longest Only insert the longest common text of the matches. If
1722 the menu is displayed you can use CTRL-L to add more
1723 characters. Whether case is ignored depends on the kind
1724 of completion. For buffer text the 'ignorecase' option is
1725 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001726
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001727 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001728 completion in the preview window. Only works in
1729 combination with "menu" or "menuone".
1730
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001731
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001732 *'concealcursor'* *'cocu'*
1733'concealcursor' 'cocu' string (default: "")
1734 local to window
1735 {not in Vi}
1736 {not available when compiled without the |+conceal|
1737 feature}
1738 Sets the modes in which text in the cursor line can also be concealed.
1739 When the current mode is listed then concealing happens just like in
1740 other lines.
1741 n Normal mode
1742 v Visual mode
1743 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001744 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001745
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001746 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001747 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001748 are moving around text is concealed, but when starting to insert text
1749 or selecting a Visual area the concealed text is displayed, so that
1750 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001751 Keep in mind that the cursor position is not always where it's
1752 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001753
1754
1755'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001756 number (default 0)
1757 local to window
1758 {not in Vi}
1759 {not available when compiled without the |+conceal|
1760 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001761 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1762 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001763
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001764 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001765 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001766 1 Each block of concealed text is replaced with one
1767 character. If the syntax item does not have a custom
1768 replacement character defined (see |:syn-cchar|) the
1769 character defined in 'listchars' is used (default is a
1770 space).
1771 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001772 2 Concealed text is completely hidden unless it has a
1773 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001774 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001775 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001776
Bram Moolenaara7781e02010-07-19 20:13:22 +02001777 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001778 edit and copy the text. This can be changed with the 'concealcursor'
1779 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001780
Bram Moolenaar071d4272004-06-13 20:20:40 +00001781 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1782'confirm' 'cf' boolean (default off)
1783 global
1784 {not in Vi}
1785 When 'confirm' is on, certain operations that would normally
1786 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1787 instead raise a |dialog| asking if you wish to save the current
1788 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1789 If 'confirm' is off you can still activate confirmation for one
1790 command only (this is most useful in mappings) with the |:confirm|
1791 command.
1792 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1793
1794 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1795'conskey' 'consk' boolean (default off)
1796 global
1797 {not in Vi} {only for MS-DOS}
1798 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001799 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001800 three methods of console input are available:
1801 'conskey' 'bioskey' action ~
1802 on on or off direct console input
1803 off on BIOS
1804 off off STDIN
1805
1806 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1807'copyindent' 'ci' boolean (default off)
1808 local to buffer
1809 {not in Vi}
1810 Copy the structure of the existing lines indent when autoindenting a
1811 new line. Normally the new indent is reconstructed by a series of
1812 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1813 in which case only spaces are used). Enabling this option makes the
1814 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001815 existing line. 'expandtab' has no effect on these characters, a Tab
1816 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001817 line, the remaining space is filled in the normal manner.
1818 NOTE: 'copyindent' is reset when 'compatible' is set.
1819 Also see 'preserveindent'.
1820
1821 *'cpoptions'* *'cpo'*
1822'cpoptions' 'cpo' string (Vim default: "aABceFs",
1823 Vi default: all flags)
1824 global
1825 {not in Vi}
1826 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001827 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001828 not being vi-compatible is mostly or sometimes preferred.
1829 'cpoptions' stands for "compatible-options".
1830 Commas can be added for readability.
1831 To avoid problems with flags that are added in the future, use the
1832 "+=" and "-=" feature of ":set" |add-option-flags|.
1833 NOTE: This option is set to the Vi default value when 'compatible' is
1834 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001835 NOTE: This option is set to the POSIX default value at startup when
1836 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001837 variable exists |posix|. This means Vim tries to behave like the
1838 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001839
1840 contains behavior ~
1841 *cpo-a*
1842 a When included, a ":read" command with a file name
1843 argument will set the alternate file name for the
1844 current window.
1845 *cpo-A*
1846 A When included, a ":write" command with a file name
1847 argument will set the alternate file name for the
1848 current window.
1849 *cpo-b*
1850 b "\|" in a ":map" command is recognized as the end of
1851 the map command. The '\' is included in the mapping,
1852 the text after the '|' is interpreted as the next
1853 command. Use a CTRL-V instead of a backslash to
1854 include the '|' in the mapping. Applies to all
1855 mapping, abbreviation, menu and autocmd commands.
1856 See also |map_bar|.
1857 *cpo-B*
1858 B A backslash has no special meaning in mappings,
1859 abbreviations and the "to" part of the menu commands.
1860 Remove this flag to be able to use a backslash like a
1861 CTRL-V. For example, the command ":map X \<Esc>"
1862 results in X being mapped to:
1863 'B' included: "\^[" (^[ is a real <Esc>)
1864 'B' excluded: "<Esc>" (5 characters)
1865 ('<' excluded in both cases)
1866 *cpo-c*
1867 c Searching continues at the end of any match at the
1868 cursor position, but not further than the start of the
1869 next line. When not present searching continues
1870 one character from the cursor position. With 'c'
1871 "abababababab" only gets three matches when repeating
1872 "/abab", without 'c' there are five matches.
1873 *cpo-C*
1874 C Do not concatenate sourced lines that start with a
1875 backslash. See |line-continuation|.
1876 *cpo-d*
1877 d Using "./" in the 'tags' option doesn't mean to use
1878 the tags file relative to the current file, but the
1879 tags file in the current directory.
1880 *cpo-D*
1881 D Can't use CTRL-K to enter a digraph after Normal mode
1882 commands with a character argument, like |r|, |f| and
1883 |t|.
1884 *cpo-e*
1885 e When executing a register with ":@r", always add a
1886 <CR> to the last line, also when the register is not
1887 linewise. If this flag is not present, the register
1888 is not linewise and the last line does not end in a
1889 <CR>, then the last line is put on the command-line
1890 and can be edited before hitting <CR>.
1891 *cpo-E*
1892 E It is an error when using "y", "d", "c", "g~", "gu" or
1893 "gU" on an Empty region. The operators only work when
1894 at least one character is to be operate on. Example:
1895 This makes "y0" fail in the first column.
1896 *cpo-f*
1897 f When included, a ":read" command with a file name
1898 argument will set the file name for the current buffer,
1899 if the current buffer doesn't have a file name yet.
1900 *cpo-F*
1901 F When included, a ":write" command with a file name
1902 argument will set the file name for the current
1903 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001904 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001905 *cpo-g*
1906 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001907 *cpo-H*
1908 H When using "I" on a line with only blanks, insert
1909 before the last blank. Without this flag insert after
1910 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001911 *cpo-i*
1912 i When included, interrupting the reading of a file will
1913 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001914 *cpo-I*
1915 I When moving the cursor up or down just after inserting
1916 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001917 *cpo-j*
1918 j When joining lines, only add two spaces after a '.',
1919 not after '!' or '?'. Also see 'joinspaces'.
1920 *cpo-J*
1921 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001922 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001923 white space.
1924 *cpo-k*
1925 k Disable the recognition of raw key codes in
1926 mappings, abbreviations, and the "to" part of menu
1927 commands. For example, if <Key> sends ^[OA (where ^[
1928 is <Esc>), the command ":map X ^[OA" results in X
1929 being mapped to:
1930 'k' included: "^[OA" (3 characters)
1931 'k' excluded: "<Key>" (one key code)
1932 Also see the '<' flag below.
1933 *cpo-K*
1934 K Don't wait for a key code to complete when it is
1935 halfway a mapping. This breaks mapping <F1><F1> when
1936 only part of the second <F1> has been read. It
1937 enables cancelling the mapping by typing <F1><Esc>.
1938 *cpo-l*
1939 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001940 literally, only "\]", "\^", "\-" and "\\" are special.
1941 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001942 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1943 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001944 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001945 *cpo-L*
1946 L When the 'list' option is set, 'wrapmargin',
1947 'textwidth', 'softtabstop' and Virtual Replace mode
1948 (see |gR|) count a <Tab> as two characters, instead of
1949 the normal behavior of a <Tab>.
1950 *cpo-m*
1951 m When included, a showmatch will always wait half a
1952 second. When not included, a showmatch will wait half
1953 a second or until a character is typed. |'showmatch'|
1954 *cpo-M*
1955 M When excluded, "%" matching will take backslashes into
1956 account. Thus in "( \( )" and "\( ( \)" the outer
1957 parenthesis match. When included "%" ignores
1958 backslashes, which is Vi compatible.
1959 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001960 n When included, the column used for 'number' and
1961 'relativenumber' will also be used for text of wrapped
1962 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001963 *cpo-o*
1964 o Line offset to search command is not remembered for
1965 next search.
1966 *cpo-O*
1967 O Don't complain if a file is being overwritten, even
1968 when it didn't exist when editing it. This is a
1969 protection against a file unexpectedly created by
1970 someone else. Vi didn't complain about this.
1971 *cpo-p*
1972 p Vi compatible Lisp indenting. When not present, a
1973 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001974 *cpo-P*
1975 P When included, a ":write" command that appends to a
1976 file will set the file name for the current buffer, if
1977 the current buffer doesn't have a file name yet and
1978 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001979 *cpo-q*
1980 q When joining multiple lines leave the cursor at the
1981 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001982 *cpo-r*
1983 r Redo ("." command) uses "/" to repeat a search
1984 command, instead of the actually used search string.
1985 *cpo-R*
1986 R Remove marks from filtered lines. Without this flag
1987 marks are kept like |:keepmarks| was used.
1988 *cpo-s*
1989 s Set buffer options when entering the buffer for the
1990 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001991 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 set when the buffer is created.
1993 *cpo-S*
1994 S Set buffer options always when entering a buffer
1995 (except 'readonly', 'fileformat', 'filetype' and
1996 'syntax'). This is the (most) Vi compatible setting.
1997 The options are set to the values in the current
1998 buffer. When you change an option and go to another
1999 buffer, the value is copied. Effectively makes the
2000 buffer options global to all buffers.
2001
2002 's' 'S' copy buffer options
2003 no no when buffer created
2004 yes no when buffer first entered (default)
2005 X yes each time when buffer entered (vi comp.)
2006 *cpo-t*
2007 t Search pattern for the tag command is remembered for
2008 "n" command. Otherwise Vim only puts the pattern in
2009 the history for search pattern, but doesn't change the
2010 last used search pattern.
2011 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002012 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013 *cpo-v*
2014 v Backspaced characters remain visible on the screen in
2015 Insert mode. Without this flag the characters are
2016 erased from the screen right away. With this flag the
2017 screen newly typed text overwrites backspaced
2018 characters.
2019 *cpo-w*
2020 w When using "cw" on a blank character, only change one
2021 character and not all blanks until the start of the
2022 next word.
2023 *cpo-W*
2024 W Don't overwrite a readonly file. When omitted, ":w!"
2025 overwrites a readonly file, if possible.
2026 *cpo-x*
2027 x <Esc> on the command-line executes the command-line.
2028 The default in Vim is to abandon the command-line,
2029 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002030 *cpo-X*
2031 X When using a count with "R" the replaced text is
2032 deleted only once. Also when repeating "R" with "."
2033 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 *cpo-y*
2035 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002036 *cpo-Z*
2037 Z When using "w!" while the 'readonly' option is set,
2038 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039 *cpo-!*
2040 ! When redoing a filter command, use the last used
2041 external command, whatever it was. Otherwise the last
2042 used -filter- command is used.
2043 *cpo-$*
2044 $ When making a change to one line, don't redisplay the
2045 line, but put a '$' at the end of the changed text.
2046 The changed text will be overwritten when you type the
2047 new text. The line is redisplayed if you type any
2048 command that moves the cursor from the insertion
2049 point.
2050 *cpo-%*
2051 % Vi-compatible matching is done for the "%" command.
2052 Does not recognize "#if", "#endif", etc.
2053 Does not recognize "/*" and "*/".
2054 Parens inside single and double quotes are also
2055 counted, causing a string that contains a paren to
2056 disturb the matching. For example, in a line like
2057 "if (strcmp("foo(", s))" the first paren does not
2058 match the last one. When this flag is not included,
2059 parens inside single and double quotes are treated
2060 specially. When matching a paren outside of quotes,
2061 everything inside quotes is ignored. When matching a
2062 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002063 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002064 This flag is also used for other features, such as
2065 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002066 *cpo--*
2067 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002068 it would go above the first line or below the last
2069 line. Without it the cursor moves to the first or
2070 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002071 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002072 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002073 *cpo-+*
2074 + When included, a ":write file" command will reset the
2075 'modified' flag of the buffer, even though the buffer
2076 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002077 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002078 * Use ":*" in the same way as ":@". When not included,
2079 ":*" is an alias for ":'<,'>", select the Visual area.
2080 *cpo-<*
2081 < Disable the recognition of special key codes in |<>|
2082 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002083 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002084 ":map X <Tab>" results in X being mapped to:
2085 '<' included: "<Tab>" (5 characters)
2086 '<' excluded: "^I" (^I is a real <Tab>)
2087 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002088 *cpo->*
2089 > When appending to a register, put a line break before
2090 the appended text.
2091
2092 POSIX flags. These are not included in the Vi default value, except
2093 when $VIM_POSIX was set on startup. |posix|
2094
2095 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002096 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002097 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002098 *cpo-&*
2099 & When ":preserve" was used keep the swap file when
2100 exiting normally while this buffer is still loaded.
2101 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002102 *cpo-\*
2103 \ Backslash in a [] range in a search pattern is taken
2104 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002105 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2106 '\' excluded: "/[ \-]" finds <Space> and '-'
2107 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002108 *cpo-/*
2109 / When "%" is used as the replacement string in a |:s|
2110 command, use the previous replacement string. |:s%|
2111 *cpo-{*
2112 { The |{| and |}| commands also stop at a "{" character
2113 at the start of a line.
2114 *cpo-.*
2115 . The ":chdir" and ":cd" commands fail if the current
2116 buffer is modified, unless ! is used. Vim doesn't
2117 need this, since it remembers the full path of an
2118 opened file.
2119 *cpo-bar*
2120 | The value of the $LINES and $COLUMNS environment
2121 variables overrule the terminal size values obtained
2122 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002123
Bram Moolenaar071d4272004-06-13 20:20:40 +00002124
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002125 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002126'cryptmethod' string (default "zip")
2127 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002128 {not in Vi}
2129 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002130 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002131 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002132 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002133 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002134 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002135 or later, files can NOT be read by Vim 7.2 and older.
2136 This adds a "seed" to the file, every time you write
2137 the file the encrypted bytes will be different.
2138
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002139 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002140 to the detected method of the file being read. Thus if you write it
2141 without changing 'cryptmethod' the same method will be used.
2142 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002143 explicitly write it, you don't get a warning unless there are other
2144 modifications. Also see |:X|.
2145
2146 When setting the global value to an empty string, it will end up with
2147 the value "zip". When setting the local value to an empty string the
2148 buffer will use the global value.
2149
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002150 When a new encryption method is added in a later version of Vim, and
2151 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002152 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002153
2154
Bram Moolenaar071d4272004-06-13 20:20:40 +00002155 *'cscopepathcomp'* *'cspc'*
2156'cscopepathcomp' 'cspc' number (default 0)
2157 global
2158 {not available when compiled without the |+cscope|
2159 feature}
2160 {not in Vi}
2161 Determines how many components of the path to show in a list of tags.
2162 See |cscopepathcomp|.
2163
2164 *'cscopeprg'* *'csprg'*
2165'cscopeprg' 'csprg' string (default "cscope")
2166 global
2167 {not available when compiled without the |+cscope|
2168 feature}
2169 {not in Vi}
2170 Specifies the command to execute cscope. See |cscopeprg|.
2171 This option cannot be set from a |modeline| or in the |sandbox|, for
2172 security reasons.
2173
2174 *'cscopequickfix'* *'csqf'*
2175'cscopequickfix' 'csqf' string (default "")
2176 global
2177 {not available when compiled without the |+cscope|
2178 or |+quickfix| features}
2179 {not in Vi}
2180 Specifies whether to use quickfix window to show cscope results.
2181 See |cscopequickfix|.
2182
2183 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2184'cscopetag' 'cst' boolean (default off)
2185 global
2186 {not available when compiled without the |+cscope|
2187 feature}
2188 {not in Vi}
2189 Use cscope for tag commands. See |cscope-options|.
2190 NOTE: This option is reset when 'compatible' is set.
2191
2192 *'cscopetagorder'* *'csto'*
2193'cscopetagorder' 'csto' number (default 0)
2194 global
2195 {not available when compiled without the |+cscope|
2196 feature}
2197 {not in Vi}
2198 Determines the order in which ":cstag" performs a search. See
2199 |cscopetagorder|.
2200 NOTE: This option is set to 0 when 'compatible' is set.
2201
2202 *'cscopeverbose'* *'csverb'*
2203 *'nocscopeverbose'* *'nocsverb'*
2204'cscopeverbose' 'csverb' boolean (default off)
2205 global
2206 {not available when compiled without the |+cscope|
2207 feature}
2208 {not in Vi}
2209 Give messages when adding a cscope database. See |cscopeverbose|.
2210 NOTE: This option is reset when 'compatible' is set.
2211
Bram Moolenaar860cae12010-06-05 23:22:07 +02002212 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2213'cursorbind' 'crb' boolean (default off)
2214 local to window
2215 {not in Vi}
2216 {not available when compiled without the |+cursorbind|
2217 feature}
2218 When this option is set, as the cursor in the current
2219 window moves other cursorbound windows (windows that also have
2220 this option set) move their cursors to the corresponding line and
2221 column. This option is useful for viewing the
2222 differences between two versions of a file (see 'diff'); in diff mode,
2223 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002224 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002225
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002226
2227 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2228'cursorcolumn' 'cuc' boolean (default off)
2229 local to window
2230 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002231 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002232 feature}
2233 Highlight the screen column of the cursor with CursorColumn
2234 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2235 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002236 If you only want the highlighting in the current window you can use
2237 these autocommands: >
2238 au WinLeave * set nocursorline nocursorcolumn
2239 au WinEnter * set cursorline cursorcolumn
2240<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002241
2242 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2243'cursorline' 'cul' boolean (default off)
2244 local to window
2245 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002246 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002247 feature}
2248 Highlight the screen line of the cursor with CursorLine
2249 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2250 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002251 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002252 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002253
2254
Bram Moolenaar071d4272004-06-13 20:20:40 +00002255 *'debug'*
2256'debug' string (default "")
2257 global
2258 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002259 These values can be used:
2260 msg Error messages that would otherwise be omitted will be given
2261 anyway.
2262 throw Error messages that would otherwise be omitted will be given
2263 anyway and also throw an exception and set |v:errmsg|.
2264 beep A message will be given when otherwise only a beep would be
2265 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002266 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002267 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2268 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002269
2270 *'define'* *'def'*
2271'define' 'def' string (default "^\s*#\s*define")
2272 global or local to buffer |global-local|
2273 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002274 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002275 pattern, just like for the "/" command. This option is used for the
2276 commands like "[i" and "[d" |include-search|. The 'isident' option is
2277 used to recognize the defined name after the match:
2278 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2279 See |option-backslash| about inserting backslashes to include a space
2280 or backslash.
2281 The default value is for C programs. For C++ this value would be
2282 useful, to include const type declarations: >
2283 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2284< When using the ":set" command, you need to double the backslashes!
2285
2286 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2287'delcombine' 'deco' boolean (default off)
2288 global
2289 {not in Vi}
2290 {only available when compiled with the |+multi_byte|
2291 feature}
2292 If editing Unicode and this option is set, backspace and Normal mode
2293 "x" delete each combining character on its own. When it is off (the
2294 default) the character along with its combining characters are
2295 deleted.
2296 Note: When 'delcombine' is set "xx" may work different from "2x"!
2297
2298 This is useful for Arabic, Hebrew and many other languages where one
2299 may have combining characters overtop of base characters, and want
2300 to remove only the combining ones.
2301
2302 *'dictionary'* *'dict'*
2303'dictionary' 'dict' string (default "")
2304 global or local to buffer |global-local|
2305 {not in Vi}
2306 List of file names, separated by commas, that are used to lookup words
2307 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2308 contain a list of words. This can be one word per line, or several
2309 words per line, separated by non-keyword characters (white space is
2310 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002311 When this option is empty, or an entry "spell" is present, spell
2312 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002313 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002314 after a comma are ignored, otherwise spaces are included in the file
2315 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002316 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002317 Where to find a list of words?
2318 - On FreeBSD, there is the file "/usr/share/dict/words".
2319 - In the Simtel archive, look in the "msdos/linguist" directory.
2320 - In "miscfiles" of the GNU collection.
2321 The use of |:set+=| and |:set-=| is preferred when adding or removing
2322 directories from the list. This avoids problems when a future version
2323 uses another default.
2324 Backticks cannot be used in this option for security reasons.
2325
2326 *'diff'* *'nodiff'*
2327'diff' boolean (default off)
2328 local to window
2329 {not in Vi}
2330 {not available when compiled without the |+diff|
2331 feature}
2332 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002333 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002334
2335 *'dex'* *'diffexpr'*
2336'diffexpr' 'dex' string (default "")
2337 global
2338 {not in Vi}
2339 {not available when compiled without the |+diff|
2340 feature}
2341 Expression which is evaluated to obtain an ed-style diff file from two
2342 versions of a file. See |diff-diffexpr|.
2343 This option cannot be set from a |modeline| or in the |sandbox|, for
2344 security reasons.
2345
2346 *'dip'* *'diffopt'*
2347'diffopt' 'dip' string (default "filler")
2348 global
2349 {not in Vi}
2350 {not available when compiled without the |+diff|
2351 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002352 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002353 All are optional. Items must be separated by a comma.
2354
2355 filler Show filler lines, to keep the text
2356 synchronized with a window that has inserted
2357 lines at the same position. Mostly useful
2358 when windows are side-by-side and 'scrollbind'
2359 is set.
2360
2361 context:{n} Use a context of {n} lines between a change
2362 and a fold that contains unchanged lines.
2363 When omitted a context of six lines is used.
2364 See |fold-diff|.
2365
2366 icase Ignore changes in case of text. "a" and "A"
2367 are considered the same. Adds the "-i" flag
2368 to the "diff" command if 'diffexpr' is empty.
2369
2370 iwhite Ignore changes in amount of white space. Adds
2371 the "-b" flag to the "diff" command if
2372 'diffexpr' is empty. Check the documentation
2373 of the "diff" command for what this does
2374 exactly. It should ignore adding trailing
2375 white space, but not leading white space.
2376
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002377 horizontal Start diff mode with horizontal splits (unless
2378 explicitly specified otherwise).
2379
2380 vertical Start diff mode with vertical splits (unless
2381 explicitly specified otherwise).
2382
2383 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2384 starting diff mode. Without this 2 is used.
2385
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386 Examples: >
2387
2388 :set diffopt=filler,context:4
2389 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002390 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002391<
2392 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2393'digraph' 'dg' boolean (default off)
2394 global
2395 {not in Vi}
2396 {not available when compiled without the |+digraphs|
2397 feature}
2398 Enable the entering of digraphs in Insert mode with {char1} <BS>
2399 {char2}. See |digraphs|.
2400 NOTE: This option is reset when 'compatible' is set.
2401
2402 *'directory'* *'dir'*
2403'directory' 'dir' string (default for Amiga: ".,t:",
2404 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2405 for Unix: ".,~/tmp,/var/tmp,/tmp")
2406 global
2407 List of directory names for the swap file, separated with commas.
2408 - The swap file will be created in the first directory where this is
2409 possible.
2410 - Empty means that no swap file will be used (recovery is
2411 impossible!).
2412 - A directory "." means to put the swap file in the same directory as
2413 the edited file. On Unix, a dot is prepended to the file name, so
2414 it doesn't show in a directory listing. On MS-Windows the "hidden"
2415 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002416 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002417 put the swap file relative to where the edited file is. The leading
2418 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002419 - For Unix and Win32, if a directory ends in two path separators "//"
2420 or "\\", the swap file name will be built from the complete path to
2421 the file with all path separators substituted to percent '%' signs.
2422 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002423 On Win32, when a separating comma is following, you must use "//",
2424 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002425 - Spaces after the comma are ignored, other spaces are considered part
2426 of the directory name. To have a space at the start of a directory
2427 name, precede it with a backslash.
2428 - To include a comma in a directory name precede it with a backslash.
2429 - A directory name may end in an ':' or '/'.
2430 - Environment variables are expanded |:set_env|.
2431 - Careful with '\' characters, type one before a space, type two to
2432 get one in the option (see |option-backslash|), for example: >
2433 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2434< - For backwards compatibility with Vim version 3.0 a '>' at the start
2435 of the option is removed.
2436 Using "." first in the list is recommended. This means that editing
2437 the same file twice will result in a warning. Using "/tmp" on Unix is
2438 discouraged: When the system crashes you lose the swap file.
2439 "/var/tmp" is often not cleared when rebooting, thus is a better
2440 choice than "/tmp". But it can contain a lot of files, your swap
2441 files get lost in the crowd. That is why a "tmp" directory in your
2442 home directory is tried first.
2443 The use of |:set+=| and |:set-=| is preferred when adding or removing
2444 directories from the list. This avoids problems when a future version
2445 uses another default.
2446 This option cannot be set from a |modeline| or in the |sandbox|, for
2447 security reasons.
2448 {Vi: directory to put temp file in, defaults to "/tmp"}
2449
2450 *'display'* *'dy'*
2451'display' 'dy' string (default "")
2452 global
2453 {not in Vi}
2454 Change the way text is displayed. This is comma separated list of
2455 flags:
2456 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002457 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002458 last line that doesn't fit is replaced with "@" lines.
2459 uhex Show unprintable characters hexadecimal as <xx>
2460 instead of using ^C and ~C.
2461
2462 *'eadirection'* *'ead'*
2463'eadirection' 'ead' string (default "both")
2464 global
2465 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002466 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002467 feature}
2468 Tells when the 'equalalways' option applies:
2469 ver vertically, width of windows is not affected
2470 hor horizontally, height of windows is not affected
2471 both width and height of windows is affected
2472
2473 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2474'edcompatible' 'ed' boolean (default off)
2475 global
2476 Makes the 'g' and 'c' flags of the ":substitute" command to be
2477 toggled each time the flag is given. See |complex-change|. See
2478 also 'gdefault' option.
2479 Switching this option on is discouraged!
2480
2481 *'encoding'* *'enc'* *E543*
2482'encoding' 'enc' string (default: "latin1" or value from $LANG)
2483 global
2484 {only available when compiled with the |+multi_byte|
2485 feature}
2486 {not in Vi}
2487 Sets the character encoding used inside Vim. It applies to text in
2488 the buffers, registers, Strings in expressions, text stored in the
2489 viminfo file, etc. It sets the kind of characters which Vim can work
2490 with. See |encoding-names| for the possible values.
2491
2492 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002493 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002494 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002495 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002496
Bram Moolenaar865242e2010-07-14 21:12:05 +02002497 This option cannot be set from a |modeline|. It would most likely
2498 corrupt the text.
2499
Bram Moolenaar071d4272004-06-13 20:20:40 +00002500 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2501 "utf-8". Although care has been taken to allow different values of
2502 'encoding', "utf-8" is the natural choice for the environment and
2503 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002504 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002505 versions, and to avoid changing the encoding of newly created files
2506 without your knowledge (in case 'fileencodings' is empty).
2507
2508 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002509 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 iconv() or as specified with 'charconvert'.
2511
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002512 If you need to know whether 'encoding' is a multi-byte encoding, you
2513 can use: >
2514 if has("multi_byte_encoding")
2515<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 Normally 'encoding' will be equal to your current locale. This will
2517 be the default if Vim recognizes your environment settings. If
2518 'encoding' is not set to the current locale, 'termencoding' must be
2519 set to convert typed and displayed text. See |encoding-table|.
2520
2521 When you set this option, it fires the |EncodingChanged| autocommand
2522 event so that you can set up fonts if necessary.
2523
2524 When the option is set, the value is converted to lowercase. Thus
2525 you can set it with uppercase values too. Underscores are translated
2526 to '-' signs.
2527 When the encoding is recognized, it is changed to the standard name.
2528 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2529 "iso-8859-2" and "utf8" becomes "utf-8".
2530
2531 Note: "latin1" is also used when the encoding could not be detected.
2532 This only works when editing files in the same encoding! When the
2533 actual character set is not latin1, make sure 'fileencoding' and
2534 'fileencodings' are empty. When conversion is needed, switch to using
2535 utf-8.
2536
2537 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2538 You don't notice this while editing, but it does matter for the
2539 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2540 setting 'encoding' to one of these values instead of utf-8 only has
2541 effect for encoding used for files when 'fileencoding' is empty.
2542
Bram Moolenaar661b1822005-07-28 22:36:45 +00002543 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2544 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002545
2546 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2547'endofline' 'eol' boolean (default on)
2548 local to buffer
2549 {not in Vi}
2550 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002551 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 option is automatically set when starting to edit a new file, unless
2553 the file does not have an <EOL> for the last line in the file, in
2554 which case it is reset. Normally you don't have to set or reset this
2555 option. When 'binary' is off the value is not used when writing the
2556 file. When 'binary' is on it is used to remember the presence of a
2557 <EOL> for the last line in the file, so that when you write the file
2558 the situation from the original file can be kept. But you can change
2559 it if you want to.
2560
2561 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2562'equalalways' 'ea' boolean (default on)
2563 global
2564 {not in Vi}
2565 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002566 splitting or closing a window. This also happens the moment the
2567 option is switched on. When off, splitting a window will reduce the
2568 size of the current window and leave the other windows the same. When
2569 closing a window the extra lines are given to the window next to it
2570 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002571 When mixing vertically and horizontally split windows, a minimal size
2572 is computed and some windows may be larger if there is room. The
2573 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002574 Changing the height and width of a window can be avoided by setting
2575 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002576 If a window size is specified when creating a new window sizes are
2577 currently not equalized (it's complicated, but may be implemented in
2578 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579
2580 *'equalprg'* *'ep'*
2581'equalprg' 'ep' string (default "")
2582 global or local to buffer |global-local|
2583 {not in Vi}
2584 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002585 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002586 or 'indentexpr'. When Vim was compiled without internal formatting,
2587 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002588 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589 about including spaces and backslashes.
2590 This option cannot be set from a |modeline| or in the |sandbox|, for
2591 security reasons.
2592
2593 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2594'errorbells' 'eb' boolean (default off)
2595 global
2596 Ring the bell (beep or screen flash) for error messages. This only
2597 makes a difference for error messages, the bell will be used always
2598 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 screen flash or do nothing.
2601
2602 *'errorfile'* *'ef'*
2603'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2604 others: "errors.err")
2605 global
2606 {not in Vi}
2607 {not available when compiled without the |+quickfix|
2608 feature}
2609 Name of the errorfile for the QuickFix mode (see |:cf|).
2610 When the "-q" command-line argument is used, 'errorfile' is set to the
2611 following argument. See |-q|.
2612 NOT used for the ":make" command. See 'makeef' for that.
2613 Environment variables are expanded |:set_env|.
2614 See |option-backslash| about including spaces and backslashes.
2615 This option cannot be set from a |modeline| or in the |sandbox|, for
2616 security reasons.
2617
2618 *'errorformat'* *'efm'*
2619'errorformat' 'efm' string (default is very long)
2620 global or local to buffer |global-local|
2621 {not in Vi}
2622 {not available when compiled without the |+quickfix|
2623 feature}
2624 Scanf-like description of the format for the lines in the error file
2625 (see |errorformat|).
2626
2627 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2628'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2629 global
2630 {not in Vi}
2631 Function keys that start with an <Esc> are recognized in Insert
2632 mode. When this option is off, the cursor and function keys cannot be
2633 used in Insert mode if they start with an <Esc>. The advantage of
2634 this is that the single <Esc> is recognized immediately, instead of
2635 after one second. Instead of resetting this option, you might want to
2636 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2637 when 'esckeys' is off, you can still map anything, but the cursor keys
2638 won't work by default.
2639 NOTE: This option is set to the Vi default value when 'compatible' is
2640 set and to the Vim default value when 'compatible' is reset.
2641
2642 *'eventignore'* *'ei'*
2643'eventignore' 'ei' string (default "")
2644 global
2645 {not in Vi}
2646 {not available when compiled without the |+autocmd|
2647 feature}
2648 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002649 When set to "all" or when "all" is one of the items, all autocommand
2650 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002651 Otherwise this is a comma separated list of event names. Example: >
2652 :set ei=WinEnter,WinLeave
2653<
2654 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2655'expandtab' 'et' boolean (default off)
2656 local to buffer
2657 {not in Vi}
2658 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002659 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002660 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2661 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2662 NOTE: This option is reset when 'compatible' is set.
2663
2664 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2665'exrc' 'ex' boolean (default off)
2666 global
2667 {not in Vi}
2668 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2669 directory. If you switch this option on you should also consider
2670 setting the 'secure' option (see |initialization|). Using a local
2671 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2672 also see |.vimrc| and |gui-init|.
2673 This option cannot be set from a |modeline| or in the |sandbox|, for
2674 security reasons.
2675
2676 *'fileencoding'* *'fenc'* *E213*
2677'fileencoding' 'fenc' string (default: "")
2678 local to buffer
2679 {only available when compiled with the |+multi_byte|
2680 feature}
2681 {not in Vi}
2682 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002683
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002685 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002686 When 'fileencoding' is empty, the same value as 'encoding' will be
2687 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002688 Conversion will also be done when 'encoding' and 'fileencoding' are
2689 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2690 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002692 'encoding' is "utf-8" or another Unicode encoding, conversion
2693 is most likely done in a way that the reverse conversion
2694 results in the same text. When 'encoding' is not "utf-8" some
2695 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002696
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 See 'encoding' for the possible values. Additionally, values may be
2698 specified that can be handled by the converter, see
2699 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002700
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 When reading a file 'fileencoding' will be set from 'fileencodings'.
2702 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002703 'fileencoding', use the |++enc| argument. One exception: when
2704 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002705 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002706
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2708 When the option is set, the value is converted to lowercase. Thus
2709 you can set it with uppercase values too. '_' characters are
2710 replaced with '-'. If a name is recognized from the list for
2711 'encoding', it is replaced by the standard name. For example
2712 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002713
Bram Moolenaar071d4272004-06-13 20:20:40 +00002714 When this option is set, after starting to edit a file, the 'modified'
2715 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002716
2717 Keep in mind that changing 'fenc' from a modeline happens
2718 AFTER the text has been read, thus it applies to when the file will be
2719 written. If you do set 'fenc' in a modeline, you might want to set
2720 'nomodified' to avoid not being able to ":q".
2721
Bram Moolenaar071d4272004-06-13 20:20:40 +00002722 This option can not be changed when 'modifiable' is off.
2723
2724 *'fe'*
2725 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002726 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002727 old short name was 'fe', which is no longer used.
2728
2729 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002730'fileencodings' 'fencs' string (default: "ucs-bom",
2731 "ucs-bom,utf-8,default,latin1" when
2732 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 global
2734 {only available when compiled with the |+multi_byte|
2735 feature}
2736 {not in Vi}
2737 This is a list of character encodings considered when starting to edit
2738 an existing file. When a file is read, Vim tries to use the first
2739 mentioned character encoding. If an error is detected, the next one
2740 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002741 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 an empty string, which means the value of 'encoding' is used.
2743 WARNING: Conversion can cause loss of information! When
2744 'encoding' is "utf-8" (or one of the other Unicode variants)
2745 conversion is most likely done in a way that the reverse
2746 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002747 "utf-8" some non-ASCII characters may be lost! You can use
2748 the |++bad| argument to specify what is done with characters
2749 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002750 For an empty file or a file with only ASCII characters most encodings
2751 will work and the first entry of 'fileencodings' will be used (except
2752 "ucs-bom", which requires the BOM to be present). If you prefer
2753 another encoding use an BufReadPost autocommand event to test if your
2754 preferred encoding is to be used. Example: >
2755 au BufReadPost * if search('\S', 'w') == 0 |
2756 \ set fenc=iso-2022-jp | endif
2757< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2758 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002759 When the |++enc| argument is used then the value of 'fileencodings' is
2760 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002761 Note that 'fileencodings' is not used for a new file, the global value
2762 of 'fileencoding' is used instead. You can set it with: >
2763 :setglobal fenc=iso-8859-2
2764< This means that a non-existing file may get a different encoding than
2765 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002766 The special value "ucs-bom" can be used to check for a Unicode BOM
2767 (Byte Order Mark) at the start of the file. It must not be preceded
2768 by "utf-8" or another Unicode encoding for this to work properly.
2769 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2770 because Vim cannot detect an error, thus the encoding is always
2771 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002772 The special value "default" can be used for the encoding from the
2773 environment. This is the default value for 'encoding'. It is useful
2774 when 'encoding' is set to "utf-8" and your environment uses a
2775 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002776 When 'encoding' is "utf-8" and a file contains an illegal byte
2777 sequence it won't be recognized as UTF-8. You can use the |8g8|
2778 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 WRONG VALUES: WHAT'S WRONG:
2780 latin1,utf-8 "latin1" will always be used
2781 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2782 file
2783 cp1250,latin1 "cp1250" will always be used
2784 If 'fileencodings' is empty, 'fileencoding' is not modified.
2785 See 'fileencoding' for the possible values.
2786 Setting this option does not have an effect until the next time a file
2787 is read.
2788
2789 *'fileformat'* *'ff'*
2790'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2791 Unix default: "unix",
2792 Macintosh default: "mac")
2793 local to buffer
2794 {not in Vi}
2795 This gives the <EOL> of the current buffer, which is used for
2796 reading/writing the buffer from/to a file:
2797 dos <CR> <NL>
2798 unix <NL>
2799 mac <CR>
2800 When "dos" is used, CTRL-Z at the end of a file is ignored.
2801 See |file-formats| and |file-read|.
2802 For the character encoding of the file see 'fileencoding'.
2803 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2804 works like it was set to "unix'.
2805 This option is set automatically when starting to edit a file and
2806 'fileformats' is not empty and 'binary' is off.
2807 When this option is set, after starting to edit a file, the 'modified'
2808 option is set, because the file would be different when written.
2809 This option can not be changed when 'modifiable' is off.
2810 For backwards compatibility: When this option is set to "dos",
2811 'textmode' is set, otherwise 'textmode' is reset.
2812
2813 *'fileformats'* *'ffs'*
2814'fileformats' 'ffs' string (default:
2815 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2816 Vim Unix: "unix,dos",
2817 Vim Mac: "mac,unix,dos",
2818 Vi Cygwin: "unix,dos",
2819 Vi others: "")
2820 global
2821 {not in Vi}
2822 This gives the end-of-line (<EOL>) formats that will be tried when
2823 starting to edit a new buffer and when reading a file into an existing
2824 buffer:
2825 - When empty, the format defined with 'fileformat' will be used
2826 always. It is not set automatically.
2827 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002828 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002829 'fileformats' name will be used when a file is read into an existing
2830 buffer, no matter what 'fileformat' for that buffer is set to.
2831 - When more than one name is present, separated by commas, automatic
2832 <EOL> detection will be done when reading a file. When starting to
2833 edit a file, a check is done for the <EOL>:
2834 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2835 'fileformat' is set to "dos".
2836 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002837 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002838 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002839 3. If 'fileformat' has not yet been set, and if 'fileformats'
2840 includes "mac", 'fileformat' is set to "mac".
2841 This means that "mac" is only chosen when:
2842 "unix" is not present or no <NL> is found in the file, and
2843 "dos" is not present or no <CR><NL> is found in the file.
2844 Except: if "unix" was chosen, but there is a <CR> before
2845 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846 4. If 'fileformat' is still not set, the first name from
2847 'fileformats' is used.
2848 When reading a file into an existing buffer, the same is done, but
2849 this happens like 'fileformat' has been set appropriately for that
2850 file only, the option is not changed.
2851 When 'binary' is set, the value of 'fileformats' is not used.
2852
2853 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2854 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2855 done:
2856 - When 'fileformats' is empty, there is no automatic detection. Dos
2857 format will be used.
2858 - When 'fileformats' is set to one or more names, automatic detection
2859 is done. This is based on the first <NL> in the file: If there is a
2860 <CR> in front of it, Dos format is used, otherwise Unix format is
2861 used.
2862 Also see |file-formats|.
2863 For backwards compatibility: When this option is set to an empty
2864 string or one format (no comma is included), 'textauto' is reset,
2865 otherwise 'textauto' is set.
2866 NOTE: This option is set to the Vi default value when 'compatible' is
2867 set and to the Vim default value when 'compatible' is reset.
2868
2869 *'filetype'* *'ft'*
2870'filetype' 'ft' string (default: "")
2871 local to buffer
2872 {not in Vi}
2873 {not available when compiled without the |+autocmd|
2874 feature}
2875 When this option is set, the FileType autocommand event is triggered.
2876 All autocommands that match with the value of this option will be
2877 executed. Thus the value of 'filetype' is used in place of the file
2878 name.
2879 Otherwise this option does not always reflect the current file type.
2880 This option is normally set when the file type is detected. To enable
2881 this use the ":filetype on" command. |:filetype|
2882 Setting this option to a different value is most useful in a modeline,
2883 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002884 Example, for in an IDL file:
2885 /* vim: set filetype=idl : */ ~
2886 |FileType| |filetypes|
2887 When a dot appears in the value then this separates two filetype
2888 names. Example:
2889 /* vim: set filetype=c.doxygen : */ ~
2890 This will use the "c" filetype first, then the "doxygen" filetype.
2891 This works both for filetype plugins and for syntax files. More than
2892 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 Do not confuse this option with 'osfiletype', which is for the file
2894 type that is actually stored with the file.
2895 This option is not copied to another buffer, independent of the 's' or
2896 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002897 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002898
2899 *'fillchars'* *'fcs'*
2900'fillchars' 'fcs' string (default "vert:|,fold:-")
2901 global
2902 {not in Vi}
2903 {not available when compiled without the |+windows|
2904 and |+folding| features}
2905 Characters to fill the statuslines and vertical separators.
2906 It is a comma separated list of items:
2907
2908 item default Used for ~
2909 stl:c ' ' or '^' statusline of the current window
2910 stlnc:c ' ' or '-' statusline of the non-current windows
2911 vert:c '|' vertical separators |:vsplit|
2912 fold:c '-' filling 'foldtext'
2913 diff:c '-' deleted lines of the 'diff' option
2914
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002915 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002916 "stlnc" the space will be used when there is highlighting, '^' or '-'
2917 otherwise.
2918
2919 Example: >
2920 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2921< This is similar to the default, except that these characters will also
2922 be used when there is highlighting.
2923
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002924 for "stl" and "stlnc" only single-byte values are supported.
2925
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 The highlighting used for these items:
2927 item highlight group ~
2928 stl:c StatusLine |hl-StatusLine|
2929 stlnc:c StatusLineNC |hl-StatusLineNC|
2930 vert:c VertSplit |hl-VertSplit|
2931 fold:c Folded |hl-Folded|
2932 diff:c DiffDelete |hl-DiffDelete|
2933
2934 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2935'fkmap' 'fk' boolean (default off) *E198*
2936 global
2937 {not in Vi}
2938 {only available when compiled with the |+rightleft|
2939 feature}
2940 When on, the keyboard is mapped for the Farsi character set.
2941 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002942 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943
2944 *'foldclose'* *'fcl'*
2945'foldclose' 'fcl' string (default "")
2946 global
2947 {not in Vi}
2948 {not available when compiled without the |+folding|
2949 feature}
2950 When set to "all", a fold is closed when the cursor isn't in it and
2951 its level is higher than 'foldlevel'. Useful if you want folds to
2952 automatically close when moving out of them.
2953
2954 *'foldcolumn'* *'fdc'*
2955'foldcolumn' 'fdc' number (default 0)
2956 local to window
2957 {not in Vi}
2958 {not available when compiled without the |+folding|
2959 feature}
2960 When non-zero, a column with the specified width is shown at the side
2961 of the window which indicates open and closed folds. The maximum
2962 value is 12.
2963 See |folding|.
2964
2965 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2966'foldenable' 'fen' boolean (default on)
2967 local to window
2968 {not in Vi}
2969 {not available when compiled without the |+folding|
2970 feature}
2971 When off, all folds are open. This option can be used to quickly
2972 switch between showing all text unfolded and viewing the text with
2973 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002974 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002975 'foldenable' is off.
2976 This option is set by commands that create a new fold or close a fold.
2977 See |folding|.
2978
2979 *'foldexpr'* *'fde'*
2980'foldexpr' 'fde' string (default: "0")
2981 local to window
2982 {not in Vi}
2983 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002984 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002986 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002987
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002988 The expression may be evaluated in the |sandbox|, see
2989 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002990 This option can't be set from a |modeline| when the 'diff' option is
2991 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00002992
2993 It is not allowed to change text or jump to another window while
2994 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995
2996 *'foldignore'* *'fdi'*
2997'foldignore' 'fdi' string (default: "#")
2998 local to window
2999 {not in Vi}
3000 {not available when compiled without the |+folding|
3001 feature}
3002 Used only when 'foldmethod' is "indent". Lines starting with
3003 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003004 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 The default "#" works well for C programs. See |fold-indent|.
3006
3007 *'foldlevel'* *'fdl'*
3008'foldlevel' 'fdl' number (default: 0)
3009 local to window
3010 {not in Vi}
3011 {not available when compiled without the |+folding|
3012 feature}
3013 Sets the fold level: Folds with a higher level will be closed.
3014 Setting this option to zero will close all folds. Higher numbers will
3015 close fewer folds.
3016 This option is set by commands like |zm|, |zM| and |zR|.
3017 See |fold-foldlevel|.
3018
3019 *'foldlevelstart'* *'fdls'*
3020'foldlevelstart' 'fdls' number (default: -1)
3021 global
3022 {not in Vi}
3023 {not available when compiled without the |+folding|
3024 feature}
3025 Sets 'foldlevel' when starting to edit another buffer in a window.
3026 Useful to always start editing with all folds closed (value zero),
3027 some folds closed (one) or no folds closed (99).
3028 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003029 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 ignores this option and closes all folds.
3031 It is also done before BufReadPre autocommands, to allow an autocmd to
3032 overrule the 'foldlevel' value for specific files.
3033 When the value is negative, it is not used.
3034
3035 *'foldmarker'* *'fmr'* *E536*
3036'foldmarker' 'fmr' string (default: "{{{,}}}")
3037 local to window
3038 {not in Vi}
3039 {not available when compiled without the |+folding|
3040 feature}
3041 The start and end marker used when 'foldmethod' is "marker". There
3042 must be one comma, which separates the start and end marker. The
3043 marker is a literal string (a regular expression would be too slow).
3044 See |fold-marker|.
3045
3046 *'foldmethod'* *'fdm'*
3047'foldmethod' 'fdm' string (default: "manual")
3048 local to window
3049 {not in Vi}
3050 {not available when compiled without the |+folding|
3051 feature}
3052 The kind of folding used for the current window. Possible values:
3053 |fold-manual| manual Folds are created manually.
3054 |fold-indent| indent Lines with equal indent form a fold.
3055 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3056 |fold-marker| marker Markers are used to specify folds.
3057 |fold-syntax| syntax Syntax highlighting items specify folds.
3058 |fold-diff| diff Fold text that is not changed.
3059
3060 *'foldminlines'* *'fml'*
3061'foldminlines' 'fml' number (default: 1)
3062 local to window
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
3065 feature}
3066 Sets the minimum number of screen lines for a fold to be displayed
3067 closed. Also for manually closed folds.
3068 Note that this only has an effect of what is displayed. After using
3069 "zc" to close a fold, which is displayed open because it's smaller
3070 than 'foldminlines', a following "zc" may close a containing fold.
3071
3072 *'foldnestmax'* *'fdn'*
3073'foldnestmax' 'fdn' number (default: 20)
3074 local to window
3075 {not in Vi}
3076 {not available when compiled without the |+folding|
3077 feature}
3078 Sets the maximum nesting of folds for the "indent" and "syntax"
3079 methods. This avoids that too many folds will be created. Using more
3080 than 20 doesn't work, because the internal limit is 20.
3081
3082 *'foldopen'* *'fdo'*
3083'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3084 search,tag,undo")
3085 global
3086 {not in Vi}
3087 {not available when compiled without the |+folding|
3088 feature}
3089 Specifies for which type of commands folds will be opened, if the
3090 command moves the cursor into a closed fold. It is a comma separated
3091 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003092 NOTE: When the command is part of a mapping this option is not used.
3093 Add the |zv| command to the mapping to get the same effect.
3094 (rationale: the mapping may want to control opening folds itself)
3095
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 item commands ~
3097 all any
3098 block "(", "{", "[[", "[{", etc.
3099 hor horizontal movements: "l", "w", "fx", etc.
3100 insert any command in Insert mode
3101 jump far jumps: "G", "gg", etc.
3102 mark jumping to a mark: "'m", CTRL-O, etc.
3103 percent "%"
3104 quickfix ":cn", ":crew", ":make", etc.
3105 search search for a pattern: "/", "n", "*", "gd", etc.
3106 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003107 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 tag jumping to a tag: ":ta", CTRL-T, etc.
3109 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 When a movement command is used for an operator (e.g., "dl" or "y%")
3111 this option is not used. This means the operator will include the
3112 whole closed fold.
3113 Note that vertical movements are not here, because it would make it
3114 very difficult to move onto a closed fold.
3115 In insert mode the folds containing the cursor will always be open
3116 when text is inserted.
3117 To close folds you can re-apply 'foldlevel' with the |zx| command or
3118 set the 'foldclose' option to "all".
3119
3120 *'foldtext'* *'fdt'*
3121'foldtext' 'fdt' string (default: "foldtext()")
3122 local to window
3123 {not in Vi}
3124 {not available when compiled without the |+folding|
3125 feature}
3126 An expression which is used to specify the text displayed for a closed
3127 fold. See |fold-foldtext|.
3128
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003129 The expression may be evaluated in the |sandbox|, see
3130 |sandbox-option|.
3131
3132 It is not allowed to change text or jump to another window while
3133 evaluating 'foldtext' |textlock|.
3134
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 *'formatoptions'* *'fo'*
3136'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3137 local to buffer
3138 {not in Vi}
3139 This is a sequence of letters which describes how automatic
3140 formatting is to be done. See |fo-table|. When the 'paste' option is
3141 on, no formatting is done (like 'formatoptions' is empty). Commas can
3142 be inserted for readability.
3143 To avoid problems with flags that are added in the future, use the
3144 "+=" and "-=" feature of ":set" |add-option-flags|.
3145 NOTE: This option is set to the Vi default value when 'compatible' is
3146 set and to the Vim default value when 'compatible' is reset.
3147
Bram Moolenaar86b68352004-12-27 21:59:20 +00003148 *'formatlistpat'* *'flp'*
3149'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3150 local to buffer
3151 {not in Vi}
3152 A pattern that is used to recognize a list header. This is used for
3153 the "n" flag in 'formatoptions'.
3154 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003155 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003156 while still checking more characters. There must be a character
3157 following the pattern, when it matches the whole line it is handled
3158 like there is no match.
3159 The default recognizes a number, followed by an optional punctuation
3160 character and white space.
3161
Bram Moolenaar071d4272004-06-13 20:20:40 +00003162 *'formatprg'* *'fp'*
3163'formatprg' 'fp' string (default "")
3164 global
3165 {not in Vi}
3166 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003167 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003168 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003169 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003170 If the 'formatexpr' option is not empty it will be used instead.
3171 Otherwise, if 'formatprg' option is an empty string, the internal
3172 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003173 Environment variables are expanded |:set_env|. See |option-backslash|
3174 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003175 The expression may be evaluated in the |sandbox|, see
3176 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003177
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003178 *'formatexpr'* *'fex'*
3179'formatexpr' 'fex' string (default "")
3180 local to buffer
3181 {not in Vi}
3182 {not available when compiled without the |+eval|
3183 feature}
3184 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003185 operator or automatic formatting (see 'formatoptions'). When this
3186 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003187
3188 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003189 The |v:count| variable holds the number of lines to be formatted.
3190 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003191 inserted if the expression is being evaluated due to
3192 automatic formatting. This can be empty. Don't insert
3193 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003194
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003195 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003196 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003197< This will invoke the mylang#Format() function in the
3198 autoload/mylang.vim file in 'runtimepath'. |autoload|
3199
3200 The expression is also evaluated when 'textwidth' is set and adding
3201 text beyond that limit. This happens under the same conditions as
3202 when internal formatting is used. Make sure the cursor is kept in the
3203 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003204 return "i" or "R" in this situation.
3205
3206 When the expression evaluates to non-zero Vim will fall back to using
3207 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003208
3209 The expression may be evaluated in the |sandbox|, see
3210 |sandbox-option|.
3211
3212 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003213'fsync' 'fs' boolean (default on)
3214 global
3215 {not in Vi}
3216 When on, the library function fsync() will be called after writing a
3217 file. This will flush a file to disk, ensuring that it is safely
3218 written even on filesystems which do metadata-only journaling. This
3219 will force the harddrive to spin up on Linux systems running in laptop
3220 mode, so it may be undesirable in some situations. Be warned that
3221 turning this off increases the chances of data loss after a crash. On
3222 systems without an fsync() implementation, this variable is always
3223 off.
3224 Also see 'swapsync' for controlling fsync() on swap files.
3225
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3227'gdefault' 'gd' boolean (default off)
3228 global
3229 {not in Vi}
3230 When on, the ":substitute" flag 'g' is default on. This means that
3231 all matches in a line are substituted instead of one. When a 'g' flag
3232 is given to a ":substitute" command, this will toggle the substitution
3233 of all or one match. See |complex-change|.
3234
3235 command 'gdefault' on 'gdefault' off ~
3236 :s/// subst. all subst. one
3237 :s///g subst. one subst. all
3238 :s///gg subst. all subst. one
3239
3240 NOTE: This option is reset when 'compatible' is set.
3241
3242 *'grepformat'* *'gfm'*
3243'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3244 global
3245 {not in Vi}
3246 Format to recognize for the ":grep" command output.
3247 This is a scanf-like string that uses the same format as the
3248 'errorformat' option: see |errorformat|.
3249
3250 *'grepprg'* *'gp'*
3251'grepprg' 'gp' string (default "grep -n ",
3252 Unix: "grep -n $* /dev/null",
3253 Win32: "findstr /n" or "grep -n",
3254 VMS: "SEARCH/NUMBERS ")
3255 global or local to buffer |global-local|
3256 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003257 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003258 and '#' characters, which are expanded like when used in a command-
3259 line. The placeholder "$*" is allowed to specify where the arguments
3260 will be included. Environment variables are expanded |:set_env|. See
3261 |option-backslash| about including spaces and backslashes.
3262 When your "grep" accepts the "-H" argument, use this to make ":grep"
3263 also work well with a single file: >
3264 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003265< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003266 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3267 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003268 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 apply equally to 'grepprg'.
3270 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3271 otherwise it's "grep -n".
3272 This option cannot be set from a |modeline| or in the |sandbox|, for
3273 security reasons.
3274
3275 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3276'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3277 ve:ver35-Cursor,
3278 o:hor50-Cursor,
3279 i-ci:ver25-Cursor/lCursor,
3280 r-cr:hor20-Cursor/lCursor,
3281 sm:block-Cursor
3282 -blinkwait175-blinkoff150-blinkon175",
3283 for MS-DOS and Win32 console:
3284 "n-v-c:block,o:hor50,i-ci:hor15,
3285 r-cr:hor30,sm:block")
3286 global
3287 {not in Vi}
3288 {only available when compiled with GUI enabled, and
3289 for MS-DOS and Win32 console}
3290 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003291 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 the height of the cursor can be changed. This can be done by
3293 specifying a block cursor, or a percentage for a vertical or
3294 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003295 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003297 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003298 mode-list and an argument-list:
3299 mode-list:argument-list,mode-list:argument-list,..
3300 The mode-list is a dash separated list of these modes:
3301 n Normal mode
3302 v Visual mode
3303 ve Visual mode with 'selection' "exclusive" (same as 'v',
3304 if not specified)
3305 o Operator-pending mode
3306 i Insert mode
3307 r Replace mode
3308 c Command-line Normal (append) mode
3309 ci Command-line Insert mode
3310 cr Command-line Replace mode
3311 sm showmatch in Insert mode
3312 a all modes
3313 The argument-list is a dash separated list of these arguments:
3314 hor{N} horizontal bar, {N} percent of the character height
3315 ver{N} vertical bar, {N} percent of the character width
3316 block block cursor, fills the whole character
3317 [only one of the above three should be present]
3318 blinkwait{N} *cursor-blinking*
3319 blinkon{N}
3320 blinkoff{N}
3321 blink times for cursor: blinkwait is the delay before
3322 the cursor starts blinking, blinkon is the time that
3323 the cursor is shown and blinkoff is the time that the
3324 cursor is not shown. The times are in msec. When one
3325 of the numbers is zero, there is no blinking. The
3326 default is: "blinkwait700-blinkon400-blinkoff250".
3327 These numbers are used for a missing entry. This
3328 means that blinking is enabled by default. To switch
3329 blinking off you can use "blinkon0". The cursor only
3330 blinks when Vim is waiting for input, not while
3331 executing a command.
3332 To make the cursor blink in an xterm, see
3333 |xterm-blink|.
3334 {group-name}
3335 a highlight group name, that sets the color and font
3336 for the cursor
3337 {group-name}/{group-name}
3338 Two highlight group names, the first is used when
3339 no language mappings are used, the other when they
3340 are. |language-mapping|
3341
3342 Examples of parts:
3343 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3344 block cursor with colors from the "nCursor"
3345 highlight group
3346 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3347 In Insert and Command-line Insert mode, use a
3348 30% vertical bar cursor with colors from the
3349 "iCursor" highlight group. Blink a bit
3350 faster.
3351
3352 The 'a' mode is different. It will set the given argument-list for
3353 all modes. It does not reset anything to defaults. This can be used
3354 to do a common setting for all modes. For example, to switch off
3355 blinking: "a:blinkon0"
3356
3357 Examples of cursor highlighting: >
3358 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3359 :highlight Cursor gui=NONE guifg=bg guibg=fg
3360<
3361 *'guifont'* *'gfn'*
3362 *E235* *E596* *E610* *E611*
3363'guifont' 'gfn' string (default "")
3364 global
3365 {not in Vi}
3366 {only available when compiled with GUI enabled}
3367 This is a list of fonts which will be used for the GUI version of Vim.
3368 In its simplest form the value is just one font name. When
3369 the font cannot be found you will get an error message. To try other
3370 font names a list can be specified, font names separated with commas.
3371 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003372
Bram Moolenaar05159a02005-02-26 23:04:13 +00003373 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3374 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003375
Bram Moolenaar071d4272004-06-13 20:20:40 +00003376 Spaces after a comma are ignored. To include a comma in a font name
3377 precede it with a backslash. Setting an option requires an extra
3378 backslash before a space and a backslash. See also
3379 |option-backslash|. For example: >
3380 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003381< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003382 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003383
3384 If none of the fonts can be loaded, Vim will keep the current setting.
3385 If an empty font list is given, Vim will try using other resource
3386 settings (for X, it will use the Vim.font resource), and finally it
3387 will try some builtin default which should always be there ("7x13" in
3388 the case of X). The font names given should be "normal" fonts. Vim
3389 will try to find the related bold and italic fonts.
3390
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003391 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003392 :set guifont=*
3393< will bring up a font requester, where you can pick the font you want.
3394
3395 The font name depends on the GUI used. See |setting-guifont| for a
3396 way to set 'guifont' for various systems.
3397
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 For the GTK+ 2 GUI the font name looks like this: >
3399 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003400< That's all. XLFDs are not used. For Chinese this is reported to work
3401 well: >
3402 if has("gui_gtk2")
3403 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3404 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3405 endif
3406<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003407 For Mac OSX you can use something like this: >
3408 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003409< Also see 'macatsui', it can help fix display problems.
3410 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003412 width). An exception is GTK 2: all fonts are accepted, but
3413 mono-spaced fonts look best.
3414
Bram Moolenaar071d4272004-06-13 20:20:40 +00003415 To preview a font on X11, you might be able to use the "xfontsel"
3416 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003417
Bram Moolenaar071d4272004-06-13 20:20:40 +00003418 For the Win32 GUI *E244* *E245*
3419 - takes these options in the font name:
3420 hXX - height is XX (points, can be floating-point)
3421 wXX - width is XX (points, can be floating-point)
3422 b - bold
3423 i - italic
3424 u - underline
3425 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003426 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3428 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3429 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003430 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003431
3432 Use a ':' to separate the options.
3433 - A '_' can be used in the place of a space, so you don't need to use
3434 backslashes to escape the spaces.
3435 - Examples: >
3436 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3437 :set guifont=Andale_Mono:h7.5:w4.5
3438< See also |font-sizes|.
3439
3440 *'guifontset'* *'gfs'*
3441 *E250* *E252* *E234* *E597* *E598*
3442'guifontset' 'gfs' string (default "")
3443 global
3444 {not in Vi}
3445 {only available when compiled with GUI enabled and
3446 with the |+xfontset| feature}
3447 {not available in the GTK+ 2 GUI}
3448 When not empty, specifies two (or more) fonts to be used. The first
3449 one for normal English, the second one for your special language. See
3450 |xfontset|.
3451 Setting this option also means that all font names will be handled as
3452 a fontset name. Also the ones used for the "font" argument of the
3453 |:highlight| command.
3454 The fonts must match with the current locale. If fonts for the
3455 character sets that the current locale uses are not included, setting
3456 'guifontset' will fail.
3457 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3458 the comma-separated names are alternative names, one of which will be
3459 used. In 'guifontset' the whole string is one fontset name,
3460 including the commas. It is not possible to specify alternative
3461 fontset names.
3462 This example works on many X11 systems: >
3463 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3464<
3465 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3466'guifontwide' 'gfw' string (default "")
3467 global
3468 {not in Vi}
3469 {only available when compiled with GUI enabled}
3470 When not empty, specifies a comma-separated list of fonts to be used
3471 for double-width characters. The first font that can be loaded is
3472 used.
3473 Note: The size of these fonts must be exactly twice as wide as the one
3474 specified with 'guifont' and the same height.
3475
3476 All GUI versions but GTK+ 2:
3477
3478 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3479 'guifontset' is empty or invalid.
3480 When 'guifont' is set and a valid font is found in it and
3481 'guifontwide' is empty Vim will attempt to find a matching
3482 double-width font and set 'guifontwide' to it.
3483
3484 GTK+ 2 GUI only: *guifontwide_gtk2*
3485
3486 If set and valid, 'guifontwide' is always used for double width
3487 characters, even if 'encoding' is not set to "utf-8".
3488 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003489 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 font for characters not available in 'guifont'. Thus you do not need
3491 to set 'guifontwide' at all unless you want to override the choice
3492 made by Pango/Xft.
3493
3494 *'guiheadroom'* *'ghr'*
3495'guiheadroom' 'ghr' number (default 50)
3496 global
3497 {not in Vi} {only for GTK and X11 GUI}
3498 The number of pixels subtracted from the screen height when fitting
3499 the GUI window on the screen. Set this before the GUI is started,
3500 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003501 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 lines will be left for window decorations and other items on the
3503 screen. Set it to a negative value to allow windows taller than the
3504 screen.
3505
3506 *'guioptions'* *'go'*
3507'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003508 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 global
3510 {not in Vi}
3511 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003512 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513 sequence of letters which describes what components and options of the
3514 GUI should be used.
3515 To avoid problems with flags that are added in the future, use the
3516 "+=" and "-=" feature of ":set" |add-option-flags|.
3517
3518 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003519 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003520 'a' Autoselect: If present, then whenever VISUAL mode is started,
3521 or the Visual area extended, Vim tries to become the owner of
3522 the windowing system's global selection. This means that the
3523 Visually highlighted text is available for pasting into other
3524 applications as well as into Vim itself. When the Visual mode
3525 ends, possibly due to an operation on the text, or when an
3526 application wants to paste the selection, the highlighted text
3527 is automatically yanked into the "* selection register.
3528 Thus the selection is still available for pasting into other
3529 applications after the VISUAL mode has ended.
3530 If not present, then Vim won't become the owner of the
3531 windowing system's global selection unless explicitly told to
3532 by a yank or delete operation for the "* register.
3533 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003534 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003535 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003536 applies to the modeless selection.
3537
3538 'guioptions' autoselect Visual autoselect modeless ~
3539 "" - -
3540 "a" yes yes
3541 "A" - yes
3542 "aA" yes yes
3543
Bram Moolenaar02467872007-05-06 13:22:01 +00003544 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003545 'c' Use console dialogs instead of popup dialogs for simple
3546 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003547 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003548 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003549 'guitablabel' can be used to change the text in the labels.
3550 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003551 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003552 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003553 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 'f' Foreground: Don't use fork() to detach the GUI from the shell
3555 where it was started. Use this for programs that wait for the
3556 editor to finish (e.g., an e-mail program). Alternatively you
3557 can use "gvim -f" or ":gui -f" to start the GUI in the
3558 foreground. |gui-fork|
3559 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003560 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003561 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003562 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3563 corner of the window. It's black&white on non-GTK, because of
3564 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003565 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003566 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003567 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003568 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003570 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003571 file is sourced the system menu has already been loaded; the
3572 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003573 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 'g' Grey menu items: Make menu items that are not active grey. If
3575 'g' is not included inactive menu items are not shown at all.
3576 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003577 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003578 't' Include tearoff menu items. Currently only works for Win32,
3579 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003580 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003581 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003582 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003583 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003585 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 'R' Right-hand scrollbar is present when there is a vertically
3587 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003588 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003590 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003591 'L' Left-hand scrollbar is present when there is a vertically
3592 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003593 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3595 the longest visible line, or on the cursor line if the 'h'
3596 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003597 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003598 'h' Limit horizontal scrollbar size to the length of the cursor
3599 line. Reduces computations. |gui-horiz-scroll|
3600
3601 And yes, you may even have scrollbars on the left AND the right if
3602 you really want to :-). See |gui-scrollbars| for more information.
3603
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003604 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003605 'v' Use a vertical button layout for dialogs. When not included,
3606 a horizontal layout is preferred, but when it doesn't fit a
3607 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003608 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 'p' Use Pointer callbacks for X11 GUI. This is required for some
3610 window managers. If the cursor is not blinking or hollow at
3611 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003612 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003614 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003615 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003616
Bram Moolenaar02467872007-05-06 13:22:01 +00003617
Bram Moolenaar071d4272004-06-13 20:20:40 +00003618 *'guipty'* *'noguipty'*
3619'guipty' boolean (default on)
3620 global
3621 {not in Vi}
3622 {only available when compiled with GUI enabled}
3623 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3624 I/O to/from shell commands. See |gui-pty|.
3625
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003626 *'guitablabel'* *'gtl'*
3627'guitablabel' 'gtl' string (default empty)
3628 global
3629 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003630 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003631 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003632 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003633 pages line. When empty and when the result is empty Vim will use a
3634 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003635
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003636 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003637 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003638
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003639 Only used when the GUI tab pages line is displayed. 'e' must be
3640 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3641 used.
3642
Bram Moolenaar57657d82006-04-21 22:12:41 +00003643 *'guitabtooltip'* *'gtt'*
3644'guitabtooltip' 'gtt' string (default empty)
3645 global
3646 {not in Vi}
3647 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003648 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003649 When nonempty describes the text to use in a tooltip for the GUI tab
3650 pages line. When empty Vim will use a default tooltip.
3651 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003652 You can include a line break. Simplest method is to use |:let|: >
3653 :let &guitabtooltip = "line one\nline two"
3654<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003655
Bram Moolenaar071d4272004-06-13 20:20:40 +00003656 *'helpfile'* *'hf'*
3657'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3658 (others) "$VIMRUNTIME/doc/help.txt")
3659 global
3660 {not in Vi}
3661 Name of the main help file. All distributed help files should be
3662 placed together in one directory. Additionally, all "doc" directories
3663 in 'runtimepath' will be used.
3664 Environment variables are expanded |:set_env|. For example:
3665 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003666 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 spaces and backslashes.
3668 This option cannot be set from a |modeline| or in the |sandbox|, for
3669 security reasons.
3670
3671 *'helpheight'* *'hh'*
3672'helpheight' 'hh' number (default 20)
3673 global
3674 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003675 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 feature}
3677 Minimal initial height of the help window when it is opened with the
3678 ":help" command. The initial height of the help window is half of the
3679 current window, or (when the 'ea' option is on) the same as other
3680 windows. When the height is less than 'helpheight', the height is
3681 set to 'helpheight'. Set to zero to disable.
3682
3683 *'helplang'* *'hlg'*
3684'helplang' 'hlg' string (default: messages language or empty)
3685 global
3686 {only available when compiled with the |+multi_lang|
3687 feature}
3688 {not in Vi}
3689 Comma separated list of languages. Vim will use the first language
3690 for which the desired help can be found. The English help will always
3691 be used as a last resort. You can add "en" to prefer English over
3692 another language, but that will only find tags that exist in that
3693 language and not in the English help.
3694 Example: >
3695 :set helplang=de,it
3696< This will first search German, then Italian and finally English help
3697 files.
3698 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3699 try to find the tag in the current language before using this option.
3700 See |help-translated|.
3701
3702 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3703'hidden' 'hid' boolean (default off)
3704 global
3705 {not in Vi}
3706 When off a buffer is unloaded when it is |abandon|ed. When on a
3707 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3708 displayed in another window, it does not become hidden, of course.
3709 The commands that move through the buffer list sometimes make a buffer
3710 hidden although the 'hidden' option is off: When the buffer is
3711 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003712 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003713 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 This option is set for one command with ":hide {command}" |:hide|.
3715 WARNING: It's easy to forget that you have changes in hidden buffers.
3716 Think twice when using ":q!" or ":qa!".
3717
3718 *'highlight'* *'hl'*
3719'highlight' 'hl' string (default (as a single string):
3720 "8:SpecialKey,@:NonText,d:Directory,
3721 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3722 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003723 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003724 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3725 f:Folded,F:FoldColumn,A:DiffAdd,
3726 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003727 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003728 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003729 +:Pmenu,=:PmenuSel,
3730 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003731 global
3732 {not in Vi}
3733 This option can be used to set highlighting mode for various
3734 occasions. It is a comma separated list of character pairs. The
3735 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003736 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003737 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3738 |hl-NonText| @ '~' and '@' at the end of the window and
3739 characters from 'showbreak'
3740 |hl-Directory| d directories in CTRL-D listing and other special
3741 things in listings
3742 |hl-ErrorMsg| e error messages
3743 h (obsolete, ignored)
3744 |hl-IncSearch| i 'incsearch' highlighting
3745 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3746 |hl-MoreMsg| m |more-prompt|
3747 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003748 |hl-LineNr| n line number for ":number" and ":#" commands, and
3749 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003750 |hl-Question| r |hit-enter| prompt and yes/no questions
3751 |hl-StatusLine| s status line of current window |status-line|
3752 |hl-StatusLineNC| S status lines of not-current windows
3753 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3754 |hl-VertSplit| c column used to separate vertically split windows
3755 |hl-Visual| v Visual mode
3756 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3757 Selection" Only X11 Gui's |gui-x11| and
3758 |xterm-clipboard|.
3759 |hl-WarningMsg| w warning messages
3760 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3761 |hl-Folded| f line used for closed folds
3762 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003763 |hl-DiffAdd| A added line in diff mode
3764 |hl-DiffChange| C changed line in diff mode
3765 |hl-DiffDelete| D deleted line in diff mode
3766 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003768 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003769 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003770 |hl-SpellRare| R rare word |spell|
3771 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003772 |hl-Conceal| - the placeholders used for concealed characters
3773 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003774 |hl-Pmenu| + popup menu normal line
3775 |hl-PmenuSel| = popup menu normal line
3776 |hl-PmenuSbar| x popup menu scrollbar
3777 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778
3779 The display modes are:
3780 r reverse (termcap entry "mr" and "me")
3781 i italic (termcap entry "ZH" and "ZR")
3782 b bold (termcap entry "md" and "me")
3783 s standout (termcap entry "so" and "se")
3784 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003785 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 n no highlighting
3787 - no highlighting
3788 : use a highlight group
3789 The default is used for occasions that are not included.
3790 If you want to change what the display modes do, see |dos-colors|
3791 for an example.
3792 When using the ':' display mode, this must be followed by the name of
3793 a highlight group. A highlight group can be used to define any type
3794 of highlighting, including using color. See |:highlight| on how to
3795 define one. The default uses a different group for each occasion.
3796 See |highlight-default| for the default highlight groups.
3797
3798 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3799'hlsearch' 'hls' boolean (default off)
3800 global
3801 {not in Vi}
3802 {not available when compiled without the
3803 |+extra_search| feature}
3804 When there is a previous search pattern, highlight all its matches.
3805 The type of highlighting used can be set with the 'l' occasion in the
3806 'highlight' option. This uses the "Search" highlight group by
3807 default. Note that only the matching text is highlighted, any offsets
3808 are not applied.
3809 See also: 'incsearch' and |:match|.
3810 When you get bored looking at the highlighted matches, you can turn it
3811 off with |:nohlsearch|. As soon as you use a search command, the
3812 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003813 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 When the search pattern can match an end-of-line, Vim will try to
3815 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003816 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003817 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003818 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 NOTE: This option is reset when 'compatible' is set.
3820
3821 *'history'* *'hi'*
3822'history' 'hi' number (Vim default: 20, Vi default: 0)
3823 global
3824 {not in Vi}
3825 A history of ":" commands, and a history of previous search patterns
3826 are remembered. This option decides how many entries may be stored in
3827 each of these histories (see |cmdline-editing|).
3828 NOTE: This option is set to the Vi default value when 'compatible' is
3829 set and to the Vim default value when 'compatible' is reset.
3830
3831 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3832'hkmap' 'hk' boolean (default off)
3833 global
3834 {not in Vi}
3835 {only available when compiled with the |+rightleft|
3836 feature}
3837 When on, the keyboard is mapped for the Hebrew character set.
3838 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3839 toggle this option. See |rileft.txt|.
3840 NOTE: This option is reset when 'compatible' is set.
3841
3842 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3843'hkmapp' 'hkp' boolean (default off)
3844 global
3845 {not in Vi}
3846 {only available when compiled with the |+rightleft|
3847 feature}
3848 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3849 This is useful if you have a non-Hebrew keyboard.
3850 See |rileft.txt|.
3851 NOTE: This option is reset when 'compatible' is set.
3852
3853 *'icon'* *'noicon'*
3854'icon' boolean (default off, on when title can be restored)
3855 global
3856 {not in Vi}
3857 {not available when compiled without the |+title|
3858 feature}
3859 When on, the icon text of the window will be set to the value of
3860 'iconstring' (if it is not empty), or to the name of the file
3861 currently being edited. Only the last part of the name is used.
3862 Overridden by the 'iconstring' option.
3863 Only works if the terminal supports setting window icons (currently
3864 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3865 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3866 builtin termcap).
3867 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003868 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 X11.
3870
3871 *'iconstring'*
3872'iconstring' string (default "")
3873 global
3874 {not in Vi}
3875 {not available when compiled without the |+title|
3876 feature}
3877 When this option is not empty, it will be used for the icon text of
3878 the window. This happens only when the 'icon' option is on.
3879 Only works if the terminal supports setting window icon text
3880 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3881 Does not work for MS Windows.
3882 When Vim was compiled with HAVE_X11 defined, the original icon will be
3883 restored if possible |X11|.
3884 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003885 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003886 'titlestring' for example settings.
3887 {not available when compiled without the |+statusline| feature}
3888
3889 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3890'ignorecase' 'ic' boolean (default off)
3891 global
3892 Ignore case in search patterns. Also used when searching in the tags
3893 file.
3894 Also see 'smartcase'.
3895 Can be overruled by using "\c" or "\C" in the pattern, see
3896 |/ignorecase|.
3897
3898 *'imactivatekey'* *'imak'*
3899'imactivatekey' 'imak' string (default "")
3900 global
3901 {not in Vi}
3902 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003903 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003904 Specifies the key that your Input Method in X-Windows uses for
3905 activation. When this is specified correctly, vim can fully control
3906 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3907 You can't use this option to change the activation key, the option
3908 tells Vim what the key is.
3909 Format:
3910 [MODIFIER_FLAG-]KEY_STRING
3911
3912 These characters can be used for MODIFIER_FLAG (case is ignored):
3913 S Shift key
3914 L Lock key
3915 C Control key
3916 1 Mod1 key
3917 2 Mod2 key
3918 3 Mod3 key
3919 4 Mod4 key
3920 5 Mod5 key
3921 Combinations are allowed, for example "S-C-space" or "SC-space" are
3922 both shift+ctrl+space.
3923 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3924
3925 Example: >
3926 :set imactivatekey=S-space
3927< "S-space" means shift+space. This is the activation key for kinput2 +
3928 canna (Japanese), and ami (Korean).
3929
3930 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3931'imcmdline' 'imc' boolean (default off)
3932 global
3933 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003934 {only available when compiled with the |+xim|,
3935 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003936 When set the Input Method is always on when starting to edit a command
3937 line, unless entering a search pattern (see 'imsearch' for that).
3938 Setting this option is useful when your input method allows entering
3939 English characters directly, e.g., when it's used to type accented
3940 characters with dead keys.
3941
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003942 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3944 global
3945 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003946 {only available when compiled with the |+xim|,
3947 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 When set the Input Method is never used. This is useful to disable
3949 the IM when it doesn't work properly.
3950 Currently this option is on by default for SGI/IRIX machines. This
3951 may change in later releases.
3952
3953 *'iminsert'* *'imi'*
3954'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3955 local to buffer
3956 {not in Vi}
3957 Specifies whether :lmap or an Input Method (IM) is to be used in
3958 Insert mode. Valid values:
3959 0 :lmap is off and IM is off
3960 1 :lmap is ON and IM is off
3961 2 :lmap is off and IM is ON
3962 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3963 or |global-ime|.
3964 To always reset the option to zero when leaving Insert mode with <Esc>
3965 this can be used: >
3966 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3967< This makes :lmap and IM turn off automatically when leaving Insert
3968 mode.
3969 Note that this option changes when using CTRL-^ in Insert mode
3970 |i_CTRL-^|.
3971 The value is set to 1 when setting 'keymap' to a valid keymap name.
3972 It is also used for the argument of commands like "r" and "f".
3973 The value 0 may not work correctly with Athena and Motif with some XIM
3974 methods. Use 'imdisable' to disable XIM then.
3975
3976 *'imsearch'* *'ims'*
3977'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3978 local to buffer
3979 {not in Vi}
3980 Specifies whether :lmap or an Input Method (IM) is to be used when
3981 entering a search pattern. Valid values:
3982 -1 the value of 'iminsert' is used, makes it look like
3983 'iminsert' is also used when typing a search pattern
3984 0 :lmap is off and IM is off
3985 1 :lmap is ON and IM is off
3986 2 :lmap is off and IM is ON
3987 Note that this option changes when using CTRL-^ in Command-line mode
3988 |c_CTRL-^|.
3989 The value is set to 1 when it is not -1 and setting the 'keymap'
3990 option to a valid keymap name.
3991 The value 0 may not work correctly with Athena and Motif with some XIM
3992 methods. Use 'imdisable' to disable XIM then.
3993
3994 *'include'* *'inc'*
3995'include' 'inc' string (default "^\s*#\s*include")
3996 global or local to buffer |global-local|
3997 {not in Vi}
3998 {not available when compiled without the
3999 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004000 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001 pattern, just like for the "/" command (See |pattern|). The default
4002 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004003 "]I", "[d", etc.
4004 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004005 comes after the matched pattern. But if "\zs" appears in the pattern
4006 then the text matched from "\zs" to the end, or until "\ze" if it
4007 appears, is used as the file name. Use this to include characters
4008 that are not in 'isfname', such as a space. You can then use
4009 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004010 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011
4012 *'includeexpr'* *'inex'*
4013'includeexpr' 'inex' string (default "")
4014 local to buffer
4015 {not in Vi}
4016 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004017 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004019 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004020 :set includeexpr=substitute(v:fname,'\\.','/','g')
4021< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004022
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004024 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 Also used for |<cfile>|.
4026
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004027 The expression may be evaluated in the |sandbox|, see
4028 |sandbox-option|.
4029
4030 It is not allowed to change text or jump to another window while
4031 evaluating 'includeexpr' |textlock|.
4032
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4034'incsearch' 'is' boolean (default off)
4035 global
4036 {not in Vi}
4037 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004038 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004039 While typing a search command, show where the pattern, as it was typed
4040 so far, matches. The matched string is highlighted. If the pattern
4041 is invalid or not found, nothing is shown. The screen will be updated
4042 often, this is only useful on fast terminals.
4043 Note that the match will be shown, but the cursor will return to its
4044 original position when no match is found and when pressing <Esc>. You
4045 still need to finish the search command with <Enter> to move the
4046 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004047 When compiled with the |+reltime| feature Vim only searches for about
4048 half a second. With a complicated pattern and/or a lot of text the
4049 match may not be found. This is to avoid that Vim hangs while you
4050 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004051 The highlighting can be set with the 'i' flag in 'highlight'.
4052 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004053 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004054 to the command line. If 'ignorecase' and 'smartcase' are set and the
4055 command line has no uppercase characters, the added character is
4056 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004057 CTRL-R CTRL-W can be used to add the word at the end of the current
4058 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 NOTE: This option is reset when 'compatible' is set.
4060
4061 *'indentexpr'* *'inde'*
4062'indentexpr' 'inde' string (default "")
4063 local to buffer
4064 {not in Vi}
4065 {not available when compiled without the |+cindent|
4066 or |+eval| features}
4067 Expression which is evaluated to obtain the proper indent for a line.
4068 It is used when a new line is created, for the |=| operator and
4069 in Insert mode as specified with the 'indentkeys' option.
4070 When this option is not empty, it overrules the 'cindent' and
4071 'smartindent' indenting.
4072 When 'paste' is set this option is not used for indenting.
4073 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004074 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004075 when the expression is evaluated (but it may be moved around).
4076 The expression must return the number of spaces worth of indent. It
4077 can return "-1" to keep the current indent (this means 'autoindent' is
4078 used for the indent).
4079 Functions useful for computing the indent are |indent()|, |cindent()|
4080 and |lispindent()|.
4081 The evaluation of the expression must not have side effects! It must
4082 not change the text, jump to another window, etc. Afterwards the
4083 cursor position is always restored, thus the cursor may be moved.
4084 Normally this option would be set to call a function: >
4085 :set indentexpr=GetMyIndent()
4086< Error messages will be suppressed, unless the 'debug' option contains
4087 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004088 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 NOTE: This option is made empty when 'compatible' is set.
4090
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004091 The expression may be evaluated in the |sandbox|, see
4092 |sandbox-option|.
4093
4094 It is not allowed to change text or jump to another window while
4095 evaluating 'indentexpr' |textlock|.
4096
4097
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 *'indentkeys'* *'indk'*
4099'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4100 local to buffer
4101 {not in Vi}
4102 {not available when compiled without the |+cindent|
4103 feature}
4104 A list of keys that, when typed in Insert mode, cause reindenting of
4105 the current line. Only happens if 'indentexpr' isn't empty.
4106 The format is identical to 'cinkeys', see |indentkeys-format|.
4107 See |C-indenting| and |indent-expression|.
4108
4109 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4110'infercase' 'inf' boolean (default off)
4111 local to buffer
4112 {not in Vi}
4113 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004114 'ignorecase' is also on, the case of the match is adjusted depending
4115 on the typed text. If the typed text contains a lowercase letter
4116 where the match has an upper case letter, the completed part is made
4117 lowercase. If the typed text has no lowercase letters and the match
4118 has a lowercase letter where the typed text has an uppercase letter,
4119 and there is a letter before it, the completed part is made uppercase.
4120 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004121
4122 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4123'insertmode' 'im' boolean (default off)
4124 global
4125 {not in Vi}
4126 Makes Vim work in a way that Insert mode is the default mode. Useful
4127 if you want to use Vim as a modeless editor. Used for |evim|.
4128 These Insert mode commands will be useful:
4129 - Use the cursor keys to move around.
4130 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4131 this is a mapping, it is executed as if 'insertmode' was off.
4132 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004134 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4135 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
4137 These items change when 'insertmode' is set:
4138 - when starting to edit of a file, Vim goes to Insert mode.
4139 - <Esc> in Insert mode is a no-op and beeps.
4140 - <Esc> in Normal mode makes Vim go to Insert mode.
4141 - CTRL-L in Insert mode is a command, it is not inserted.
4142 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4143 However, when <Esc> is used inside a mapping, it behaves like
4144 'insertmode' was not set. This was done to be able to use the same
4145 mappings with 'insertmode' set or not set.
4146 When executing commands with |:normal| 'insertmode' is not used.
4147
4148 NOTE: This option is reset when 'compatible' is set.
4149
4150 *'isfname'* *'isf'*
4151'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4152 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4153 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4154 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4155 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4156 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4157 global
4158 {not in Vi}
4159 The characters specified by this option are included in file names and
4160 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004161 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 Multi-byte characters 256 and above are always included, only the
4163 characters up to 255 are specified with this option.
4164 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004165 Think twice before adding white space to this option. Although a
4166 space may appear inside a file name, the effect will be that Vim
4167 doesn't know where a file name starts or ends when doing completion.
4168 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169
4170 Note that on systems using a backslash as path separator, Vim tries to
4171 do its best to make it work as you would expect. That is a bit
4172 tricky, since Vi originally used the backslash to escape special
4173 characters. Vim will not remove a backslash in front of a normal file
4174 name character on these systems, but it will on Unix and alikes. The
4175 '&' and '^' are not included by default, because these are special for
4176 cmd.exe.
4177
4178 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004179 Each part can be a single character number or a range. A range is two
4180 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004181 decimal number between 0 and 255 or the ASCII character itself (does
4182 not work for digits). Example:
4183 "_,-,128-140,#-43" (include '_' and '-' and the range
4184 128 to 140 and '#' to 43)
4185 If a part starts with '^', the following character number or range
4186 will be excluded from the option. The option is interpreted from left
4187 to right. Put the excluded character after the range where it is
4188 included. To include '^' itself use it as the last character of the
4189 option or the end of a range. Example:
4190 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4191 If the character is '@', all characters where isalpha() returns TRUE
4192 are included. Normally these are the characters a to z and A to Z,
4193 plus accented characters. To include '@' itself use "@-@". Examples:
4194 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004195 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 "a-z,A-Z,@-@" All letters plus the '@' character.
4197 A comma can be included by using it where a character number is
4198 expected. Example:
4199 "48-57,,,_" Digits, comma and underscore.
4200 A comma can be excluded by prepending a '^'. Example:
4201 " -~,^,,9" All characters from space to '~', excluding
4202 comma, plus <Tab>.
4203 See |option-backslash| about including spaces and backslashes.
4204
4205 *'isident'* *'isi'*
4206'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4207 "@,48-57,_,128-167,224-235"
4208 otherwise: "@,48-57,_,192-255")
4209 global
4210 {not in Vi}
4211 The characters given by this option are included in identifiers.
4212 Identifiers are used in recognizing environment variables and after a
4213 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004214 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 option.
4216 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004217 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4219
4220 *'iskeyword'* *'isk'*
4221'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4222 "@,48-57,_,128-167,224-235"
4223 otherwise: "@,48-57,_,192-255"
4224 Vi default: "@,48-57,_")
4225 local to buffer
4226 {not in Vi}
4227 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004228 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004229 'isfname' for a description of the format of this option. For C
4230 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4231 For a help file it is set to all non-blank printable characters except
4232 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4233 command).
4234 When the 'lisp' option is on the '-' character is always included.
4235 NOTE: This option is set to the Vi default value when 'compatible' is
4236 set and to the Vim default value when 'compatible' is reset.
4237
4238 *'isprint'* *'isp'*
4239'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4240 "@,~-255"; otherwise: "@,161-255")
4241 global
4242 {not in Vi}
4243 The characters given by this option are displayed directly on the
4244 screen. It is also used for "\p" in a |pattern|. The characters from
4245 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4246 even when they are not included in 'isprint' or excluded. See
4247 'isfname' for a description of the format of this option.
4248
4249 Non-printable characters are displayed with two characters:
4250 0 - 31 "^@" - "^_"
4251 32 - 126 always single characters
4252 127 "^?"
4253 128 - 159 "~@" - "~_"
4254 160 - 254 "| " - "|~"
4255 255 "~?"
4256 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4257 displayed as <xx>, with the hexadecimal value of the byte.
4258 When 'display' contains "uhex" all unprintable characters are
4259 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004260 The SpecialKey highlighting will be used for unprintable characters.
4261 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004262
4263 Multi-byte characters 256 and above are always included, only the
4264 characters up to 255 are specified with this option. When a character
4265 is printable but it is not available in the current font, a
4266 replacement character will be shown.
4267 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4268 There is no option to specify these characters.
4269
4270 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4271'joinspaces' 'js' boolean (default on)
4272 global
4273 {not in Vi}
4274 Insert two spaces after a '.', '?' and '!' with a join command.
4275 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4276 Otherwise only one space is inserted.
4277 NOTE: This option is set when 'compatible' is set.
4278
4279 *'key'*
4280'key' string (default "")
4281 local to buffer
4282 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004283 {only available when compiled with the |+cryptv|
4284 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004285 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004286 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 Careful: Do not set the key value by hand, someone might see the typed
4288 key. Use the |:X| command. But you can make 'key' empty: >
4289 :set key=
4290< It is not possible to get the value of this option with ":set key" or
4291 "echo &key". This is to avoid showing it to someone who shouldn't
4292 know. It also means you cannot see it yourself once you have set it,
4293 be careful not to make a typing error!
4294
4295 *'keymap'* *'kmp'* *E544*
4296'keymap' 'kmp' string (default "")
4297 local to buffer
4298 {not in Vi}
4299 {only available when compiled with the |+keymap|
4300 feature}
4301 Name of a keyboard mapping. See |mbyte-keymap|.
4302 Setting this option to a valid keymap name has the side effect of
4303 setting 'iminsert' to one, so that the keymap becomes effective.
4304 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004305 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306
4307 *'keymodel'* *'km'*
4308'keymodel' 'km' string (default "")
4309 global
4310 {not in Vi}
4311 List of comma separated words, which enable special things that keys
4312 can do. These values can be used:
4313 startsel Using a shifted special key starts selection (either
4314 Select mode or Visual mode, depending on "key" being
4315 present in 'selectmode').
4316 stopsel Using a not-shifted special key stops selection.
4317 Special keys in this context are the cursor keys, <End>, <Home>,
4318 <PageUp> and <PageDown>.
4319 The 'keymodel' option is set by the |:behave| command.
4320
4321 *'keywordprg'* *'kp'*
4322'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4323 OS/2: "view /", VMS: "help")
4324 global or local to buffer |global-local|
4325 {not in Vi}
4326 Program to use for the |K| command. Environment variables are
4327 expanded |:set_env|. ":help" may be used to access the Vim internal
4328 help. (Note that previously setting the global option to the empty
4329 value did this, which is now deprecated.)
4330 When "man" is used, Vim will automatically translate a count for the
4331 "K" command to a section number. Also for "man -s", in which case the
4332 "-s" is removed when there is no count.
4333 See |option-backslash| about including spaces and backslashes.
4334 Example: >
4335 :set keywordprg=man\ -s
4336< This option cannot be set from a |modeline| or in the |sandbox|, for
4337 security reasons.
4338
4339 *'langmap'* *'lmap'* *E357* *E358*
4340'langmap' 'lmap' string (default "")
4341 global
4342 {not in Vi}
4343 {only available when compiled with the |+langmap|
4344 feature}
4345 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004346 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004347 inserted directly. When in command mode the 'langmap' option takes
4348 care of translating these special characters to the original meaning
4349 of the key. This means you don't have to change the keyboard mode to
4350 be able to execute Normal mode commands.
4351 This is the opposite of the 'keymap' option, where characters are
4352 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004354 Example (for Greek, in UTF-8): *greek* >
4355 :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 +00004356< Example (exchanges meaning of z and y for commands): >
4357 :set langmap=zy,yz,ZY,YZ
4358<
4359 The 'langmap' option is a list of parts, separated with commas. Each
4360 part can be in one of two forms:
4361 1. A list of pairs. Each pair is a "from" character immediately
4362 followed by the "to" character. Examples: "aA", "aAbBcC".
4363 2. A list of "from" characters, a semi-colon and a list of "to"
4364 characters. Example: "abc;ABC"
4365 Example: "aA,fgh;FGH,cCdDeE"
4366 Special characters need to be preceded with a backslash. These are
4367 ";", ',' and backslash itself.
4368
4369 This will allow you to activate vim actions without having to switch
4370 back and forth between the languages. Your language characters will
4371 be understood as normal vim English characters (according to the
4372 langmap mappings) in the following cases:
4373 o Normal/Visual mode (commands, buffer/register names, user mappings)
4374 o Insert/Replace Mode: Register names after CTRL-R
4375 o Insert/Replace Mode: Mappings
4376 Characters entered in Command-line mode will NOT be affected by
4377 this option. Note that this option can be changed at any time
4378 allowing to switch between mappings for different languages/encodings.
4379 Use a mapping to avoid having to type it each time!
4380
4381 *'langmenu'* *'lm'*
4382'langmenu' 'lm' string (default "")
4383 global
4384 {not in Vi}
4385 {only available when compiled with the |+menu| and
4386 |+multi_lang| features}
4387 Language to use for menu translation. Tells which file is loaded
4388 from the "lang" directory in 'runtimepath': >
4389 "lang/menu_" . &langmenu . ".vim"
4390< (without the spaces). For example, to always use the Dutch menus, no
4391 matter what $LANG is set to: >
4392 :set langmenu=nl_NL.ISO_8859-1
4393< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004394 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 If your $LANG is set to a non-English language but you do want to use
4396 the English menus: >
4397 :set langmenu=none
4398< This option must be set before loading menus, switching on filetype
4399 detection or syntax highlighting. Once the menus are defined setting
4400 this option has no effect. But you could do this: >
4401 :source $VIMRUNTIME/delmenu.vim
4402 :set langmenu=de_DE.ISO_8859-1
4403 :source $VIMRUNTIME/menu.vim
4404< Warning: This deletes all menus that you defined yourself!
4405
4406 *'laststatus'* *'ls'*
4407'laststatus' 'ls' number (default 1)
4408 global
4409 {not in Vi}
4410 The value of this option influences when the last window will have a
4411 status line:
4412 0: never
4413 1: only if there are at least two windows
4414 2: always
4415 The screen looks nicer with a status line if you have several
4416 windows, but it takes another screen line. |status-line|
4417
4418 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4419'lazyredraw' 'lz' boolean (default off)
4420 global
4421 {not in Vi}
4422 When this option is set, the screen will not be redrawn while
4423 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004424 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 update use |:redraw|.
4426
4427 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4428'linebreak' 'lbr' boolean (default off)
4429 local to window
4430 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004431 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004432 feature}
4433 If on Vim will wrap long lines at a character in 'breakat' rather
4434 than at the last character that fits on the screen. Unlike
4435 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4436 it only affects the way the file is displayed, not its contents. The
4437 value of 'showbreak' is used to put in front of wrapped lines.
4438 This option is not used when the 'wrap' option is off or 'list' is on.
4439 Note that <Tab> characters after an <EOL> are mostly not displayed
4440 with the right amount of white space.
4441
4442 *'lines'* *E593*
4443'lines' number (default 24 or terminal height)
4444 global
4445 Number of lines of the Vim window.
4446 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004447 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004448 When Vim is running in the GUI or in a resizable window, setting this
4449 option will cause the window size to be changed. When you only want
4450 to use the size for the GUI, put the command in your |gvimrc| file.
4451 Vim limits the number of lines to what fits on the screen. You can
4452 use this command to get the tallest window possible: >
4453 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004454< Minimum value is 2, maximum value is 1000.
4455 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004456 When you set this option and Vim is unable to change the physical
4457 number of lines of the display, the display may be messed up.
4458
4459 *'linespace'* *'lsp'*
4460'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4461 global
4462 {not in Vi}
4463 {only in the GUI}
4464 Number of pixel lines inserted between characters. Useful if the font
4465 uses the full character cell height, making lines touch each other.
4466 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004467 With some fonts there can be too much room between lines (to have
4468 space for ascents and descents). Then it makes sense to set
4469 'linespace' to a negative value. This may cause display problems
4470 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471
4472 *'lisp'* *'nolisp'*
4473'lisp' boolean (default off)
4474 local to buffer
4475 {not available when compiled without the |+lispindent|
4476 feature}
4477 Lisp mode: When <Enter> is typed in insert mode set the indent for
4478 the next line to Lisp standards (well, sort of). Also happens with
4479 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4480 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4481 better. Also see 'lispwords'.
4482 The '-' character is included in keyword characters. Redefines the
4483 "=" operator to use this same indentation algorithm rather than
4484 calling an external program if 'equalprg' is empty.
4485 This option is not used when 'paste' is set.
4486 {Vi: Does it a little bit differently}
4487
4488 *'lispwords'* *'lw'*
4489'lispwords' 'lw' string (default is very long)
4490 global
4491 {not in Vi}
4492 {not available when compiled without the |+lispindent|
4493 feature}
4494 Comma separated list of words that influence the Lisp indenting.
4495 |'lisp'|
4496
4497 *'list'* *'nolist'*
4498'list' boolean (default off)
4499 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004500 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4501 line. Useful to see the difference between tabs and spaces and for
4502 trailing blanks. Further changed by the 'listchars' option.
4503
4504 The cursor is displayed at the start of the space a Tab character
4505 occupies, not at the end as usual in Normal mode. To get this cursor
4506 position while displaying Tabs with spaces, use: >
4507 :set list lcs=tab\ \
4508<
4509 Note that list mode will also affect formatting (set with 'textwidth'
4510 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004511 changing the way tabs are displayed.
4512
4513 *'listchars'* *'lcs'*
4514'listchars' 'lcs' string (default "eol:$")
4515 global
4516 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004517 Strings to use in 'list' mode and for the |:list| command. It is a
4518 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004519 eol:c Character to show at the end of each line. When
4520 omitted, there is no extra character at the end of the
4521 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004522 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004524 fill the space that the tab normally occupies.
4525 "tab:>-" will show a tab that takes four spaces as
4526 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004527 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 trailing spaces are blank.
4529 extends:c Character to show in the last column, when 'wrap' is
4530 off and the line continues beyond the right of the
4531 screen.
4532 precedes:c Character to show in the first column, when 'wrap'
4533 is off and there is text preceding the character
4534 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004535 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004536 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004537 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004538 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004539
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004540 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004541 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004542 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543
4544 Examples: >
4545 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004546 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 :set lcs=extends:>,precedes:<
4548< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004549 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004550 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551
4552 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4553'loadplugins' 'lpl' boolean (default on)
4554 global
4555 {not in Vi}
4556 When on the plugin scripts are loaded when starting up |load-plugins|.
4557 This option can be reset in your |vimrc| file to disable the loading
4558 of plugins.
4559 Note that using the "-u NONE" and "--noplugin" command line arguments
4560 reset this option. |-u| |--noplugin|
4561
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004562 *'macatsui'* *'nomacatsui'*
4563'macatsui' boolean (default on)
4564 global
4565 {only available in Mac GUI version}
4566 This is a workaround for when drawing doesn't work properly. When set
4567 and compiled with multi-byte support ATSUI text drawing is used. When
4568 not set ATSUI text drawing is not used. Switch this option off when
4569 you experience drawing problems. In a future version the problems may
4570 be solved and this option becomes obsolete. Therefore use this method
4571 to unset it: >
4572 if exists('&macatsui')
4573 set nomacatsui
4574 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004575< Another option to check if you have drawing problems is
4576 'termencoding'.
4577
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 *'magic'* *'nomagic'*
4579'magic' boolean (default on)
4580 global
4581 Changes the special characters that can be used in search patterns.
4582 See |pattern|.
4583 NOTE: To avoid portability problems with using patterns, always keep
4584 this option at the default "on". Only switch it off when working with
4585 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004586 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587
4588 *'makeef'* *'mef'*
4589'makeef' 'mef' string (default: "")
4590 global
4591 {not in Vi}
4592 {not available when compiled without the |+quickfix|
4593 feature}
4594 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4595 and the |:grep| command.
4596 When it is empty, an internally generated temp file will be used.
4597 When "##" is included, it is replaced by a number to make the name
4598 unique. This makes sure that the ":make" command doesn't overwrite an
4599 existing file.
4600 NOT used for the ":cf" command. See 'errorfile' for that.
4601 Environment variables are expanded |:set_env|.
4602 See |option-backslash| about including spaces and backslashes.
4603 This option cannot be set from a |modeline| or in the |sandbox|, for
4604 security reasons.
4605
4606 *'makeprg'* *'mp'*
4607'makeprg' 'mp' string (default "make", VMS: "MMS")
4608 global or local to buffer |global-local|
4609 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004610 Program to use for the ":make" command. See |:make_makeprg|.
4611 This option may contain '%' and '#' characters, which are expanded to
4612 the current and alternate file name. |:_%| |:_#|
4613 Environment variables are expanded |:set_env|. See |option-backslash|
4614 about including spaces and backslashes.
4615 Note that a '|' must be escaped twice: once for ":set" and once for
4616 the interpretation of a command. When you use a filter called
4617 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004618 :set makeprg=gmake\ \\\|\ myfilter
4619< The placeholder "$*" can be given (even multiple times) to specify
4620 where the arguments will be included, for example: >
4621 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4622< This option cannot be set from a |modeline| or in the |sandbox|, for
4623 security reasons.
4624
4625 *'matchpairs'* *'mps'*
4626'matchpairs' 'mps' string (default "(:),{:},[:]")
4627 local to buffer
4628 {not in Vi}
4629 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004630 other. Currently only single byte character pairs are allowed, and
4631 they must be different. The characters must be separated by a colon.
4632 The pairs must be separated by a comma. Example for including '<' and
4633 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 :set mps+=<:>
4635
4636< A more exotic example, to jump between the '=' and ';' in an
4637 assignment, useful for languages like C and Java: >
4638 :au FileType c,cpp,java set mps+==:;
4639
4640< For a more advanced way of using "%", see the matchit.vim plugin in
4641 the $VIMRUNTIME/macros directory. |add-local-help|
4642
4643 *'matchtime'* *'mat'*
4644'matchtime' 'mat' number (default 5)
4645 global
4646 {not in Vi}{in Nvi}
4647 Tenths of a second to show the matching paren, when 'showmatch' is
4648 set. Note that this is not in milliseconds, like other options that
4649 set a time. This is to be compatible with Nvi.
4650
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004651 *'maxcombine'* *'mco'*
4652'maxcombine' 'mco' number (default 2)
4653 global
4654 {not in Vi}
4655 {only available when compiled with the |+multi_byte|
4656 feature}
4657 The maximum number of combining characters supported for displaying.
4658 Only used when 'encoding' is "utf-8".
4659 The default is OK for most languages. Hebrew may require 4.
4660 Maximum value is 6.
4661 Even when this option is set to 2 you can still edit text with more
4662 combining characters, you just can't see them. Use |g8| or |ga|.
4663 See |mbyte-combining|.
4664
Bram Moolenaar071d4272004-06-13 20:20:40 +00004665 *'maxfuncdepth'* *'mfd'*
4666'maxfuncdepth' 'mfd' number (default 100)
4667 global
4668 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004669 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004670 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004671 Maximum depth of function calls for user functions. This normally
4672 catches endless recursion. When using a recursive function with
4673 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4674 more memory, there is the danger of failing when memory is exhausted.
4675 See also |:function|.
4676
4677 *'maxmapdepth'* *'mmd'* *E223*
4678'maxmapdepth' 'mmd' number (default 1000)
4679 global
4680 {not in Vi}
4681 Maximum number of times a mapping is done without resulting in a
4682 character to be used. This normally catches endless mappings, like
4683 ":map x y" with ":map y x". It still does not catch ":map g wg",
4684 because the 'w' is used before the next mapping is done. See also
4685 |key-mapping|.
4686
4687 *'maxmem'* *'mm'*
4688'maxmem' 'mm' number (default between 256 to 5120 (system
4689 dependent) or half the amount of memory
4690 available)
4691 global
4692 {not in Vi}
4693 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4694 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004695 other memory to be freed. The maximum usable value is about 2000000.
4696 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004697
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004698 *'maxmempattern'* *'mmp'*
4699'maxmempattern' 'mmp' number (default 1000)
4700 global
4701 {not in Vi}
4702 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004703 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004704 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004705 When Vim runs into the limit it gives an error message and mostly
4706 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004707 Running into the limit often means that the pattern is very
4708 inefficient or too complex. This may already happen with the pattern
4709 "\(.\)*" on a very long line. ".*" works much better.
4710 Vim may run out of memory before hitting the 'maxmempattern' limit.
4711
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 *'maxmemtot'* *'mmt'*
4713'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4714 dependent) or half the amount of memory
4715 available)
4716 global
4717 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004718 Maximum amount of memory in Kbyte to use for all buffers together.
4719 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4720 without a limit. On 64 bit machines higher values might work. But
4721 hey, do you really need more than 2 Gbyte for text editing?
4722 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723
4724 *'menuitems'* *'mis'*
4725'menuitems' 'mis' number (default 25)
4726 global
4727 {not in Vi}
4728 {not available when compiled without the |+menu|
4729 feature}
4730 Maximum number of items to use in a menu. Used for menus that are
4731 generated from a list of items, e.g., the Buffers menu. Changing this
4732 option has no direct effect, the menu must be refreshed first.
4733
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004734 *'mkspellmem'* *'msm'*
4735'mkspellmem' 'msm' string (default "460000,2000,500")
4736 global
4737 {not in Vi}
4738 {not available when compiled without the |+syntax|
4739 feature}
4740 Parameters for |:mkspell|. This tunes when to start compressing the
4741 word tree. Compression can be slow when there are many words, but
4742 it's needed to avoid running out of memory. The amount of memory used
4743 per word depends very much on how similar the words are, that's why
4744 this tuning is complicated.
4745
4746 There are three numbers, separated by commas:
4747 {start},{inc},{added}
4748
4749 For most languages the uncompressed word tree fits in memory. {start}
4750 gives the amount of memory in Kbyte that can be used before any
4751 compression is done. It should be a bit smaller than the amount of
4752 memory that is available to Vim.
4753
4754 When going over the {start} limit the {inc} number specifies the
4755 amount of memory in Kbyte that can be allocated before another
4756 compression is done. A low number means compression is done after
4757 less words are added, which is slow. A high number means more memory
4758 will be allocated.
4759
4760 After doing compression, {added} times 1024 words can be added before
4761 the {inc} limit is ignored and compression is done when any extra
4762 amount of memory is needed. A low number means there is a smaller
4763 chance of hitting the {inc} limit, less memory is used but it's
4764 slower.
4765
4766 The languages for which these numbers are important are Italian and
4767 Hungarian. The default works for when you have about 512 Mbyte. If
4768 you have 1 Gbyte you could use: >
4769 :set mkspellmem=900000,3000,800
4770< If you have less than 512 Mbyte |:mkspell| may fail for some
4771 languages, no matter what you set 'mkspellmem' to.
4772
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004774'modeline' 'ml' boolean (Vim default: on (off for root),
4775 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004776 local to buffer
4777 *'modelines'* *'mls'*
4778'modelines' 'mls' number (default 5)
4779 global
4780 {not in Vi}
4781 If 'modeline' is on 'modelines' gives the number of lines that is
4782 checked for set commands. If 'modeline' is off or 'modelines' is zero
4783 no lines are checked. See |modeline|.
4784 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4785 set and to the Vim default value when 'compatible' is reset.
4786
4787 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4788'modifiable' 'ma' boolean (default on)
4789 local to buffer
4790 {not in Vi} *E21*
4791 When off the buffer contents cannot be changed. The 'fileformat' and
4792 'fileencoding' options also can't be changed.
4793 Can be reset with the |-M| command line argument.
4794
4795 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4796'modified' 'mod' boolean (default off)
4797 local to buffer
4798 {not in Vi}
4799 When on, the buffer is considered to be modified. This option is set
4800 when:
4801 1. A change was made to the text since it was last written. Using the
4802 |undo| command to go back to the original text will reset the
4803 option. But undoing changes that were made before writing the
4804 buffer will set the option again, since the text is different from
4805 when it was written.
4806 2. 'fileformat' or 'fileencoding' is different from its original
4807 value. The original value is set when the buffer is read or
4808 written. A ":set nomodified" command also resets the original
4809 values to the current values and the 'modified' option will be
4810 reset.
4811 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4812 will be ignored.
4813
4814 *'more'* *'nomore'*
4815'more' boolean (Vim default: on, Vi default: off)
4816 global
4817 {not in Vi}
4818 When on, listings pause when the whole screen is filled. You will get
4819 the |more-prompt|. When this option is off there are no pauses, the
4820 listing continues until finished.
4821 NOTE: This option is set to the Vi default value when 'compatible' is
4822 set and to the Vim default value when 'compatible' is reset.
4823
4824 *'mouse'* *E538*
4825'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4826 global
4827 {not in Vi}
4828 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004829 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4830 sysmouse and Linux console with gpm). For using the mouse in the
4831 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004832 The mouse can be enabled for different modes:
4833 n Normal mode
4834 v Visual mode
4835 i Insert mode
4836 c Command-line mode
4837 h all previous modes when editing a help file
4838 a all previous modes
4839 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004840 Normally you would enable the mouse in all four modes with: >
4841 :set mouse=a
4842< When the mouse is not enabled, the GUI will still use the mouse for
4843 modeless selection. This doesn't move the text cursor.
4844
4845 See |mouse-using|. Also see |'clipboard'|.
4846
4847 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004848 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004849 the mouse buttons can still be used by keeping the shift key pressed.
4850 Also see the 'clipboard' option.
4851
4852 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4853'mousefocus' 'mousef' boolean (default off)
4854 global
4855 {not in Vi}
4856 {only works in the GUI}
4857 The window that the mouse pointer is on is automatically activated.
4858 When changing the window layout or window focus in another way, the
4859 mouse pointer is moved to the window with keyboard focus. Off is the
4860 default because it makes using the pull down menus a little goofy, as
4861 a pointer transit may activate a window unintentionally.
4862
4863 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4864'mousehide' 'mh' boolean (default on)
4865 global
4866 {not in Vi}
4867 {only works in the GUI}
4868 When on, the mouse pointer is hidden when characters are typed.
4869 The mouse pointer is restored when the mouse is moved.
4870
4871 *'mousemodel'* *'mousem'*
4872'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4873 global
4874 {not in Vi}
4875 Sets the model to use for the mouse. The name mostly specifies what
4876 the right mouse button is used for:
4877 extend Right mouse button extends a selection. This works
4878 like in an xterm.
4879 popup Right mouse button pops up a menu. The shifted left
4880 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004881 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 popup_setpos Like "popup", but the cursor will be moved to the
4883 position where the mouse was clicked, and thus the
4884 selected operation will act upon the clicked object.
4885 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004886 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004887 course, that right clicking outside a selection will
4888 end Visual mode.
4889 Overview of what button does what for each model:
4890 mouse extend popup(_setpos) ~
4891 left click place cursor place cursor
4892 left drag start selection start selection
4893 shift-left search word extend selection
4894 right click extend selection popup menu (place cursor)
4895 right drag extend selection -
4896 middle click paste paste
4897
4898 In the "popup" model the right mouse button produces a pop-up menu.
4899 You need to define this first, see |popup-menu|.
4900
4901 Note that you can further refine the meaning of buttons with mappings.
4902 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4903 selection (because that's handled in the GUI code directly).
4904
4905 The 'mousemodel' option is set by the |:behave| command.
4906
4907 *'mouseshape'* *'mouses'* *E547*
4908'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004909 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004910 global
4911 {not in Vi}
4912 {only available when compiled with the |+mouseshape|
4913 feature}
4914 This option tells Vim what the mouse pointer should look like in
4915 different modes. The option is a comma separated list of parts, much
4916 like used for 'guicursor'. Each part consist of a mode/location-list
4917 and an argument-list:
4918 mode-list:shape,mode-list:shape,..
4919 The mode-list is a dash separated list of these modes/locations:
4920 In a normal window: ~
4921 n Normal mode
4922 v Visual mode
4923 ve Visual mode with 'selection' "exclusive" (same as 'v',
4924 if not specified)
4925 o Operator-pending mode
4926 i Insert mode
4927 r Replace mode
4928
4929 Others: ~
4930 c appending to the command-line
4931 ci inserting in the command-line
4932 cr replacing in the command-line
4933 m at the 'Hit ENTER' or 'More' prompts
4934 ml idem, but cursor in the last line
4935 e any mode, pointer below last window
4936 s any mode, pointer on a status line
4937 sd any mode, while dragging a status line
4938 vs any mode, pointer on a vertical separator line
4939 vd any mode, while dragging a vertical separator line
4940 a everywhere
4941
4942 The shape is one of the following:
4943 avail name looks like ~
4944 w x arrow Normal mouse pointer
4945 w x blank no pointer at all (use with care!)
4946 w x beam I-beam
4947 w x updown up-down sizing arrows
4948 w x leftright left-right sizing arrows
4949 w x busy The system's usual busy pointer
4950 w x no The system's usual 'no input' pointer
4951 x udsizing indicates up-down resizing
4952 x lrsizing indicates left-right resizing
4953 x crosshair like a big thin +
4954 x hand1 black hand
4955 x hand2 white hand
4956 x pencil what you write with
4957 x question big ?
4958 x rightup-arrow arrow pointing right-up
4959 w x up-arrow arrow pointing up
4960 x <number> any X11 pointer number (see X11/cursorfont.h)
4961
4962 The "avail" column contains a 'w' if the shape is available for Win32,
4963 x for X11.
4964 Any modes not specified or shapes not available use the normal mouse
4965 pointer.
4966
4967 Example: >
4968 :set mouseshape=s:udsizing,m:no
4969< will make the mouse turn to a sizing arrow over the status lines and
4970 indicate no input when the hit-enter prompt is displayed (since
4971 clicking the mouse has no effect in this state.)
4972
4973 *'mousetime'* *'mouset'*
4974'mousetime' 'mouset' number (default 500)
4975 global
4976 {not in Vi}
4977 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4978 time in msec between two mouse clicks for the second click to be
4979 recognized as a multi click.
4980
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004981 *'mzquantum'* *'mzq'*
4982'mzquantum' 'mzq' number (default 100)
4983 global
4984 {not in Vi}
4985 {not available when compiled without the |+mzscheme|
4986 feature}
4987 The number of milliseconds between polls for MzScheme threads.
4988 Negative or zero value means no thread scheduling.
4989
Bram Moolenaar071d4272004-06-13 20:20:40 +00004990 *'nrformats'* *'nf'*
4991'nrformats' 'nf' string (default "octal,hex")
4992 local to buffer
4993 {not in Vi}
4994 This defines what bases Vim will consider for numbers when using the
4995 CTRL-A and CTRL-X commands for adding to and subtracting from a number
4996 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00004997 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00004998 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02004999 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005000 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005001 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005002 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 considered to be hexadecimal. Example: Using CTRL-X on
5004 "0x100" results in "0x0ff".
5005 Numbers which simply begin with a digit in the range 1-9 are always
5006 considered decimal. This also happens for numbers that are not
5007 recognized as octal or hex.
5008
5009 *'number'* *'nu'* *'nonumber'* *'nonu'*
5010'number' 'nu' boolean (default off)
5011 local to window
5012 Print the line number in front of each line. When the 'n' option is
5013 excluded from 'cpoptions' a wrapped line will not use the column of
5014 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005015 The 'numberwidth' option can be used to set the room used for the line
5016 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005017 When a long, wrapped line doesn't start with the first character, '-'
5018 characters are put before the number.
5019 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005020 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005021
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005022 *'numberwidth'* *'nuw'*
5023'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5024 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005025 {not in Vi}
5026 {only available when compiled with the |+linebreak|
5027 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005028 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005029 when the 'number' or 'relativenumber' option is set or printing lines
5030 with a line number. Since one space is always between the number and
5031 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005032 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005033 fit the highest line number in the buffer respectively the number of
5034 rows in the window, depending on whether 'number' or 'relativenumber'
5035 is set. Thus with the Vim default of 4 there is room for a line number
5036 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005037 The minimum value is 1, the maximum value is 10.
5038 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5039
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005040 *'omnifunc'* *'ofu'*
5041'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005042 local to buffer
5043 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005044 {not available when compiled without the |+eval|
5045 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005046 This option specifies a function to be used for Insert mode omni
5047 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005048 See |complete-functions| for an explanation of how the function is
5049 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005050 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005051 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005052
5053
Bram Moolenaar02467872007-05-06 13:22:01 +00005054 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005055'opendevice' 'odev' boolean (default off)
5056 global
5057 {not in Vi}
5058 {only for MS-DOS, MS-Windows and OS/2}
5059 Enable reading and writing from devices. This may get Vim stuck on a
5060 device that can be opened but doesn't actually do the I/O. Therefore
5061 it is off by default.
5062 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5063 result in editing a device.
5064
5065
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005066 *'operatorfunc'* *'opfunc'*
5067'operatorfunc' 'opfunc' string (default: empty)
5068 global
5069 {not in Vi}
5070 This option specifies a function to be called by the |g@| operator.
5071 See |:map-operator| for more info and an example.
5072
5073 This option cannot be set from a |modeline| or in the |sandbox|, for
5074 security reasons.
5075
5076
Bram Moolenaar071d4272004-06-13 20:20:40 +00005077 *'osfiletype'* *'oft'* *E366*
5078'osfiletype' 'oft' string (RISC-OS default: "Text",
5079 others default: "")
5080 local to buffer
5081 {not in Vi}
5082 {only available when compiled with the |+osfiletype|
5083 feature}
5084 Some operating systems store extra information about files besides
5085 name, datestamp and permissions. This option contains the extra
5086 information, the nature of which will vary between systems.
5087 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005088 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089 It can affect the pattern matching of the automatic commands.
5090 |autocmd-osfiletypes|
5091
5092 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005093'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005094 global
5095 Specifies the nroff macros that separate paragraphs. These are pairs
5096 of two letters (see |object-motions|).
5097
5098 *'paste'* *'nopaste'*
5099'paste' boolean (default off)
5100 global
5101 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005102 Put Vim in Paste mode. This is useful if you want to cut or copy
5103 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 unexpected effects.
5105 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005106 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005107 knows about pasting and will mostly do the right thing without 'paste'
5108 being set. The same is true for a terminal where Vim handles the
5109 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005110 This option is reset when starting the GUI. Thus if you set it in
5111 your .vimrc it will work in a terminal, but not in the GUI. Setting
5112 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5113 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005114 When the 'paste' option is switched on (also when it was already on):
5115 - mapping in Insert mode and Command-line mode is disabled
5116 - abbreviations are disabled
5117 - 'textwidth' is set to 0
5118 - 'wrapmargin' is set to 0
5119 - 'autoindent' is reset
5120 - 'smartindent' is reset
5121 - 'softtabstop' is set to 0
5122 - 'revins' is reset
5123 - 'ruler' is reset
5124 - 'showmatch' is reset
5125 - 'formatoptions' is used like it is empty
5126 These options keep their value, but their effect is disabled:
5127 - 'lisp'
5128 - 'indentexpr'
5129 - 'cindent'
5130 NOTE: When you start editing another file while the 'paste' option is
5131 on, settings from the modelines or autocommands may change the
5132 settings again, causing trouble when pasting text. You might want to
5133 set the 'paste' option again.
5134 When the 'paste' option is reset the mentioned options are restored to
5135 the value before the moment 'paste' was switched from off to on.
5136 Resetting 'paste' before ever setting it does not have any effect.
5137 Since mapping doesn't work while 'paste' is active, you need to use
5138 the 'pastetoggle' option to toggle the 'paste' option with some key.
5139
5140 *'pastetoggle'* *'pt'*
5141'pastetoggle' 'pt' string (default "")
5142 global
5143 {not in Vi}
5144 When non-empty, specifies the key sequence that toggles the 'paste'
5145 option. This is like specifying a mapping: >
5146 :map {keys} :set invpaste<CR>
5147< Where {keys} is the value of 'pastetoggle'.
5148 The difference is that it will work even when 'paste' is set.
5149 'pastetoggle' works in Insert mode and Normal mode, but not in
5150 Command-line mode.
5151 Mappings are checked first, thus overrule 'pastetoggle'. However,
5152 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5153 this: >
5154 :map <F10> :set paste<CR>
5155 :map <F11> :set nopaste<CR>
5156 :imap <F10> <C-O>:set paste<CR>
5157 :imap <F11> <nop>
5158 :set pastetoggle=<F11>
5159< This will make <F10> start paste mode and <F11> stop paste mode.
5160 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5161 mode everything is inserted literally, except the 'pastetoggle' key
5162 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005163 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005164
5165 *'pex'* *'patchexpr'*
5166'patchexpr' 'pex' string (default "")
5167 global
5168 {not in Vi}
5169 {not available when compiled without the |+diff|
5170 feature}
5171 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005172 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005173
5174 *'patchmode'* *'pm'* *E206*
5175'patchmode' 'pm' string (default "")
5176 global
5177 {not in Vi}
5178 When non-empty the oldest version of a file is kept. This can be used
5179 to keep the original version of a file if you are changing files in a
5180 source distribution. Only the first time that a file is written a
5181 copy of the original file will be kept. The name of the copy is the
5182 name of the original file with the string in the 'patchmode' option
5183 appended. This option should start with a dot. Use a string like
5184 ".org". 'backupdir' must not be empty for this to work (Detail: The
5185 backup file is renamed to the patchmode file after the new file has
5186 been successfully written, that's why it must be possible to write a
5187 backup file). If there was no file to be backed up, an empty file is
5188 created.
5189 When the 'backupskip' pattern matches, a patchmode file is not made.
5190 Using 'patchmode' for compressed files appends the extension at the
5191 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5192 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005193 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005194
5195 *'path'* *'pa'* *E343* *E345* *E347*
5196'path' 'pa' string (default on Unix: ".,/usr/include,,"
5197 on OS/2: ".,/emx/include,,"
5198 other systems: ".,,")
5199 global or local to buffer |global-local|
5200 {not in Vi}
5201 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005202 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5203 provided that the file being searched for has a relative path (not
5204 starting with "/", "./" or "../"). The directories in the 'path'
5205 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005206 - Use commas to separate directory names: >
5207 :set path=.,/usr/local/include,/usr/include
5208< - Spaces can also be used to separate directory names (for backwards
5209 compatibility with version 3.0). To have a space in a directory
5210 name, precede it with an extra backslash, and escape the space: >
5211 :set path=.,/dir/with\\\ space
5212< - To include a comma in a directory name precede it with an extra
5213 backslash: >
5214 :set path=.,/dir/with\\,comma
5215< - To search relative to the directory of the current file, use: >
5216 :set path=.
5217< - To search in the current directory use an empty string between two
5218 commas: >
5219 :set path=,,
5220< - A directory name may end in a ':' or '/'.
5221 - Environment variables are expanded |:set_env|.
5222 - When using |netrw.vim| URLs can be used. For example, adding
5223 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005224 - Search upwards and downwards in a directory tree using "*", "**" and
5225 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005226 {not available when compiled without the |+path_extra| feature}
5227 - Careful with '\' characters, type two to get one in the option: >
5228 :set path=.,c:\\include
5229< Or just use '/' instead: >
5230 :set path=.,c:/include
5231< Don't forget "." or files won't even be found in the same directory as
5232 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005233 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005234 it is something like 256 or 1024 characters.
5235 You can check if all the include files are found, using the value of
5236 'path', see |:checkpath|.
5237 The use of |:set+=| and |:set-=| is preferred when adding or removing
5238 directories from the list. This avoids problems when a future version
5239 uses another default. To remove the current directory use: >
5240 :set path-=
5241< To add the current directory use: >
5242 :set path+=
5243< To use an environment variable, you probably need to replace the
5244 separator. Here is an example to append $INCL, in which directory
5245 names are separated with a semi-colon: >
5246 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5247< Replace the ';' with a ':' or whatever separator is used. Note that
5248 this doesn't work when $INCL contains a comma or white space.
5249
5250 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5251'preserveindent' 'pi' boolean (default off)
5252 local to buffer
5253 {not in Vi}
5254 When changing the indent of the current line, preserve as much of the
5255 indent structure as possible. Normally the indent is replaced by a
5256 series of tabs followed by spaces as required (unless |'expandtab'| is
5257 enabled, in which case only spaces are used). Enabling this option
5258 means the indent will preserve as many existing characters as possible
5259 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005260 'expandtab' does not apply to the preserved white space, a Tab remains
5261 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005262 NOTE: When using ">>" multiple times the resulting indent is a mix of
5263 tabs and spaces. You might not like this.
5264 NOTE: 'preserveindent' is reset when 'compatible' is set.
5265 Also see 'copyindent'.
5266 Use |:retab| to clean up white space.
5267
5268 *'previewheight'* *'pvh'*
5269'previewheight' 'pvh' number (default 12)
5270 global
5271 {not in Vi}
5272 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005273 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005274 Default height for a preview window. Used for |:ptag| and associated
5275 commands. Used for |CTRL-W_}| when no count is given.
5276
5277 *'previewwindow'* *'nopreviewwindow'*
5278 *'pvw'* *'nopvw'* *E590*
5279'previewwindow' 'pvw' boolean (default off)
5280 local to window
5281 {not in Vi}
5282 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005283 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005284 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005285 set. It's normally not set directly, but by using one of the commands
5286 |:ptag|, |:pedit|, etc.
5287
5288 *'printdevice'* *'pdev'*
5289'printdevice' 'pdev' string (default empty)
5290 global
5291 {not in Vi}
5292 {only available when compiled with the |+printer|
5293 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005294 The name of the printer to be used for |:hardcopy|.
5295 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005296 This option cannot be set from a |modeline| or in the |sandbox|, for
5297 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298
Bram Moolenaar8299df92004-07-10 09:47:34 +00005299 *'printencoding'* *'penc'*
5300'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 global
5302 {not in Vi}
5303 {only available when compiled with the |+printer|
5304 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005305 Sets the character encoding used when printing.
5306 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005307
5308 *'printexpr'* *'pexpr'*
5309'printexpr' 'pexpr' String (default: see below)
5310 global
5311 {not in Vi}
5312 {only available when compiled with the |+printer|
5313 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005314 Expression used to print the PostScript produced with |:hardcopy|.
5315 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316
Bram Moolenaar8299df92004-07-10 09:47:34 +00005317 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005318'printfont' 'pfn' string (default "courier")
5319 global
5320 {not in Vi}
5321 {only available when compiled with the |+printer|
5322 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005323 The name of the font that will be used for |:hardcopy|.
5324 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325
5326 *'printheader'* *'pheader'*
5327'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5328 global
5329 {not in Vi}
5330 {only available when compiled with the |+printer|
5331 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005332 The format of the header produced in |:hardcopy| output.
5333 See |pheader-option|.
5334
5335 *'printmbcharset'* *'pmbcs'*
5336'printmbcharset' 'pmbcs' string (default "")
5337 global
5338 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005339 {only available when compiled with the |+printer|,
5340 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005341 The CJK character set to be used for CJK output from |:hardcopy|.
5342 See |pmbcs-option|.
5343
5344 *'printmbfont'* *'pmbfn'*
5345'printmbfont' 'pmbfn' string (default "")
5346 global
5347 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005348 {only available when compiled with the |+printer|,
5349 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005350 List of font names to be used for CJK output from |:hardcopy|.
5351 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005352
5353 *'printoptions'* *'popt'*
5354'printoptions' 'popt' string (default "")
5355 global
5356 {not in Vi}
5357 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005358 List of items that control the format of the output of |:hardcopy|.
5359 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005360
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005361 *'prompt'* *'noprompt'*
5362'prompt' boolean (default on)
5363 global
5364 When on a ":" prompt is used in Ex mode.
5365
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005366 *'pumheight'* *'ph'*
5367'pumheight' 'ph' number (default 0)
5368 global
5369 {not available when compiled without the
5370 |+insert_expand| feature}
5371 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005372 Determines the maximum number of items to show in the popup menu for
5373 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005374 |ins-completion-menu|.
5375
5376
Bram Moolenaar677ee682005-01-27 14:41:15 +00005377 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005378'quoteescape' 'qe' string (default "\")
5379 local to buffer
5380 {not in Vi}
5381 The characters that are used to escape quotes in a string. Used for
5382 objects like a', a" and a` |a'|.
5383 When one of the characters in this option is found inside a string,
5384 the following character will be skipped. The default value makes the
5385 text "foo\"bar\\" considered to be one string.
5386
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5388'readonly' 'ro' boolean (default off)
5389 local to buffer
5390 If on, writes fail unless you use a '!'. Protects you from
5391 accidentally overwriting a file. Default on when Vim is started
5392 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005393 When using ":w!" the 'readonly' option is reset for the current
5394 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005395 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005396 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005397
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005398 *'redrawtime'* *'rdt'*
5399'redrawtime' 'rdt' number (default 2000)
5400 global
5401 {not in Vi}
5402 {only available when compiled with the |+reltime|
5403 feature}
5404 The time in milliseconds for redrawing the display. This applies to
5405 searching for patterns for 'hlsearch' and |:match| highlighting.
5406 When redrawing takes more than this many milliseconds no further
5407 matches will be highlighted. This is used to avoid that Vim hangs
5408 when using a very complicated pattern.
5409
Bram Moolenaar64486672010-05-16 15:46:46 +02005410 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5411'relativenumber' 'rnu' boolean (default off)
5412 local to window
5413 {not in Vi}
5414 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005415 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005416 precede some vertical motion commands (e.g. j k + -) with, without
5417 having to calculate it yourself. Especially useful in combination with
5418 other commands (e.g. y d c < > gq gw =).
5419 When the 'n' option is excluded from 'cpoptions' a wrapped
5420 line will not use the column of line numbers (this is the default when
5421 'compatible' isn't set).
5422 The 'numberwidth' option can be used to set the room used for the line
5423 number.
5424 When a long, wrapped line doesn't start with the first character, '-'
5425 characters are put before the number.
5426 See |hl-LineNr| for the highlighting used for the number.
5427 When setting this option, 'number' is reset.
5428
Bram Moolenaar071d4272004-06-13 20:20:40 +00005429 *'remap'* *'noremap'*
5430'remap' boolean (default on)
5431 global
5432 Allows for mappings to work recursively. If you do not want this for
5433 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005434 NOTE: To avoid portability problems with Vim scripts, always keep
5435 this option at the default "on". Only switch it off when working with
5436 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005437
5438 *'report'*
5439'report' number (default 2)
5440 global
5441 Threshold for reporting number of lines changed. When the number of
5442 changed lines is more than 'report' a message will be given for most
5443 ":" commands. If you want it always, set 'report' to 0.
5444 For the ":substitute" command the number of substitutions is used
5445 instead of the number of lines.
5446
5447 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5448'restorescreen' 'rs' boolean (default on)
5449 global
5450 {not in Vi} {only in Windows 95/NT console version}
5451 When set, the screen contents is restored when exiting Vim. This also
5452 happens when executing external commands.
5453
5454 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5455 options in your .vimrc. To disable restoring:
5456 set t_ti= t_te=
5457 To enable restoring (for an xterm):
5458 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5459 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5460
5461 *'revins'* *'ri'* *'norevins'* *'nori'*
5462'revins' 'ri' boolean (default off)
5463 global
5464 {not in Vi}
5465 {only available when compiled with the |+rightleft|
5466 feature}
5467 Inserting characters in Insert mode will work backwards. See "typing
5468 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5469 command in Insert mode, when 'allowrevins' is set.
5470 NOTE: This option is reset when 'compatible' or 'paste' is set.
5471
5472 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5473'rightleft' 'rl' boolean (default off)
5474 local to window
5475 {not in Vi}
5476 {only available when compiled with the |+rightleft|
5477 feature}
5478 When on, display orientation becomes right-to-left, i.e., characters
5479 that are stored in the file appear from the right to the left.
5480 Using this option, it is possible to edit files for languages that
5481 are written from the right to the left such as Hebrew and Arabic.
5482 This option is per window, so it is possible to edit mixed files
5483 simultaneously, or to view the same file in both ways (this is
5484 useful whenever you have a mixed text file with both right-to-left
5485 and left-to-right strings so that both sets are displayed properly
5486 in different windows). Also see |rileft.txt|.
5487
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005488 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005489'rightleftcmd' 'rlc' string (default "search")
5490 local to window
5491 {not in Vi}
5492 {only available when compiled with the |+rightleft|
5493 feature}
5494 Each word in this option enables the command line editing to work in
5495 right-to-left mode for a group of commands:
5496
5497 search "/" and "?" commands
5498
5499 This is useful for languages such as Hebrew, Arabic and Farsi.
5500 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5501
5502 *'ruler'* *'ru'* *'noruler'* *'noru'*
5503'ruler' 'ru' boolean (default off)
5504 global
5505 {not in Vi}
5506 {not available when compiled without the
5507 |+cmdline_info| feature}
5508 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005509 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510 text in the file is shown on the far right:
5511 Top first line is visible
5512 Bot last line is visible
5513 All first and last line are visible
5514 45% relative position in the file
5515 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005516 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005517 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005518 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 this option takes precedence over 'ruler' and 'rulerformat'
5520 If the number of characters displayed is different from the number of
5521 bytes in the text (e.g., for a TAB or a multi-byte character), both
5522 the text column (byte number) and the screen column are shown,
5523 separated with a dash.
5524 For an empty line "0-1" is shown.
5525 For an empty buffer the line number will also be zero: "0,0-1".
5526 This option is reset when the 'paste' option is set.
5527 If you don't want to see the ruler all the time but want to know where
5528 you are, use "g CTRL-G" |g_CTRL-G|.
5529 NOTE: This option is reset when 'compatible' is set.
5530
5531 *'rulerformat'* *'ruf'*
5532'rulerformat' 'ruf' string (default empty)
5533 global
5534 {not in Vi}
5535 {not available when compiled without the |+statusline|
5536 feature}
5537 When this option is not empty, it determines the content of the ruler
5538 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005539 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 The default ruler width is 17 characters. To make the ruler 15
5541 characters wide, put "%15(" at the start and "%)" at the end.
5542 Example: >
5543 :set rulerformat=%15(%c%V\ %p%%%)
5544<
5545 *'runtimepath'* *'rtp'* *vimfiles*
5546'runtimepath' 'rtp' string (default:
5547 Unix: "$HOME/.vim,
5548 $VIM/vimfiles,
5549 $VIMRUNTIME,
5550 $VIM/vimfiles/after,
5551 $HOME/.vim/after"
5552 Amiga: "home:vimfiles,
5553 $VIM/vimfiles,
5554 $VIMRUNTIME,
5555 $VIM/vimfiles/after,
5556 home:vimfiles/after"
5557 PC, OS/2: "$HOME/vimfiles,
5558 $VIM/vimfiles,
5559 $VIMRUNTIME,
5560 $VIM/vimfiles/after,
5561 $HOME/vimfiles/after"
5562 Macintosh: "$VIM:vimfiles,
5563 $VIMRUNTIME,
5564 $VIM:vimfiles:after"
5565 RISC-OS: "Choices:vimfiles,
5566 $VIMRUNTIME,
5567 Choices:vimfiles/after"
5568 VMS: "sys$login:vimfiles,
5569 $VIM/vimfiles,
5570 $VIMRUNTIME,
5571 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005572 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005573 global
5574 {not in Vi}
5575 This is a list of directories which will be searched for runtime
5576 files:
5577 filetype.vim filetypes by file name |new-filetype|
5578 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005579 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005580 colors/ color scheme files |:colorscheme|
5581 compiler/ compiler files |:compiler|
5582 doc/ documentation |write-local-help|
5583 ftplugin/ filetype plugins |write-filetype-plugin|
5584 indent/ indent scripts |indent-expression|
5585 keymap/ key mapping files |mbyte-keymap|
5586 lang/ menu translations |:menutrans|
5587 menu.vim GUI menus |menu.vim|
5588 plugin/ plugin scripts |write-plugin|
5589 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005590 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005591 syntax/ syntax files |mysyntaxfile|
5592 tutor/ files for vimtutor |tutor|
5593
5594 And any other file searched for with the |:runtime| command.
5595
5596 The defaults for most systems are setup to search five locations:
5597 1. In your home directory, for your personal preferences.
5598 2. In a system-wide Vim directory, for preferences from the system
5599 administrator.
5600 3. In $VIMRUNTIME, for files distributed with Vim.
5601 *after-directory*
5602 4. In the "after" directory in the system-wide Vim directory. This is
5603 for the system administrator to overrule or add to the distributed
5604 defaults (rarely needed)
5605 5. In the "after" directory in your home directory. This is for
5606 personal preferences to overrule or add to the distributed defaults
5607 or system-wide settings (rarely needed).
5608
5609 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5610 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005611 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005612 wildcards.
5613 See |:runtime|.
5614 Example: >
5615 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5616< This will use the directory "~/vimruntime" first (containing your
5617 personal Vim runtime files), then "/mygroup/vim" (shared between a
5618 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5619 files).
5620 You probably should always include $VIMRUNTIME somewhere, to use the
5621 distributed runtime files. You can put a directory before $VIMRUNTIME
5622 to find files which replace a distributed runtime files. You can put
5623 a directory after $VIMRUNTIME to find files which add to distributed
5624 runtime files.
5625 This option cannot be set from a |modeline| or in the |sandbox|, for
5626 security reasons.
5627
5628 *'scroll'* *'scr'*
5629'scroll' 'scr' number (default: half the window height)
5630 local to window
5631 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5632 set to half the number of lines in the window when the window size
5633 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005634 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005635 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5636 the number of screen lines instead of file lines, makes a difference
5637 when lines wrap}
5638
5639 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5640'scrollbind' 'scb' boolean (default off)
5641 local to window
5642 {not in Vi}
5643 {not available when compiled without the |+scrollbind|
5644 feature}
5645 See also |scroll-binding|. When this option is set, the current
5646 window scrolls as other scrollbind windows (windows that also have
5647 this option set) scroll. This option is useful for viewing the
5648 differences between two versions of a file, see 'diff'.
5649 See |'scrollopt'| for options that determine how this option should be
5650 interpreted.
5651 This option is mostly reset when splitting a window to edit another
5652 file. This means that ":split | edit file" results in two windows
5653 with scroll-binding, but ":split file" does not.
5654
5655 *'scrolljump'* *'sj'*
5656'scrolljump' 'sj' number (default 1)
5657 global
5658 {not in Vi}
5659 Minimal number of lines to scroll when the cursor gets off the
5660 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5661 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005662 When set to a negative number from -1 to -100 this is used as the
5663 percentage of the window height. Thus -50 scrolls half the window
5664 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 NOTE: This option is set to 1 when 'compatible' is set.
5666
5667 *'scrolloff'* *'so'*
5668'scrolloff' 'so' number (default 0)
5669 global
5670 {not in Vi}
5671 Minimal number of screen lines to keep above and below the cursor.
5672 This will make some context visible around where you are working. If
5673 you set it to a very large value (999) the cursor line will always be
5674 in the middle of the window (except at the start or end of the file or
5675 when long lines wrap).
5676 For scrolling horizontally see 'sidescrolloff'.
5677 NOTE: This option is set to 0 when 'compatible' is set.
5678
5679 *'scrollopt'* *'sbo'*
5680'scrollopt' 'sbo' string (default "ver,jump")
5681 global
5682 {not available when compiled without the |+scrollbind|
5683 feature}
5684 {not in Vi}
5685 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005686 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5687 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005688 The following words are available:
5689 ver Bind vertical scrolling for 'scrollbind' windows
5690 hor Bind horizontal scrolling for 'scrollbind' windows
5691 jump Applies to the offset between two windows for vertical
5692 scrolling. This offset is the difference in the first
5693 displayed line of the bound windows. When moving
5694 around in a window, another 'scrollbind' window may
5695 reach a position before the start or after the end of
5696 the buffer. The offset is not changed though, when
5697 moving back the 'scrollbind' window will try to scroll
5698 to the desired position when possible.
5699 When now making that window the current one, two
5700 things can be done with the relative offset:
5701 1. When "jump" is not included, the relative offset is
5702 adjusted for the scroll position in the new current
5703 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005704 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705 2. When "jump" is included, the other windows are
5706 scrolled to keep the same relative offset. When
5707 going back to the other window, it still uses the
5708 same relative offset.
5709 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005710 When 'diff' mode is active there always is vertical scroll binding,
5711 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712
5713 *'sections'* *'sect'*
5714'sections' 'sect' string (default "SHNHH HUnhsh")
5715 global
5716 Specifies the nroff macros that separate sections. These are pairs of
5717 two letters (See |object-motions|). The default makes a section start
5718 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5719
5720 *'secure'* *'nosecure'* *E523*
5721'secure' boolean (default off)
5722 global
5723 {not in Vi}
5724 When on, ":autocmd", shell and write commands are not allowed in
5725 ".vimrc" and ".exrc" in the current directory and map commands are
5726 displayed. Switch it off only if you know that you will not run into
5727 problems, or when the 'exrc' option is off. On Unix this option is
5728 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005729 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005730 'secure' at the end of your ~/.vimrc then.
5731 This option cannot be set from a |modeline| or in the |sandbox|, for
5732 security reasons.
5733
5734 *'selection'* *'sel'*
5735'selection' 'sel' string (default "inclusive")
5736 global
5737 {not in Vi}
5738 This option defines the behavior of the selection. It is only used
5739 in Visual and Select mode.
5740 Possible values:
5741 value past line inclusive ~
5742 old no yes
5743 inclusive yes yes
5744 exclusive yes no
5745 "past line" means that the cursor is allowed to be positioned one
5746 character past the line.
5747 "inclusive" means that the last character of the selection is included
5748 in an operation. For example, when "x" is used to delete the
5749 selection.
5750 Note that when "exclusive" is used and selecting from the end
5751 backwards, you cannot include the last character of a line, when
5752 starting in Normal mode and 'virtualedit' empty.
5753
5754 The 'selection' option is set by the |:behave| command.
5755
5756 *'selectmode'* *'slm'*
5757'selectmode' 'slm' string (default "")
5758 global
5759 {not in Vi}
5760 This is a comma separated list of words, which specifies when to start
5761 Select mode instead of Visual mode, when a selection is started.
5762 Possible values:
5763 mouse when using the mouse
5764 key when using shifted special keys
5765 cmd when using "v", "V" or CTRL-V
5766 See |Select-mode|.
5767 The 'selectmode' option is set by the |:behave| command.
5768
5769 *'sessionoptions'* *'ssop'*
5770'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005771 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005772 global
5773 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005774 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005775 feature}
5776 Changes the effect of the |:mksession| command. It is a comma
5777 separated list of words. Each word enables saving and restoring
5778 something:
5779 word save and restore ~
5780 blank empty windows
5781 buffers hidden and unloaded buffers, not just those in windows
5782 curdir the current directory
5783 folds manually created folds, opened/closed folds and local
5784 fold options
5785 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005786 and contain at least one lowercase letter. Only
5787 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 help the help window
5789 localoptions options and mappings local to a window or buffer (not
5790 global values for local options)
5791 options all options and mappings (also global values for local
5792 options)
5793 resize size of the Vim window: 'lines' and 'columns'
5794 sesdir the directory in which the session file is located
5795 will become the current directory (useful with
5796 projects accessed over a network from different
5797 systems)
5798 slash backslashes in file names replaced with forward
5799 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005800 tabpages all tab pages; without this only the current tab page
5801 is restored, so that you can make a session for each
5802 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 unix with Unix end-of-line format (single <NL>), even when
5804 on Windows or DOS
5805 winpos position of the whole Vim window
5806 winsize window sizes
5807
5808 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005809 When neither "curdir" nor "sesdir" is included, file names are stored
5810 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005811 "slash" and "unix" are useful on Windows when sharing session files
5812 with Unix. The Unix version of Vim cannot source dos format scripts,
5813 but the Windows version of Vim can source unix format scripts.
5814
5815 *'shell'* *'sh'* *E91*
5816'shell' 'sh' string (default $SHELL or "sh",
5817 MS-DOS and Win32: "command.com" or
5818 "cmd.exe", OS/2: "cmd")
5819 global
5820 Name of the shell to use for ! and :! commands. When changing the
5821 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5822 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005823 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005824 See |option-backslash| about including spaces and backslashes.
5825 Environment variables are expanded |:set_env|.
5826 If the name of the shell contains a space, you might need to enclose
5827 it in quotes. Example: >
5828 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5829< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005830 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005831 "-f" is not inside the quotes, because it is not part of the command
5832 name. And Vim automagically recognizes the backslashes that are path
5833 separators.
5834 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5835 variable to change the way external commands are executed. See the
5836 libc.inf file of DJGPP.
5837 Under MS-Windows, when the executable ends in ".com" it must be
5838 included. Thus setting the shell to "command.com" or "4dos.com"
5839 works, but "command" and "4dos" do not work for all commands (e.g.,
5840 filtering).
5841 For unknown reasons, when using "4dos.com" the current directory is
5842 changed to "C:\". To avoid this set 'shell' like this: >
5843 :set shell=command.com\ /c\ 4dos
5844< This option cannot be set from a |modeline| or in the |sandbox|, for
5845 security reasons.
5846
5847 *'shellcmdflag'* *'shcf'*
5848'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5849 does not contain "sh" somewhere: "/c")
5850 global
5851 {not in Vi}
5852 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5853 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5854 systems, the default is set according to the value of 'shell', to
5855 reduce the need to set this option by the user. It's not used for
5856 OS/2 (EMX figures this out itself). See |option-backslash| about
5857 including spaces and backslashes. See |dos-shell|.
5858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
5860
5861 *'shellpipe'* *'sp'*
5862'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5863 global
5864 {not in Vi}
5865 {not available when compiled without the |+quickfix|
5866 feature}
5867 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005868 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 including spaces and backslashes.
5870 The name of the temporary file can be represented by "%s" if necessary
5871 (the file name is appended automatically if no %s appears in the value
5872 of this option).
5873 For the Amiga and MS-DOS the default is ">". The output is directly
5874 saved in a file and not echoed to the screen.
5875 For Unix the default it "| tee". The stdout of the compiler is saved
5876 in a file and echoed to the screen. If the 'shell' option is "csh" or
5877 "tcsh" after initializations, the default becomes "|& tee". If the
5878 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005879 "2>&1| tee". This means that stderr is also included. Before using
5880 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005881 The initialization of this option is done after reading the ".vimrc"
5882 and the other initializations, so that when the 'shell' option is set
5883 there, the 'shellpipe' option changes automatically, unless it was
5884 explicitly set before.
5885 When 'shellpipe' is set to an empty string, no redirection of the
5886 ":make" output will be done. This is useful if you use a 'makeprg'
5887 that writes to 'makeef' by itself. If you want no piping, but do
5888 want to include the 'makeef', set 'shellpipe' to a single space.
5889 Don't forget to precede the space with a backslash: ":set sp=\ ".
5890 In the future pipes may be used for filtering and this option will
5891 become obsolete (at least for Unix).
5892 This option cannot be set from a |modeline| or in the |sandbox|, for
5893 security reasons.
5894
5895 *'shellquote'* *'shq'*
5896'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5897 contains "sh" somewhere: "\"")
5898 global
5899 {not in Vi}
5900 Quoting character(s), put around the command passed to the shell, for
5901 the "!" and ":!" commands. The redirection is kept outside of the
5902 quoting. See 'shellxquote' to include the redirection. It's
5903 probably not useful to set both options.
5904 This is an empty string by default. Only known to be useful for
5905 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5906 or bash, where it should be "\"". The default is adjusted according
5907 the value of 'shell', to reduce the need to set this option by the
5908 user. See |dos-shell|.
5909 This option cannot be set from a |modeline| or in the |sandbox|, for
5910 security reasons.
5911
5912 *'shellredir'* *'srr'*
5913'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5914 global
5915 {not in Vi}
5916 String to be used to put the output of a filter command in a temporary
5917 file. See also |:!|. See |option-backslash| about including spaces
5918 and backslashes.
5919 The name of the temporary file can be represented by "%s" if necessary
5920 (the file name is appended automatically if no %s appears in the value
5921 of this option).
5922 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5923 or "zsh" during initializations, the default becomes ">&". If the
5924 'shell' option is "sh", "ksh" or "bash" the default becomes
5925 ">%s 2>&1". This means that stderr is also included.
5926 For Win32, the Unix checks are done and additionally "cmd" is checked
5927 for, which makes the default ">%s 2>&1". Also, the same names with
5928 ".exe" appended are checked for.
5929 The initialization of this option is done after reading the ".vimrc"
5930 and the other initializations, so that when the 'shell' option is set
5931 there, the 'shellredir' option changes automatically unless it was
5932 explicitly set before.
5933 In the future pipes may be used for filtering and this option will
5934 become obsolete (at least for Unix).
5935 This option cannot be set from a |modeline| or in the |sandbox|, for
5936 security reasons.
5937
5938 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5939'shellslash' 'ssl' boolean (default off)
5940 global
5941 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5942 When set, a forward slash is used when expanding file names. This is
5943 useful when a Unix-like shell is used instead of command.com or
5944 cmd.exe. Backward slashes can still be typed, but they are changed to
5945 forward slashes by Vim.
5946 Note that setting or resetting this option has no effect for some
5947 existing file names, thus this option needs to be set before opening
5948 any file for best results. This might change in the future.
5949 'shellslash' only works when a backslash can be used as a path
5950 separator. To test if this is so use: >
5951 if exists('+shellslash')
5952<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005953 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5954'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5955 global
5956 {not in Vi}
5957 When on, use temp files for shell commands. When off use a pipe.
5958 When using a pipe is not possible temp files are used anyway.
5959 Currently a pipe is only supported on Unix. You can check it with: >
5960 :if has("filterpipe")
5961< The advantage of using a pipe is that nobody can read the temp file
5962 and the 'shell' command does not need to support redirection.
5963 The advantage of using a temp file is that the file type and encoding
5964 can be detected.
5965 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5966 |FilterWritePost| autocommands event are not triggered when
5967 'shelltemp' is off.
5968
Bram Moolenaar071d4272004-06-13 20:20:40 +00005969 *'shelltype'* *'st'*
5970'shelltype' 'st' number (default 0)
5971 global
5972 {not in Vi} {only for the Amiga}
5973 On the Amiga this option influences the way how the commands work
5974 which use a shell.
5975 0 and 1: always use the shell
5976 2 and 3: use the shell only to filter lines
5977 4 and 5: use shell only for ':sh' command
5978 When not using the shell, the command is executed directly.
5979
5980 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5981 1 and 3: use "shell cmd" to start external commands
5982
5983 *'shellxquote'* *'sxq'*
5984'shellxquote' 'sxq' string (default: "";
5985 for Win32, when 'shell' contains "sh"
5986 somewhere: "\""
5987 for Unix, when using system(): "\"")
5988 global
5989 {not in Vi}
5990 Quoting character(s), put around the command passed to the shell, for
5991 the "!" and ":!" commands. Includes the redirection. See
5992 'shellquote' to exclude the redirection. It's probably not useful
5993 to set both options.
5994 This is an empty string by default. Known to be useful for
5995 third-party shells when using the Win32 version, such as the MKS Korn
5996 Shell or bash, where it should be "\"". The default is adjusted
5997 according the value of 'shell', to reduce the need to set this option
5998 by the user. See |dos-shell|.
5999 This option cannot be set from a |modeline| or in the |sandbox|, for
6000 security reasons.
6001
6002 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6003'shiftround' 'sr' boolean (default off)
6004 global
6005 {not in Vi}
6006 Round indent to multiple of 'shiftwidth'. Applies to > and <
6007 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6008 a multiple of 'shiftwidth' (this is Vi compatible).
6009 NOTE: This option is reset when 'compatible' is set.
6010
6011 *'shiftwidth'* *'sw'*
6012'shiftwidth' 'sw' number (default 8)
6013 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006014 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006015 |'cindent'|, |>>|, |<<|, etc.
6016
6017 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006018'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6019 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006020 global
6021 {not in Vi}
6022 This option helps to avoid all the |hit-enter| prompts caused by file
6023 messages, for example with CTRL-G, and to avoid some other messages.
6024 It is a list of flags:
6025 flag meaning when present ~
6026 f use "(3 of 5)" instead of "(file 3 of 5)"
6027 i use "[noeol]" instead of "[Incomplete last line]"
6028 l use "999L, 888C" instead of "999 lines, 888 characters"
6029 m use "[+]" instead of "[Modified]"
6030 n use "[New]" instead of "[New File]"
6031 r use "[RO]" instead of "[readonly]"
6032 w use "[w]" instead of "written" for file write message
6033 and "[a]" instead of "appended" for ':w >> file' command
6034 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6035 "[unix format]" and "[mac]" instead of "[mac format]".
6036 a all of the above abbreviations
6037
6038 o overwrite message for writing a file with subsequent message
6039 for reading a file (useful for ":wn" or when 'autowrite' on)
6040 O message for reading a file overwrites any previous message.
6041 Also for quickfix message (e.g., ":cn").
6042 s don't give "search hit BOTTOM, continuing at TOP" or "search
6043 hit TOP, continuing at BOTTOM" messages
6044 t truncate file message at the start if it is too long to fit
6045 on the command-line, "<" will appear in the left most column.
6046 Ignored in Ex mode.
6047 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006048 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006049 Ignored in Ex mode.
6050 W don't give "written" or "[w]" when writing a file
6051 A don't give the "ATTENTION" message when an existing swap file
6052 is found.
6053 I don't give the intro message when starting Vim |:intro|.
6054
6055 This gives you the opportunity to avoid that a change between buffers
6056 requires you to hit <Enter>, but still gives as useful a message as
6057 possible for the space available. To get the whole message that you
6058 would have got with 'shm' empty, use ":file!"
6059 Useful values:
6060 shm= No abbreviation of message.
6061 shm=a Abbreviation, but no loss of information.
6062 shm=at Abbreviation, and truncate message when necessary.
6063
6064 NOTE: This option is set to the Vi default value when 'compatible' is
6065 set and to the Vim default value when 'compatible' is reset.
6066
6067 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6068'shortname' 'sn' boolean (default off)
6069 local to buffer
6070 {not in Vi, not in MS-DOS versions}
6071 Filenames are assumed to be 8 characters plus one extension of 3
6072 characters. Multiple dots in file names are not allowed. When this
6073 option is on, dots in file names are replaced with underscores when
6074 adding an extension (".~" or ".swp"). This option is not available
6075 for MS-DOS, because then it would always be on. This option is useful
6076 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6077 or crossdos. When running the Win32 GUI version under Win32s, this
6078 option is always on by default.
6079
6080 *'showbreak'* *'sbr'* *E595*
6081'showbreak' 'sbr' string (default "")
6082 global
6083 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006084 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006085 feature}
6086 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006087 values are "> " or "+++ ": >
6088 :set showbreak=>\
6089< Note the backslash to escape the trailing space. It's easier like
6090 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006091 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006092< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 comma (in a future version the comma might be used to separate the
6094 part that is shown at the end and at the start of a line).
6095 The characters are highlighted according to the '@' flag in
6096 'highlight'.
6097 Note that tabs after the showbreak will be displayed differently.
6098 If you want the 'showbreak' to appear in between line numbers, add the
6099 "n" flag to 'cpoptions'.
6100
6101 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6102'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6103 off)
6104 global
6105 {not in Vi}
6106 {not available when compiled without the
6107 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006108 Show (partial) command in the last line of the screen. Set this
6109 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006110 In Visual mode the size of the selected area is shown:
6111 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006112 If the number of bytes is different it is also displayed: "2-6"
6113 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006115 - When selecting a block, the size in screen characters:
6116 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 NOTE: This option is set to the Vi default value when 'compatible' is
6118 set and to the Vim default value when 'compatible' is reset.
6119
6120 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6121'showfulltag' 'sft' boolean (default off)
6122 global
6123 {not in Vi}
6124 When completing a word in insert mode (see |ins-completion|) from the
6125 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006126 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 matched a C function, you can see a template for what arguments are
6128 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006129 Note that this doesn't work well together with having "longest" in
6130 'completeopt', because the completion from the search pattern may not
6131 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132
6133 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6134'showmatch' 'sm' boolean (default off)
6135 global
6136 When a bracket is inserted, briefly jump to the matching one. The
6137 jump is only done if the match can be seen on the screen. The time to
6138 show the match can be set with 'matchtime'.
6139 A Beep is given if there is no match (no matter if the match can be
6140 seen or not). This option is reset when the 'paste' option is set.
6141 When the 'm' flag is not included in 'cpoptions', typing a character
6142 will immediately move the cursor back to where it belongs.
6143 See the "sm" field in 'guicursor' for setting the cursor shape and
6144 blinking when showing the match.
6145 The 'matchpairs' option can be used to specify the characters to show
6146 matches for. 'rightleft' and 'revins' are used to look for opposite
6147 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006148 Also see the matchparen plugin for highlighting the match when moving
6149 around |pi_paren.txt|.
6150 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006151
6152 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6153'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6154 global
6155 If in Insert, Replace or Visual mode put a message on the last line.
6156 Use the 'M' flag in 'highlight' to set the type of highlighting for
6157 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006158 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006159 doesn't mean XIM is really active, especially when 'imactivatekey' is
6160 not set.
6161 NOTE: This option is set to the Vi default value when 'compatible' is
6162 set and to the Vim default value when 'compatible' is reset.
6163
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006164 *'showtabline'* *'stal'*
6165'showtabline' 'stal' number (default 1)
6166 global
6167 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006168 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006169 feature}
6170 The value of this option specifies when the line with tab page labels
6171 will be displayed:
6172 0: never
6173 1: only if there are at least two tab pages
6174 2: always
6175 This is both for the GUI and non-GUI implementation of the tab pages
6176 line.
6177 See |tab-page| for more information about tab pages.
6178
Bram Moolenaar071d4272004-06-13 20:20:40 +00006179 *'sidescroll'* *'ss'*
6180'sidescroll' 'ss' number (default 0)
6181 global
6182 {not in Vi}
6183 The minimal number of columns to scroll horizontally. Used only when
6184 the 'wrap' option is off and the cursor is moved off of the screen.
6185 When it is zero the cursor will be put in the middle of the screen.
6186 When using a slow terminal set it to a large number or 0. When using
6187 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6188 commands.
6189
6190 *'sidescrolloff'* *'siso'*
6191'sidescrolloff' 'siso' number (default 0)
6192 global
6193 {not in Vi}
6194 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006195 right of the cursor if 'nowrap' is set. Setting this option to a
6196 value greater than 0 while having |'sidescroll'| also at a non-zero
6197 value makes some context visible in the line you are scrolling in
6198 horizontally (except at beginning of the line). Setting this option
6199 to a large value (like 999) has the effect of keeping the cursor
6200 horizontally centered in the window, as long as one does not come too
6201 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006202 NOTE: This option is set to 0 when 'compatible' is set.
6203
6204 Example: Try this together with 'sidescroll' and 'listchars' as
6205 in the following example to never allow the cursor to move
6206 onto the "extends" character:
6207
6208 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6209 :set sidescrolloff=1
6210
6211
6212 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6213'smartcase' 'scs' boolean (default off)
6214 global
6215 {not in Vi}
6216 Override the 'ignorecase' option if the search pattern contains upper
6217 case characters. Only used when the search pattern is typed and
6218 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006219 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6221 recalling the search pattern from history and hitting <Enter>.
6222 NOTE: This option is reset when 'compatible' is set.
6223
6224 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6225'smartindent' 'si' boolean (default off)
6226 local to buffer
6227 {not in Vi}
6228 {not available when compiled without the
6229 |+smartindent| feature}
6230 Do smart autoindenting when starting a new line. Works for C-like
6231 programs, but can also be used for other languages. 'cindent' does
6232 something like this, works better in most cases, but is more strict,
6233 see |C-indenting|. When 'cindent' is on, setting 'si' has no effect.
6234 'indentexpr' is a more advanced alternative.
6235 Normally 'autoindent' should also be on when using 'smartindent'.
6236 An indent is automatically inserted:
6237 - After a line ending in '{'.
6238 - After a line starting with a keyword from 'cinwords'.
6239 - Before a line starting with '}' (only with the "O" command).
6240 When typing '}' as the first character in a new line, that line is
6241 given the same indent as the matching '{'.
6242 When typing '#' as the first character in a new line, the indent for
6243 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006244 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006245 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6246 When using the ">>" command, lines starting with '#' are not shifted
6247 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006248 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006249 is set smart indenting is disabled.
6250
6251 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6252'smarttab' 'sta' boolean (default off)
6253 global
6254 {not in Vi}
6255 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006256 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6257 <BS> will delete a 'shiftwidth' worth of space at the start of the
6258 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006259 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006260 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6261 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006262 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006264 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 NOTE: This option is reset when 'compatible' is set.
6266
6267 *'softtabstop'* *'sts'*
6268'softtabstop' 'sts' number (default 0)
6269 local to buffer
6270 {not in Vi}
6271 Number of spaces that a <Tab> counts for while performing editing
6272 operations, like inserting a <Tab> or using <BS>. It "feels" like
6273 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6274 used. This is useful to keep the 'ts' setting at its standard value
6275 of 8, while being able to edit like it is set to 'sts'. However,
6276 commands like "x" still work on the actual characters.
6277 When 'sts' is zero, this feature is off.
6278 'softtabstop' is set to 0 when the 'paste' option is set.
6279 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6280 spaces is minimized by using <Tab>s.
6281 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6282 set.
6283 NOTE: This option is set to 0 when 'compatible' is set.
6284
Bram Moolenaar217ad922005-03-20 22:37:15 +00006285 *'spell'* *'nospell'*
6286'spell' boolean (default off)
6287 local to window
6288 {not in Vi}
6289 {not available when compiled without the |+syntax|
6290 feature}
6291 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006292 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006293
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006294 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006295'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006296 local to buffer
6297 {not in Vi}
6298 {not available when compiled without the |+syntax|
6299 feature}
6300 Pattern to locate the end of a sentence. The following word will be
6301 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006302 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006303 When this check is not wanted make this option empty.
6304 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006305 Be careful with special characters, see |option-backslash| about
6306 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006307 To set this option automatically depending on the language, see
6308 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006309
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006310 *'spellfile'* *'spf'*
6311'spellfile' 'spf' string (default empty)
6312 local to buffer
6313 {not in Vi}
6314 {not available when compiled without the |+syntax|
6315 feature}
6316 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006317 commands. It must end in ".{encoding}.add". You need to include the
6318 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006319 *E765*
6320 It may also be a comma separated list of names. A count before the
6321 |zg| and |zw| commands can be used to access each. This allows using
6322 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006323 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006324 you: Using the first directory in 'runtimepath' that is writable. If
6325 there is no "spell" directory yet it will be created. For the file
6326 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006327 ignoring the region.
6328 The resulting ".spl" file will be used for spell checking, it does not
6329 have to appear in 'spelllang'.
6330 Normally one file is used for all regions, but you can add the region
6331 name if you want to. However, it will then only be used when
6332 'spellfile' is set to it, for entries in 'spelllang' only files
6333 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006334 This option cannot be set from a |modeline| or in the |sandbox|, for
6335 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006336
Bram Moolenaar217ad922005-03-20 22:37:15 +00006337 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006338'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006339 local to buffer
6340 {not in Vi}
6341 {not available when compiled without the |+syntax|
6342 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006343 A comma separated list of word list names. When the 'spell' option is
6344 on spellchecking will be done for these languages. Example: >
6345 set spelllang=en_us,nl,medical
6346< This means US English, Dutch and medical words are recognized. Words
6347 that are not recognized will be highlighted.
6348 The word list name must not include a comma or dot. Using a dash is
6349 recommended to separate the two letter language name from a
6350 specification. Thus "en-rare" is used for rare English words.
6351 A region name must come last and have the form "_xx", where "xx" is
6352 the two-letter, lower case region name. You can use more than one
6353 region by listing them: "en_us,en_ca" supports both US and Canadian
6354 English, but not words specific for Australia, New Zealand or Great
6355 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006356 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006357 As a special case the name of a .spl file can be given as-is. The
6358 first "_xx" in the name is removed and used as the region name
6359 (_xx is an underscore, two letters and followed by a non-letter).
6360 This is mainly for testing purposes. You must make sure the correct
6361 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006362 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006363 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6364 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006365 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006366
Bram Moolenaar98692072006-02-04 00:57:42 +00006367 If the |spellfile.vim| plugin is active and you use a language name
6368 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6369 will ask you if you want to download the file.
6370
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006371 After this option has been set successfully, Vim will source the files
6372 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006373 up to the first comma, dot or underscore.
6374 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006375
6376
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006377 *'spellsuggest'* *'sps'*
6378'spellsuggest' 'sps' string (default "best")
6379 global
6380 {not in Vi}
6381 {not available when compiled without the |+syntax|
6382 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006383 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006384 the |spellsuggest()| function. This is a comma-separated list of
6385 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006386
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006387 best Internal method that works best for English. Finds
6388 changes like "fast" and uses a bit of sound-a-like
6389 scoring to improve the ordering.
6390
6391 double Internal method that uses two methods and mixes the
6392 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006393 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006394 word. That only works when the language specifies
6395 sound folding. Can be slow and doesn't always give
6396 better results.
6397
6398 fast Internal method that only checks for simple changes:
6399 character inserts/deletes/swaps. Works well for
6400 simple typing mistakes.
6401
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006402 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006403 Not used for |spellsuggest()|. The number of
6404 suggestions is never more than the value of 'lines'
6405 minus two.
6406
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006407 file:{filename} Read file {filename}, which must have two columns,
6408 separated by a slash. The first column contains the
6409 bad word, the second column the suggested good word.
6410 Example:
6411 theribal/terrible ~
6412 Use this for common mistakes that do not appear at the
6413 top of the suggestion list with the internal methods.
6414 Lines without a slash are ignored, use this for
6415 comments.
6416 The file is used for all languages.
6417
6418 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6419 trouble with spaces. |v:val| holds the badly spelled
6420 word. The expression must evaluate to a List of
6421 Lists, each with a suggestion and a score.
6422 Example:
6423 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006424 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006425 internal methods use. A lower score is better.
6426 This may invoke |spellsuggest()| if you temporarily
6427 set 'spellsuggest' to exclude the "expr:" part.
6428 Errors are silently ignored, unless you set the
6429 'verbose' option to a non-zero value.
6430
6431 Only one of "best", "double" or "fast" may be used. The others may
6432 appear several times in any order. Example: >
6433 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6434<
6435 This option cannot be set from a |modeline| or in the |sandbox|, for
6436 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006437
6438
Bram Moolenaar071d4272004-06-13 20:20:40 +00006439 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6440'splitbelow' 'sb' boolean (default off)
6441 global
6442 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006443 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 feature}
6445 When on, splitting a window will put the new window below the current
6446 one. |:split|
6447
6448 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6449'splitright' 'spr' boolean (default off)
6450 global
6451 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006452 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 feature}
6454 When on, splitting a window will put the new window right of the
6455 current one. |:vsplit|
6456
6457 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6458'startofline' 'sol' boolean (default on)
6459 global
6460 {not in Vi}
6461 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006462 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006463 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006464 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 with a linewise operator, with "%" with a count and to buffer changing
6466 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6467 only has a line number, e.g., ":25" or ":+".
6468 In case of buffer changing commands the cursor is placed at the column
6469 where it was the last time the buffer was edited.
6470 NOTE: This option is set when 'compatible' is set.
6471
6472 *'statusline'* *'stl'* *E540* *E541* *E542*
6473'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006474 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 {not in Vi}
6476 {not available when compiled without the |+statusline|
6477 feature}
6478 When nonempty, this option determines the content of the status line.
6479 Also see |status-line|.
6480
6481 The option consists of printf style '%' items interspersed with
6482 normal text. Each status line item is of the form:
6483 %-0{minwid}.{maxwid}{item}
6484 All fields except the {item} is optional. A single percent sign can
6485 be given as "%%". Up to 80 items can be specified.
6486
Bram Moolenaar238a5642006-02-21 22:12:05 +00006487 When the option starts with "%!" then it is used as an expression,
6488 evaluated and the result is used as the option value. Example: >
6489 :set statusline=%!MyStatusLine()
6490< The result can contain %{} items that will be evaluated too.
6491
6492 When there is error while evaluating the option then it will be made
6493 empty to avoid further errors. Otherwise screen updating would loop.
6494
Bram Moolenaar071d4272004-06-13 20:20:40 +00006495 Note that the only effect of 'ruler' when this option is set (and
6496 'laststatus' is 2) is controlling the output of |CTRL-G|.
6497
6498 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006499 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006501 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 minwid Minimum width of the item, padding as set by '-' & '0'.
6503 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006504 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 on the left for text items. Numeric items will be
6506 shifted down to maxwid-2 digits followed by '>'number
6507 where number is the amount of missing digits, much like
6508 an exponential notation.
6509 item A one letter code as described below.
6510
6511 Following is a description of the possible statusline items. The
6512 second character in "item" is the type:
6513 N for number
6514 S for string
6515 F for flags as described below
6516 - not applicable
6517
6518 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006519 f S Path to the file in the buffer, as typed or relative to current
6520 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 F S Full path to the file in the buffer.
6522 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006523 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006525 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006526 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006527 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006528 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006529 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006530 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006531 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006532 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6533 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006534 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006535 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6536 being used: "<keymap>"
6537 n N Buffer number.
6538 b N Value of byte under cursor.
6539 B N As above, in hexadecimal.
6540 o N Byte number in file of byte under cursor, first byte is 1.
6541 Mnemonic: Offset from start of file (with one added)
6542 {not available when compiled without |+byte_offset| feature}
6543 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006544 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006545 l N Line number.
6546 L N Number of lines in buffer.
6547 c N Column number.
6548 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006549 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006550 p N Percentage through file in lines as in |CTRL-G|.
6551 P S Percentage through file of displayed window. This is like the
6552 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006553 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006554 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006555 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006556 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006557 ( - Start of item group. Can be used for setting the width and
6558 alignment of a section. Must be followed by %) somewhere.
6559 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006560 T N For 'tabline': start of tab page N label. Use %T after the last
6561 label. This information is used for mouse clicks.
6562 X N For 'tabline': start of close tab N label. Use %X after the
6563 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6564 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006565 < - Where to truncate line if too long. Default is at the start.
6566 No width fields allowed.
6567 = - Separation point between left and right aligned items.
6568 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006569 # - Set highlight group. The name must follow and then a # again.
6570 Thus use %#HLname# for highlight group HLname. The same
6571 highlighting is used, also for the statusline of non-current
6572 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006574 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006575 The difference between User{N} and StatusLine will be applied
6576 to StatusLineNC for the statusline of non-current windows.
6577 The number N must be between 1 and 9. See |hl-User1..9|
6578
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006579 When displaying a flag, Vim removes the leading comma, if any, when
6580 that flag comes right after plaintext. This will make a nice display
6581 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006582
Bram Moolenaar582fd852005-03-28 20:58:01 +00006583 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006584 not set) and a minwid is not set for the group, the whole group will
6585 become empty. This will make a group like the following disappear
6586 completely from the statusline when none of the flags are set. >
6587 :set statusline=...%(\ [%M%R%H]%)...
6588<
6589 Beware that an expression is evaluated each and every time the status
6590 line is displayed. The current buffer and current window will be set
6591 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006592 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006593 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006594 real current buffer.
6595
6596 The 'statusline' option may be evaluated in the |sandbox|, see
6597 |sandbox-option|.
6598
6599 It is not allowed to change text or jump to another window while
6600 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601
6602 If the statusline is not updated when you want it (e.g., after setting
6603 a variable that's used in an expression), you can force an update by
6604 setting an option without changing its value. Example: >
6605 :let &ro = &ro
6606
6607< A result of all digits is regarded a number for display purposes.
6608 Otherwise the result is taken as flag text and applied to the rules
6609 described above.
6610
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006611 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006612 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6613 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6614
6615 Examples:
6616 Emulate standard status line with 'ruler' set >
6617 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6618< Similar, but add ASCII value of char under the cursor (like "ga") >
6619 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6620< Display byte count and byte value, modified flag in red. >
6621 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6622 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6623< Display a ,GZ flag if a compressed file is loaded >
6624 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6625< In the |:autocmd|'s: >
6626 :let b:gzflag = 1
6627< And: >
6628 :unlet b:gzflag
6629< And define this function: >
6630 :function VarExists(var, val)
6631 : if exists(a:var) | return a:val | else | return '' | endif
6632 :endfunction
6633<
6634 *'suffixes'* *'su'*
6635'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6636 global
6637 {not in Vi}
6638 Files with these suffixes get a lower priority when multiple files
6639 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006640 suffixes. Spaces after the comma are ignored. A dot is also seen as
6641 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006642 separator, precede it with a backslash (see |option-backslash| about
6643 including spaces and backslashes).
6644 See 'wildignore' for completely ignoring files.
6645 The use of |:set+=| and |:set-=| is preferred when adding or removing
6646 suffixes from the list. This avoids problems when a future version
6647 uses another default.
6648
6649 *'suffixesadd'* *'sua'*
6650'suffixesadd' 'sua' string (default "")
6651 local to buffer
6652 {not in Vi}
6653 {not available when compiled without the
6654 |+file_in_path| feature}
6655 Comma separated list of suffixes, which are used when searching for a
6656 file for the "gf", "[I", etc. commands. Example: >
6657 :set suffixesadd=.java
6658<
6659 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6660'swapfile' 'swf' boolean (default on)
6661 local to buffer
6662 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006663 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006664 swapfile is not wanted for a specific buffer. For example, with
6665 confidential information that even root must not be able to access.
6666 Careful: All text will be in memory:
6667 - Don't use this for big files.
6668 - Recovery will be impossible!
6669 A swapfile will only be present when |'updatecount'| is non-zero and
6670 'swapfile' is set.
6671 When 'swapfile' is reset, the swap file for the current buffer is
6672 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6673 non-zero, a swap file is immediately created.
6674 Also see |swap-file| and |'swapsync'|.
6675
6676 This option is used together with 'bufhidden' and 'buftype' to
6677 specify special kinds of buffers. See |special-buffers|.
6678
6679 *'swapsync'* *'sws'*
6680'swapsync' 'sws' string (default "fsync")
6681 global
6682 {not in Vi}
6683 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 When this option is empty parts of the swap file may be in memory and
6686 not written to disk. When the system crashes you may lose more work.
6687 On Unix the system does a sync now and then without Vim asking for it,
6688 so the disadvantage of setting this option off is small. On some
6689 systems the swap file will not be written at all. For a unix system
6690 setting it to "sync" will use the sync() call instead of the default
6691 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006692 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693
6694 *'switchbuf'* *'swb'*
6695'switchbuf' 'swb' string (default "")
6696 global
6697 {not in Vi}
6698 This option controls the behavior when switching between buffers.
6699 Possible values (comma separated list):
6700 useopen If included, jump to the first open window that
6701 contains the specified buffer (if there is one).
6702 Otherwise: Do not examine other windows.
6703 This setting is checked with |quickfix| commands, when
6704 jumping to errors (":cc", ":cn", "cp", etc.). It is
6705 also used in all buffer related split commands, for
6706 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006707 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006708 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006710 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006711 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006712 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006713 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006715 *'synmaxcol'* *'smc'*
6716'synmaxcol' 'smc' number (default 3000)
6717 local to buffer
6718 {not in Vi}
6719 {not available when compiled without the |+syntax|
6720 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006721 Maximum column in which to search for syntax items. In long lines the
6722 text after this column is not highlighted and following lines may not
6723 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006724 This helps to avoid very slow redrawing for an XML file that is one
6725 long line.
6726 Set to zero to remove the limit.
6727
Bram Moolenaar071d4272004-06-13 20:20:40 +00006728 *'syntax'* *'syn'*
6729'syntax' 'syn' string (default empty)
6730 local to buffer
6731 {not in Vi}
6732 {not available when compiled without the |+syntax|
6733 feature}
6734 When this option is set, the syntax with this name is loaded, unless
6735 syntax highlighting has been switched off with ":syntax off".
6736 Otherwise this option does not always reflect the current syntax (the
6737 b:current_syntax variable does).
6738 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006739 not automatically recognized. Example, in an IDL file:
6740 /* vim: set syntax=idl : */ ~
6741 When a dot appears in the value then this separates two filetype
6742 names. Example:
6743 /* vim: set syntax=c.doxygen : */ ~
6744 This will use the "c" syntax first, then the "doxygen" syntax.
6745 Note that the second one must be prepared to be loaded as an addition,
6746 otherwise it will be skipped. More than one dot may appear.
6747 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006748 :set syntax=OFF
6749< To switch syntax highlighting on according to the current value of the
6750 'filetype' option: >
6751 :set syntax=ON
6752< What actually happens when setting the 'syntax' option is that the
6753 Syntax autocommand event is triggered with the value as argument.
6754 This option is not copied to another buffer, independent of the 's' or
6755 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006756 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006757
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006758 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006759'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006760 global
6761 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006762 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006763 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006764 When nonempty, this option determines the content of the tab pages
6765 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006766 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006767
6768 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006769 option and only when there is no GUI tab line. When 'e' is in
6770 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006771 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006772
6773 The value is evaluated like with 'statusline'. You can use
6774 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006775 the text to be displayed. Use "%1T" for the first label, "%2T" for
6776 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006777
6778 Keep in mind that only one of the tab pages is the current one, others
6779 are invisible and you can't jump to their windows.
6780
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006781
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006782 *'tabpagemax'* *'tpm'*
6783'tabpagemax' 'tpm' number (default 10)
6784 global
6785 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006786 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006787 feature}
6788 Maximum number of tab pages to be opened by the |-p| command line
6789 argument or the ":tab all" command. |tabpage|
6790
6791
6792 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793'tabstop' 'ts' number (default 8)
6794 local to buffer
6795 Number of spaces that a <Tab> in the file counts for. Also see
6796 |:retab| command, and 'softtabstop' option.
6797
6798 Note: Setting 'tabstop' to any other value than 8 can make your file
6799 appear wrong in many places (e.g., when printing it).
6800
6801 There are four main ways to use tabs in Vim:
6802 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6803 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006804 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 behave like a tab appears every 4 (or 3) characters.
6806 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6807 'expandtab'. This way you will always insert spaces. The
6808 formatting will never be messed up when 'tabstop' is changed.
6809 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006810 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006811 works when using Vim to edit the file.
6812 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6813 'noexpandtab'. This should then work (for initial indents only)
6814 for any tabstop setting that people use. It might be nice to have
6815 tabs after the first non-blank inserted as spaces if you do this
6816 though. Otherwise aligned comments will be wrong when 'tabstop' is
6817 changed.
6818
6819 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6820'tagbsearch' 'tbs' boolean (default on)
6821 global
6822 {not in Vi}
6823 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006824 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 searching makes searching for a tag a LOT faster, but a linear search
6826 will find more tags if the tags file wasn't properly sorted.
6827 Vim normally assumes that your tags files are sorted, or indicate that
6828 they are not sorted. Only when this is not the case does the
6829 'tagbsearch' option need to be switched off.
6830
6831 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006832 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833 certain files, or retry all files with a linear search. When
6834 'tagbsearch' is off, only a linear search is done.
6835
6836 Linear searching is done anyway, for one file, when Vim finds a line
6837 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006838 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839< [The whitespace before and after the '0' must be a single <Tab>]
6840
6841 When a binary search was done and no match was found in any of the
6842 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6843 instead of a normal tag name, a retry is done with a linear search.
6844 Tags in unsorted tags files, and matches with different case will only
6845 be found in the retry.
6846
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006847 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848 linear search can be avoided for the 'ignorecase' case. Use a value
6849 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6850 case-fold sorted with the -f switch to "sort" in most unices, as in
6851 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006852 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6853 for this as well. Note that case must be folded to uppercase for this
6854 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855
6856 When 'tagbsearch' is off, tags searching is slower when a full match
6857 exists, but faster when no full match exists. Tags in unsorted tags
6858 files may only be found with 'tagbsearch' off.
6859 When the tags file is not sorted, or sorted in a wrong way (not on
6860 ASCII byte value), 'tagbsearch' should be off, or the line given above
6861 must be included in the tags file.
6862 This option doesn't affect commands that find all matching tags (e.g.,
6863 command-line completion and ":help").
6864 {Vi: always uses binary search in some versions}
6865
6866 *'taglength'* *'tl'*
6867'taglength' 'tl' number (default 0)
6868 global
6869 If non-zero, tags are significant up to this number of characters.
6870
6871 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6872'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6873 global
6874 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006875 If on and using a tags file in another directory, file names in that
6876 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006877 NOTE: This option is set to the Vi default value when 'compatible' is
6878 set and to the Vim default value when 'compatible' is reset.
6879
6880 *'tags'* *'tag'* *E433*
6881'tags' 'tag' string (default "./tags,tags", when compiled with
6882 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6883 global or local to buffer |global-local|
6884 Filenames for the tag command, separated by spaces or commas. To
6885 include a space or comma in a file name, precede it with a backslash
6886 (see |option-backslash| about including spaces and backslashes).
6887 When a file name starts with "./", the '.' is replaced with the path
6888 of the current file. But only when the 'd' flag is not included in
6889 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6890 |tags-option|.
6891 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006892 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6893 find all files named "tags" below "/lib". The filename itself cannot
6894 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6895 files called "tags?". {not available when compiled without the
6896 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006897 The |tagfiles()| function can be used to get a list of the file names
6898 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006899 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6900 files are also supported. They are automatically recognized. The
6901 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6902 differences are ignored (MS-Windows). |emacs-tags|
6903 The use of |:set+=| and |:set-=| is preferred when adding or removing
6904 file names from the list. This avoids problems when a future version
6905 uses another default.
6906 {Vi: default is "tags /usr/lib/tags"}
6907
6908 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6909'tagstack' 'tgst' boolean (default on)
6910 global
6911 {not in all versions of Vi}
6912 When on, the |tagstack| is used normally. When off, a ":tag" or
6913 ":tselect" command with an argument will not push the tag onto the
6914 tagstack. A following ":tag" without an argument, a ":pop" command or
6915 any other command that uses the tagstack will use the unmodified
6916 tagstack, but does change the pointer to the active entry.
6917 Resetting this option is useful when using a ":tag" command in a
6918 mapping which should not change the tagstack.
6919
6920 *'term'* *E529* *E530* *E531*
6921'term' string (default is $TERM, if that fails:
6922 in the GUI: "builtin_gui"
6923 on Amiga: "amiga"
6924 on BeOS: "beos-ansi"
6925 on Mac: "mac-ansi"
6926 on MiNT: "vt52"
6927 on MS-DOS: "pcterm"
6928 on OS/2: "os2ansi"
6929 on Unix: "ansi"
6930 on VMS: "ansi"
6931 on Win 32: "win32")
6932 global
6933 Name of the terminal. Used for choosing the terminal control
6934 characters. Environment variables are expanded |:set_env|.
6935 For example: >
6936 :set term=$TERM
6937< See |termcap|.
6938
6939 *'termbidi'* *'tbidi'*
6940 *'notermbidi'* *'notbidi'*
6941'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6942 global
6943 {not in Vi}
6944 {only available when compiled with the |+arabic|
6945 feature}
6946 The terminal is in charge of Bi-directionality of text (as specified
6947 by Unicode). The terminal is also expected to do the required shaping
6948 that some languages (such as Arabic) require.
6949 Setting this option implies that 'rightleft' will not be set when
6950 'arabic' is set and the value of 'arabicshape' will be ignored.
6951 Note that setting 'termbidi' has the immediate effect that
6952 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6953 This option is reset when the GUI is started.
6954 For further details see |arabic.txt|.
6955
6956 *'termencoding'* *'tenc'*
6957'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6958 Macintosh GUI: "macroman")
6959 global
6960 {only available when compiled with the |+multi_byte|
6961 feature}
6962 {not in Vi}
6963 Encoding used for the terminal. This specifies what character
6964 encoding the keyboard produces and the display will understand. For
6965 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006966 display). Except for the Mac when 'macatsui' is off, then
6967 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006968 In the Win32 console version the default value is the console codepage
6969 when it differs from the ANSI codepage.
6970 *E617*
6971 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6972 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6973 Any attempts to set a different value will be rejected, and an error
6974 message is shown.
6975 For the Win32 GUI 'termencoding' is not used for typed characters,
6976 because the Win32 system always passes Unicode characters.
6977 When empty, the same encoding is used as for the 'encoding' option.
6978 This is the normal value.
6979 Not all combinations for 'termencoding' and 'encoding' are valid. See
6980 |encoding-table|.
6981 The value for this option must be supported by internal conversions or
6982 iconv(). When this is not possible no conversion will be done and you
6983 will probably experience problems with non-ASCII characters.
6984 Example: You are working with the locale set to euc-jp (Japanese) and
6985 want to edit a UTF-8 file: >
6986 :let &termencoding = &encoding
6987 :set encoding=utf-8
6988< You need to do this when your system has no locale support for UTF-8.
6989
6990 *'terse'* *'noterse'*
6991'terse' boolean (default off)
6992 global
6993 When set: Add 's' flag to 'shortmess' option (this makes the message
6994 for a search that hits the start or end of the file not being
6995 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
6996 shortens a lot of messages}
6997
6998 *'textauto'* *'ta'* *'notextauto'* *'nota'*
6999'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7000 global
7001 {not in Vi}
7002 This option is obsolete. Use 'fileformats'.
7003 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7004 set to the default value for the current system. When 'textauto' is
7005 reset, 'fileformats' is made empty.
7006 NOTE: This option is set to the Vi default value when 'compatible' is
7007 set and to the Vim default value when 'compatible' is reset.
7008
7009 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7010'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7011 others: default off)
7012 local to buffer
7013 {not in Vi}
7014 This option is obsolete. Use 'fileformat'.
7015 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7016 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7017 "unix".
7018
7019 *'textwidth'* *'tw'*
7020'textwidth' 'tw' number (default 0)
7021 local to buffer
7022 {not in Vi}
7023 Maximum width of text that is being inserted. A longer line will be
7024 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007025 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7026 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007027 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007028 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007029 NOTE: This option is set to 0 when 'compatible' is set.
7030
7031 *'thesaurus'* *'tsr'*
7032'thesaurus' 'tsr' string (default "")
7033 global or local to buffer |global-local|
7034 {not in Vi}
7035 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007036 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007037 the file should contain words with similar meaning, separated by
7038 non-keyword characters (white space is preferred). Maximum line
7039 length is 510 bytes.
7040 To obtain a file to be used here, check out the wordlist FAQ at
7041 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007042 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 after a comma are ignored, otherwise spaces are included in the file
7044 name. See |option-backslash| about using backslashes.
7045 The use of |:set+=| and |:set-=| is preferred when adding or removing
7046 directories from the list. This avoids problems when a future version
7047 uses another default.
7048 Backticks cannot be used in this option for security reasons.
7049
7050 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7051'tildeop' 'top' boolean (default off)
7052 global
7053 {not in Vi}
7054 When on: The tilde command "~" behaves like an operator.
7055 NOTE: This option is reset when 'compatible' is set.
7056
7057 *'timeout'* *'to'* *'notimeout'* *'noto'*
7058'timeout' 'to' boolean (default on)
7059 global
7060 *'ttimeout'* *'nottimeout'*
7061'ttimeout' boolean (default off)
7062 global
7063 {not in Vi}
7064 These two options together determine the behavior when part of a
7065 mapped key sequence or keyboard code has been received:
7066
7067 'timeout' 'ttimeout' action ~
7068 off off do not time out
7069 on on or off time out on :mappings and key codes
7070 off on time out on key codes
7071
7072 If both options are off, Vim will wait until either the complete
7073 mapping or key sequence has been received, or it is clear that there
7074 is no mapping or key sequence for the received characters. For
7075 example: if you have mapped "vl" and Vim has received 'v', the next
7076 character is needed to see if the 'v' is followed by an 'l'.
7077 When one of the options is on, Vim will wait for about 1 second for
7078 the next character to arrive. After that the already received
7079 characters are interpreted as single characters. The waiting time can
7080 be changed with the 'timeoutlen' option.
7081 On slow terminals or very busy systems timing out may cause
7082 malfunctioning cursor keys. If both options are off, Vim waits
7083 forever after an entered <Esc> if there are key codes that start
7084 with <Esc>. You will have to type <Esc> twice. If you do not have
7085 problems with key codes, but would like to have :mapped key
7086 sequences not timing out in 1 second, set the 'ttimeout' option and
7087 reset the 'timeout' option.
7088
7089 NOTE: 'ttimeout' is reset when 'compatible' is set.
7090
7091 *'timeoutlen'* *'tm'*
7092'timeoutlen' 'tm' number (default 1000)
7093 global
7094 {not in all versions of Vi}
7095 *'ttimeoutlen'* *'ttm'*
7096'ttimeoutlen' 'ttm' number (default -1)
7097 global
7098 {not in Vi}
7099 The time in milliseconds that is waited for a key code or mapped key
7100 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7101 when part of a command has been typed.
7102 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7103 different timeout value for key codes is desired set 'ttimeoutlen' to
7104 a non-negative number.
7105
7106 ttimeoutlen mapping delay key code delay ~
7107 < 0 'timeoutlen' 'timeoutlen'
7108 >= 0 'timeoutlen' 'ttimeoutlen'
7109
7110 The timeout only happens when the 'timeout' and 'ttimeout' options
7111 tell so. A useful setting would be >
7112 :set timeout timeoutlen=3000 ttimeoutlen=100
7113< (time out on mapping after three seconds, time out on key codes after
7114 a tenth of a second).
7115
7116 *'title'* *'notitle'*
7117'title' boolean (default off, on when title can be restored)
7118 global
7119 {not in Vi}
7120 {not available when compiled without the |+title|
7121 feature}
7122 When on, the title of the window will be set to the value of
7123 'titlestring' (if it is not empty), or to:
7124 filename [+=-] (path) - VIM
7125 Where:
7126 filename the name of the file being edited
7127 - indicates the file cannot be modified, 'ma' off
7128 + indicates the file was modified
7129 = indicates the file is read-only
7130 =+ indicates the file is read-only and modified
7131 (path) is the path of the file being edited
7132 - VIM the server name |v:servername| or "VIM"
7133 Only works if the terminal supports setting window titles
7134 (currently Amiga console, Win32 console, all GUI versions and
7135 terminals with a non- empty 't_ts' option - these are Unix xterm and
7136 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7137 *X11*
7138 When Vim was compiled with HAVE_X11 defined, the original title will
7139 be restored if possible. The output of ":version" will include "+X11"
7140 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7141 works for the icon name |'icon'|.
7142 But: When Vim was started with the |-X| argument, restoring the title
7143 will not work (except in the GUI).
7144 If the title cannot be restored, it is set to the value of 'titleold'.
7145 You might want to restore the title outside of Vim then.
7146 When using an xterm from a remote machine you can use this command:
7147 rsh machine_name xterm -display $DISPLAY &
7148 then the WINDOWID environment variable should be inherited and the
7149 title of the window should change back to what it should be after
7150 exiting Vim.
7151
7152 *'titlelen'*
7153'titlelen' number (default 85)
7154 global
7155 {not in Vi}
7156 {not available when compiled without the |+title|
7157 feature}
7158 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 title. When the title is longer, only the end of the path name is
7160 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 Using a percentage makes this adapt to the width of the window. But
7162 it won't work perfectly, because the actual number of characters
7163 available also depends on the font used and other things in the title
7164 bar. When 'titlelen' is zero the full path is used. Otherwise,
7165 values from 1 to 30000 percent can be used.
7166 'titlelen' is also used for the 'titlestring' option.
7167
7168 *'titleold'*
7169'titleold' string (default "Thanks for flying Vim")
7170 global
7171 {not in Vi}
7172 {only available when compiled with the |+title|
7173 feature}
7174 This option will be used for the window title when exiting Vim if the
7175 original title cannot be restored. Only happens if 'title' is on or
7176 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007177 This option cannot be set from a |modeline| or in the |sandbox|, for
7178 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179 *'titlestring'*
7180'titlestring' string (default "")
7181 global
7182 {not in Vi}
7183 {not available when compiled without the |+title|
7184 feature}
7185 When this option is not empty, it will be used for the title of the
7186 window. This happens only when the 'title' option is on.
7187 Only works if the terminal supports setting window titles (currently
7188 Amiga console, Win32 console, all GUI versions and terminals with a
7189 non-empty 't_ts' option).
7190 When Vim was compiled with HAVE_X11 defined, the original title will
7191 be restored if possible |X11|.
7192 When this option contains printf-style '%' items, they will be
7193 expanded according to the rules used for 'statusline'.
7194 Example: >
7195 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7196 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7197< The value of 'titlelen' is used to align items in the middle or right
7198 of the available space.
7199 Some people prefer to have the file name first: >
7200 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7201< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 separating space only when needed.
7204 NOTE: Use of special characters in 'titlestring' may cause the display
7205 to be garbled (e.g., when it contains a CR or NL character).
7206 {not available when compiled without the |+statusline| feature}
7207
7208 *'toolbar'* *'tb'*
7209'toolbar' 'tb' string (default "icons,tooltips")
7210 global
7211 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7212 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007213 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 possible values are:
7215 icons Toolbar buttons are shown with icons.
7216 text Toolbar buttons shown with text.
7217 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007218 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 tooltips Tooltips are active for toolbar buttons.
7220 Tooltips refer to the popup help text which appears after the mouse
7221 cursor is placed over a toolbar button for a brief moment.
7222
7223 If you want the toolbar to be shown with icons as well as text, do the
7224 following: >
7225 :set tb=icons,text
7226< Motif and Athena cannot display icons and text at the same time. They
7227 will show icons if both are requested.
7228
7229 If none of the strings specified in 'toolbar' are valid or if
7230 'toolbar' is empty, this option is ignored. If you want to disable
7231 the toolbar, you need to set the 'guioptions' option. For example: >
7232 :set guioptions-=T
7233< Also see |gui-toolbar|.
7234
7235 *'toolbariconsize'* *'tbis'*
7236'toolbariconsize' 'tbis' string (default "small")
7237 global
7238 {not in Vi}
7239 {only in the GTK+ 2 GUI}
7240 Controls the size of toolbar icons. The possible values are:
7241 tiny Use tiny toolbar icons.
7242 small Use small toolbar icons (default).
7243 medium Use medium-sized toolbar icons.
7244 large Use large toolbar icons.
7245 The exact dimensions in pixels of the various icon sizes depend on
7246 the current theme. Common dimensions are large=32x32, medium=24x24,
7247 small=20x20 and tiny=16x16.
7248
7249 If 'toolbariconsize' is empty, the global default size as determined
7250 by user preferences or the current theme is used.
7251
7252 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7253'ttybuiltin' 'tbi' boolean (default on)
7254 global
7255 {not in Vi}
7256 When on, the builtin termcaps are searched before the external ones.
7257 When off the builtin termcaps are searched after the external ones.
7258 When this option is changed, you should set the 'term' option next for
7259 the change to take effect, for example: >
7260 :set notbi term=$TERM
7261< See also |termcap|.
7262 Rationale: The default for this option is "on", because the builtin
7263 termcap entries are generally better (many systems contain faulty
7264 xterm entries...).
7265
7266 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7267'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7268 sun-cmd, screen, rxvt, dtterm or
7269 iris-ansi; also on when running Vim in
7270 a DOS console)
7271 global
7272 {not in Vi}
7273 Indicates a fast terminal connection. More characters will be sent to
7274 the screen for redrawing, instead of using insert/delete line
7275 commands. Improves smoothness of redrawing when there are multiple
7276 windows and the terminal does not support a scrolling region.
7277 Also enables the extra writing of characters at the end of each screen
7278 line for lines that wrap. This helps when using copy/paste with the
7279 mouse in an xterm and other terminals.
7280
7281 *'ttymouse'* *'ttym'*
7282'ttymouse' 'ttym' string (default depends on 'term')
7283 global
7284 {not in Vi}
7285 {only in Unix and VMS, doesn't work in the GUI; not
7286 available when compiled without |+mouse|}
7287 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007288 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007289 *xterm-mouse*
7290 xterm xterm-like mouse handling. The mouse generates
7291 "<Esc>[Mscr", where "scr" is three bytes:
7292 "s" = button state
7293 "c" = column plus 33
7294 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007295 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007296 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007297 xterm2 Works like "xterm", but with the xterm reporting the
7298 mouse position while the mouse is dragged. This works
7299 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007300 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007301 work. See below for how Vim detects this
7302 automatically.
7303 *netterm-mouse*
7304 netterm NetTerm mouse handling. The mouse generates
7305 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7306 for the row and column.
7307 *dec-mouse*
7308 dec DEC terminal mouse handling. The mouse generates a
7309 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007310 This is also available for an Xterm, if it was
7311 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007312 *jsbterm-mouse*
7313 jsbterm JSB term mouse handling.
7314 *pterm-mouse*
7315 pterm QNX pterm mouse handling.
7316
7317 The mouse handling must be enabled at compile time |+mouse_xterm|
7318 |+mouse_dec| |+mouse_netterm|.
7319 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7320 recognized, if enabled at compile time. DEC terminal mouse codes
7321 are recognized if enabled at compile time, and 'ttymouse' is not
7322 "xterm" (because the xterm and dec mouse codes conflict).
7323 This option is automatically set to "xterm", when the 'term' option is
7324 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7325 or "xterm2" already. The main use of this option is to set it to
7326 "xterm", when the terminal name doesn't start with "xterm", but it can
7327 handle xterm mouse codes.
7328 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007329 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 feature and if |t_RV| is set to the escape sequence to request the
7331 xterm version number. Otherwise "xterm2" must be set explicitly.
7332 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7333 t_RV to an empty string: >
7334 :set t_RV=
7335<
7336 *'ttyscroll'* *'tsl'*
7337'ttyscroll' 'tsl' number (default 999)
7338 global
7339 Maximum number of lines to scroll the screen. If there are more lines
7340 to scroll the window is redrawn. For terminals where scrolling is
7341 very slow and redrawing is not slow this can be set to a small number,
7342 e.g., 3, to speed up displaying.
7343
7344 *'ttytype'* *'tty'*
7345'ttytype' 'tty' string (default from $TERM)
7346 global
7347 Alias for 'term', see above.
7348
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007349 *'undodir'* *'udir'*
7350'undodir' 'udir' string (default ".")
7351 global
7352 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007353 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007354 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007355 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007356 "." means using the directory of the file. The undo file name for
7357 "file.txt" is ".file.txt.un~".
7358 For other directories the file name is the full path of the edited
7359 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007360 When writing: The first directory that exists is used. "." always
7361 works, no directories after "." will be used for writing.
7362 When reading all entries are tried to find an undo file. The first
7363 undo file that exists is used. When it cannot be read an error is
7364 given, no further entry is used.
7365 See |undo-persistence|.
7366
7367 *'undofile'* *'udf'*
7368'undofile' 'udf' boolean (default off)
7369 local to buffer
7370 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007371 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007372 When on, Vim automatically saves undo history to an undo file when
7373 writing a buffer to a file, and restores undo history from the same
7374 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007375 The directory where the undo file is stored is specified by 'undodir'.
7376 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007377 The undo file is not read when 'undoreload' causes the buffer from
7378 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007379 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007380
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 *'undolevels'* *'ul'*
7382'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7383 Win32 and OS/2)
7384 global
7385 {not in Vi}
7386 Maximum number of changes that can be undone. Since undo information
7387 is kept in memory, higher numbers will cause more memory to be used
7388 (nevertheless, a single change can use an unlimited amount of memory).
7389 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7390 itself: >
7391 set ul=0
7392< But you can also get Vi compatibility by including the 'u' flag in
7393 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007394 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395 Set to a negative number for no undo at all: >
7396 set ul=-1
7397< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007398 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007400 *'undoreload'* *'ur'*
7401'undoreload' 'ur' number (default 10000)
7402 global
7403 {not in Vi}
7404 Save the whole buffer for undo when reloading it. This applies to the
7405 ":e!" command and reloading for when the buffer changed outside of
7406 Vim. |FileChangedShell|
7407 The save only happens when this options is negative or when the number
7408 of lines is smaller than the value of this option.
7409 Set this option to zero to disable undo for a reload.
7410
7411 When saving undo for a reload, any undo file is not read.
7412
7413 Note that this causes the whole buffer to be stored in memory. Set
7414 this option to a lower value if you run out of memory.
7415
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 *'updatecount'* *'uc'*
7417'updatecount' 'uc' number (default: 200)
7418 global
7419 {not in Vi}
7420 After typing this many characters the swap file will be written to
7421 disk. When zero, no swap file will be created at all (see chapter on
7422 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7423 Vim with the "-n" option, see |startup|. When editing in readonly
7424 mode this option will be initialized to 10000.
7425 The swapfile can be disabled per buffer with |'swapfile'|.
7426 When 'updatecount' is set from zero to non-zero, swap files are
7427 created for all buffers that have 'swapfile' set. When 'updatecount'
7428 is set to zero, existing swap files are not deleted.
7429 Also see |'swapsync'|.
7430 This option has no meaning in buffers where |'buftype'| is "nofile"
7431 or "nowrite".
7432
7433 *'updatetime'* *'ut'*
7434'updatetime' 'ut' number (default 4000)
7435 global
7436 {not in Vi}
7437 If this many milliseconds nothing is typed the swap file will be
7438 written to disk (see |crash-recovery|). Also used for the
7439 |CursorHold| autocommand event.
7440
7441 *'verbose'* *'vbs'*
7442'verbose' 'vbs' number (default 0)
7443 global
7444 {not in Vi, although some versions have a boolean
7445 verbose option}
7446 When bigger than zero, Vim will give messages about what it is doing.
7447 Currently, these messages are given:
7448 >= 1 When the viminfo file is read or written.
7449 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007450 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007451 >= 8 Files for which a group of autocommands is executed.
7452 >= 9 Every executed autocommand.
7453 >= 12 Every executed function.
7454 >= 13 When an exception is thrown, caught, finished, or discarded.
7455 >= 14 Anything pending in a ":finally" clause.
7456 >= 15 Every executed Ex command (truncated at 200 characters).
7457
7458 This option can also be set with the "-V" argument. See |-V|.
7459 This option is also set by the |:verbose| command.
7460
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007461 When the 'verbosefile' option is set then the verbose messages are not
7462 displayed.
7463
7464 *'verbosefile'* *'vfile'*
7465'verbosefile' 'vfile' string (default empty)
7466 global
7467 {not in Vi}
7468 When not empty all messages are written in a file with this name.
7469 When the file exists messages are appended.
7470 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007471 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007472 Setting 'verbosefile' to a new value is like making it empty first.
7473 The difference with |:redir| is that verbose messages are not
7474 displayed when 'verbosefile' is set.
7475
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 *'viewdir'* *'vdir'*
7477'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7478 "$VIM/vimfiles/view",
7479 for Unix: "~/.vim/view",
7480 for Macintosh: "$VIM:vimfiles:view"
7481 for VMS: "sys$login:vimfiles/view"
7482 for RiscOS: "Choices:vimfiles/view")
7483 global
7484 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007485 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 feature}
7487 Name of the directory where to store files for |:mkview|.
7488 This option cannot be set from a |modeline| or in the |sandbox|, for
7489 security reasons.
7490
7491 *'viewoptions'* *'vop'*
7492'viewoptions' 'vop' string (default: "folds,options,cursor")
7493 global
7494 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007495 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 feature}
7497 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007498 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007499 word save and restore ~
7500 cursor cursor position in file and in window
7501 folds manually created folds, opened/closed folds and local
7502 fold options
7503 options options and mappings local to a window or buffer (not
7504 global values for local options)
7505 slash backslashes in file names replaced with forward
7506 slashes
7507 unix with Unix end-of-line format (single <NL>), even when
7508 on Windows or DOS
7509
7510 "slash" and "unix" are useful on Windows when sharing view files
7511 with Unix. The Unix version of Vim cannot source dos format scripts,
7512 but the Windows version of Vim can source unix format scripts.
7513
7514 *'viminfo'* *'vi'* *E526* *E527* *E528*
7515'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007516 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7517 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7518 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007519 global
7520 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007521 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007522 feature}
7523 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007524 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007525 separated list of parameters, each consisting of a single character
7526 identifying the particular parameter, followed by a number or string
7527 which specifies the value of that parameter. If a particular
7528 character is left out, then the default value is used for that
7529 parameter. The following is a list of the identifying characters and
7530 the effect of their value.
7531 CHAR VALUE ~
7532 ! When included, save and restore global variables that start
7533 with an uppercase letter, and don't contain a lowercase
7534 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007535 and "_K_L_M" are not. Nested List and Dict items may not be
7536 read back correctly, you end up with a string representation
7537 instead.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 " Maximum number of lines saved for each register. Old name of
7539 the '<' item, with the disadvantage that you need to put a
7540 backslash before the ", otherwise it will be recognized as the
7541 start of a comment!
7542 % When included, save and restore the buffer list. If Vim is
7543 started with a file name argument, the buffer list is not
7544 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007545 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 without a file name and buffers for help files are not written
7547 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007548 When followed by a number, the number specifies the maximum
7549 number of buffers that are stored. Without a number all
7550 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007551 ' Maximum number of previously edited files for which the marks
7552 are remembered. This parameter must always be included when
7553 'viminfo' is non-empty.
7554 Including this item also means that the |jumplist| and the
7555 |changelist| are stored in the viminfo file.
7556 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007557 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007558 patterns are also saved. When not included, the value of
7559 'history' is used.
7560 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007561 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007562 < Maximum number of lines saved for each register. If zero then
7563 registers are not saved. When not included, all lines are
7564 saved. '"' is the old name for this item.
7565 Also see the 's' item below: limit specified in Kbyte.
7566 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007567 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568 c When included, convert the text in the viminfo file from the
7569 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007570 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007571 f Whether file marks need to be stored. If zero, file marks ('0
7572 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007573 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007574 cursor position (when exiting or when doing ":wviminfo").
7575 h Disable the effect of 'hlsearch' when loading the viminfo
7576 file. When not included, it depends on whether ":nohlsearch"
7577 has been used since the last search command.
7578 n Name of the viminfo file. The name must immediately follow
7579 the 'n'. Must be the last one! If the "-i" argument was
7580 given when starting Vim, that file name overrides the one
7581 given here with 'viminfo'. Environment variables are expanded
7582 when opening the file, not when setting the option.
7583 r Removable media. The argument is a string (up to the next
7584 ','). This parameter can be given several times. Each
7585 specifies the start of a path for which no marks will be
7586 stored. This is to avoid removable media. For MS-DOS you
7587 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7588 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7589 ignored. Maximum length of each 'r' argument is 50
7590 characters.
7591 s Maximum size of an item in Kbyte. If zero then registers are
7592 not saved. Currently only applies to registers. The default
7593 "s10" will exclude registers with more than 10 Kbyte of text.
7594 Also see the '<' item above: line count limit.
7595
7596 Example: >
7597 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7598<
7599 '50 Marks will be remembered for the last 50 files you
7600 edited.
7601 <1000 Contents of registers (up to 1000 lines each) will be
7602 remembered.
7603 s100 Registers with more than 100 Kbyte text are skipped.
7604 :0 Command-line history will not be saved.
7605 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7606 no / Since '/' is not specified, the default will be used,
7607 that is, save all of the search history, and also the
7608 previous search and substitute patterns.
7609 no % The buffer list will not be saved nor read back.
7610 no h 'hlsearch' highlighting will be restored.
7611
7612 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7613 load the contents of the file, this is not done automatically.
7614
7615 This option cannot be set from a |modeline| or in the |sandbox|, for
7616 security reasons.
7617
7618 *'virtualedit'* *'ve'*
7619'virtualedit' 've' string (default "")
7620 global
7621 {not in Vi}
7622 {not available when compiled without the
7623 |+virtualedit| feature}
7624 A comma separated list of these words:
7625 block Allow virtual editing in Visual block mode.
7626 insert Allow virtual editing in Insert mode.
7627 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007628 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007629
Bram Moolenaar071d4272004-06-13 20:20:40 +00007630 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007631 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 of the line. Useful for selecting a rectangle in Visual mode and
7633 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007634 "onemore" is not the same, it will only allow moving the cursor just
7635 after the last character of the line. This makes some commands more
7636 consistent. Previously the cursor was always past the end of the line
7637 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007638 break some plugins or Vim scripts. For example because |l| can move
7639 the cursor after the last character. Use with care!
7640 Using the |$| command will move to the last character in the line, not
7641 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007642 It doesn't make sense to combine "all" with "onemore", but you will
7643 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644
7645 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7646'visualbell' 'vb' boolean (default off)
7647 global
7648 {not in Vi}
7649 Use visual bell instead of beeping. The terminal code to display the
7650 visual bell is given with 't_vb'. When no beep or flash is wanted,
7651 use ":set vb t_vb=".
7652 Note: When the GUI starts, 't_vb' is reset to its default value. You
7653 might want to set it again in your |gvimrc|.
7654 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7655 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7656 where 40 is the time in msec.
7657 Does not work on the Amiga, you always get a screen flash.
7658 Also see 'errorbells'.
7659
7660 *'warn'* *'nowarn'*
7661'warn' boolean (default on)
7662 global
7663 Give a warning message when a shell command is used while the buffer
7664 has been changed.
7665
7666 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7667'weirdinvert' 'wiv' boolean (default off)
7668 global
7669 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007670 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 It is provided for backwards compatibility with version 4.x.
7672 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7673 vice versa. Has no effect when the GUI is running.
7674
7675 *'whichwrap'* *'ww'*
7676'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7677 global
7678 {not in Vi}
7679 Allow specified keys that move the cursor left/right to move to the
7680 previous/next line when the cursor is on the first/last character in
7681 the line. Concatenate characters to allow this for these keys:
7682 char key mode ~
7683 b <BS> Normal and Visual
7684 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007685 h "h" Normal and Visual (not recommended)
7686 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007687 < <Left> Normal and Visual
7688 > <Right> Normal and Visual
7689 ~ "~" Normal
7690 [ <Left> Insert and Replace
7691 ] <Right> Insert and Replace
7692 For example: >
7693 :set ww=<,>,[,]
7694< allows wrap only when cursor keys are used.
7695 When the movement keys are used in combination with a delete or change
7696 operator, the <EOL> also counts for a character. This makes "3h"
7697 different from "3dh" when the cursor crosses the end of a line. This
7698 is also true for "x" and "X", because they do the same as "dl" and
7699 "dh". If you use this, you may also want to use the mapping
7700 ":map <BS> X" to make backspace delete the character in front of the
7701 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007702 When 'l' is included and it is used after an operator at the end of a
7703 line then it will not move to the next line. This makes "dl", "cl",
7704 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 NOTE: This option is set to the Vi default value when 'compatible' is
7706 set and to the Vim default value when 'compatible' is reset.
7707
7708 *'wildchar'* *'wc'*
7709'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7710 global
7711 {not in Vi}
7712 Character you have to type to start wildcard expansion in the
7713 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007714 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007715 The character is not recognized when used inside a macro. See
7716 'wildcharm' for that.
7717 Although 'wc' is a number option, you can set it to a special key: >
7718 :set wc=<Esc>
7719< NOTE: This option is set to the Vi default value when 'compatible' is
7720 set and to the Vim default value when 'compatible' is reset.
7721
7722 *'wildcharm'* *'wcm'*
7723'wildcharm' 'wcm' number (default: none (0))
7724 global
7725 {not in Vi}
7726 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007727 recognized when used inside a macro. You can find "spare" command-line
7728 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007729 you'll never actually type 'wildcharm', just use it in mappings that
7730 automatically invoke completion mode, e.g.: >
7731 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007732 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007733< Then after typing :ss you can use CTRL-P & CTRL-N.
7734
7735 *'wildignore'* *'wig'*
7736'wildignore' 'wig' string (default "")
7737 global
7738 {not in Vi}
7739 {not available when compiled without the |+wildignore|
7740 feature}
7741 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007742 patterns is ignored when completing file or directory names, and
7743 influences the result of |expand()|, |glob()| and |globpath()| unless
7744 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007745 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7746 Also see 'suffixes'.
7747 Example: >
7748 :set wildignore=*.o,*.obj
7749< The use of |:set+=| and |:set-=| is preferred when adding or removing
7750 a pattern from the list. This avoids problems when a future version
7751 uses another default.
7752
7753 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7754'wildmenu' 'wmnu' boolean (default off)
7755 global
7756 {not in Vi}
7757 {not available if compiled without the |+wildmenu|
7758 feature}
7759 When 'wildmenu' is on, command-line completion operates in an enhanced
7760 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7761 the possible matches are shown just above the command line, with the
7762 first match highlighted (overwriting the status line, if there is
7763 one). Keys that show the previous/next match, such as <Tab> or
7764 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7765 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7766 specified. "longest" and "list" do not start "wildmenu" mode.
7767 If there are more matches than can fit in the line, a ">" is shown on
7768 the right and/or a "<" is shown on the left. The status line scrolls
7769 as needed.
7770 The "wildmenu" mode is abandoned when a key is hit that is not used
7771 for selecting a completion.
7772 While the "wildmenu" is active the following keys have special
7773 meanings:
7774
7775 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7776 <Down> - in filename/menu name completion: move into a
7777 subdirectory or submenu.
7778 <CR> - in menu completion, when the cursor is just after a
7779 dot: move into a submenu.
7780 <Up> - in filename/menu name completion: move up into
7781 parent directory or parent menu.
7782
7783 This makes the menus accessible from the console |console-menus|.
7784
7785 If you prefer the <Left> and <Right> keys to move the cursor instead
7786 of selecting a different match, use this: >
7787 :cnoremap <Left> <Space><BS><Left>
7788 :cnoremap <Right> <Space><BS><Right>
7789<
7790 The "WildMenu" highlighting is used for displaying the current match
7791 |hl-WildMenu|.
7792
7793 *'wildmode'* *'wim'*
7794'wildmode' 'wim' string (Vim default: "full")
7795 global
7796 {not in Vi}
7797 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007798 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007799 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 first part specifies the behavior for the first use of 'wildchar',
7801 The second part for the second use, etc.
7802 These are the possible values for each part:
7803 "" Complete only the first match.
7804 "full" Complete the next full match. After the last match,
7805 the original string is used and then the first match
7806 again.
7807 "longest" Complete till longest common string. If this doesn't
7808 result in a longer string, use the next part.
7809 "longest:full" Like "longest", but also start 'wildmenu' if it is
7810 enabled.
7811 "list" When more than one match, list all matches.
7812 "list:full" When more than one match, list all matches and
7813 complete first match.
7814 "list:longest" When more than one match, list all matches and
7815 complete till longest common string.
7816 When there is only a single match, it is fully completed in all cases.
7817
7818 Examples: >
7819 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007820< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007821 :set wildmode=longest,full
7822< Complete longest common string, then each full match >
7823 :set wildmode=list:full
7824< List all matches and complete each full match >
7825 :set wildmode=list,full
7826< List all matches without completing, then each full match >
7827 :set wildmode=longest,list
7828< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007829 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007831 *'wildoptions'* *'wop'*
7832'wildoptions' 'wop' string (default "")
7833 global
7834 {not in Vi}
7835 {not available when compiled without the |+wildignore|
7836 feature}
7837 A list of words that change how command line completion is done.
7838 Currently only one word is allowed:
7839 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007840 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007841 is displayed per line. Often used tag kinds are:
7842 d #define
7843 f function
7844 Also see |cmdline-completion|.
7845
Bram Moolenaar071d4272004-06-13 20:20:40 +00007846 *'winaltkeys'* *'wak'*
7847'winaltkeys' 'wak' string (default "menu")
7848 global
7849 {not in Vi}
7850 {only used in Win32, Motif, GTK and Photon GUI}
7851 Some GUI versions allow the access to menu entries by using the ALT
7852 key in combination with a character that appears underlined in the
7853 menu. This conflicts with the use of the ALT key for mappings and
7854 entering special characters. This option tells what to do:
7855 no Don't use ALT keys for menus. ALT key combinations can be
7856 mapped, but there is no automatic handling. This can then be
7857 done with the |:simalt| command.
7858 yes ALT key handling is done by the windowing system. ALT key
7859 combinations cannot be mapped.
7860 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007861 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007862 keys can be mapped.
7863 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7864 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007865 This option is not used for <F10>; on Win32 and with GTK <F10> will
7866 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007868 *'window'* *'wi'*
7869'window' 'wi' number (default screen height - 1)
7870 global
7871 Window height. Do not confuse this with the height of the Vim window,
7872 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007873 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7874 value is smaller than 'lines' minus one. The screen will scroll
7875 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007876 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7877 in a much smarter way, taking care of wrapping lines.
7878 When resizing the Vim window, the value is smaller than 1 or more than
7879 or equal to 'lines' it will be set to 'lines' minus 1.
7880 {Vi also uses the option to specify the number of displayed lines}
7881
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 *'winheight'* *'wh'* *E591*
7883'winheight' 'wh' number (default 1)
7884 global
7885 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007886 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 feature}
7888 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007889 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007890 focus goes to a window that is smaller, its size is increased, at the
7891 cost of the height of other windows.
7892 Set 'winheight' to a small number for normal editing.
7893 Set it to 999 to make the current window fill most of the screen.
7894 Other windows will be only 'winminheight' high. This has the drawback
7895 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7896 to create only two windows, set the option after startup is done,
7897 using the |VimEnter| event: >
7898 au VimEnter * set winheight=999
7899< Minimum value is 1.
7900 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007901 height of the current window.
7902 'winheight' applies to the current window. Use 'winminheight' to set
7903 the minimal height for other windows.
7904
7905 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7906'winfixheight' 'wfh' boolean (default off)
7907 local to window
7908 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007909 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007910 feature}
7911 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007912 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7913 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 The height may be changed anyway when running out of room.
7915
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007916 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7917'winfixwidth' 'wfw' boolean (default off)
7918 local to window
7919 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007920 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007921 feature}
7922 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007923 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007924 The width may be changed anyway when running out of room.
7925
Bram Moolenaar071d4272004-06-13 20:20:40 +00007926 *'winminheight'* *'wmh'*
7927'winminheight' 'wmh' number (default 1)
7928 global
7929 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007930 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007931 feature}
7932 The minimal height of a window, when it's not the current window.
7933 This is a hard minimum, windows will never become smaller.
7934 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7935 status bar) if necessary. They will return to at least one line when
7936 they become active (since the cursor has to have somewhere to go.)
7937 Use 'winheight' to set the minimal height of the current window.
7938 This option is only checked when making a window smaller. Don't use a
7939 large number, it will cause errors when opening more than a few
7940 windows. A value of 0 to 3 is reasonable.
7941
7942 *'winminwidth'* *'wmw'*
7943'winminwidth' 'wmw' number (default 1)
7944 global
7945 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007946 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 feature}
7948 The minimal width of a window, when it's not the current window.
7949 This is a hard minimum, windows will never become smaller.
7950 When set to zero, windows may be "squashed" to zero columns (i.e. just
7951 a vertical separator) if necessary. They will return to at least one
7952 line when they become active (since the cursor has to have somewhere
7953 to go.)
7954 Use 'winwidth' to set the minimal width of the current window.
7955 This option is only checked when making a window smaller. Don't use a
7956 large number, it will cause errors when opening more than a few
7957 windows. A value of 0 to 12 is reasonable.
7958
7959 *'winwidth'* *'wiw'* *E592*
7960'winwidth' 'wiw' number (default 20)
7961 global
7962 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007963 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007964 feature}
7965 Minimal number of columns for the current window. This is not a hard
7966 minimum, Vim will use fewer columns if there is not enough room. If
7967 the current window is smaller, its size is increased, at the cost of
7968 the width of other windows. Set it to 999 to make the current window
7969 always fill the screen. Set it to a small number for normal editing.
7970 The width is not adjusted after one of the commands to change the
7971 width of the current window.
7972 'winwidth' applies to the current window. Use 'winminwidth' to set
7973 the minimal width for other windows.
7974
7975 *'wrap'* *'nowrap'*
7976'wrap' boolean (default on)
7977 local to window
7978 {not in Vi}
7979 This option changes how text is displayed. It doesn't change the text
7980 in the buffer, see 'textwidth' for that.
7981 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007982 displaying continues on the next line. When off lines will not wrap
7983 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00007984 moved to a part that is not shown, the screen will scroll
7985 horizontally.
7986 The line will be broken in the middle of a word if necessary. See
7987 'linebreak' to get the break at a word boundary.
7988 To make scrolling horizontally a bit more useful, try this: >
7989 :set sidescroll=5
7990 :set listchars+=precedes:<,extends:>
7991< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007992 This option can't be set from a |modeline| when the 'diff' option is
7993 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994
7995 *'wrapmargin'* *'wm'*
7996'wrapmargin' 'wm' number (default 0)
7997 local to buffer
7998 Number of characters from the right window border where wrapping
7999 starts. When typing text beyond this limit, an <EOL> will be inserted
8000 and inserting continues on the next line.
8001 Options that add a margin, such as 'number' and 'foldcolumn', cause
8002 the text width to be further reduced. This is Vi compatible.
8003 When 'textwidth' is non-zero, this option is not used.
8004 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8005 and less usefully}
8006
8007 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8008'wrapscan' 'ws' boolean (default on) *E384* *E385*
8009 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008010 Searches wrap around the end of the file. Also applies to |]s| and
8011 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008012
8013 *'write'* *'nowrite'*
8014'write' boolean (default on)
8015 global
8016 {not in Vi}
8017 Allows writing files. When not set, writing a file is not allowed.
8018 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008019 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 argument. Filtering text is still possible, even though this requires
8021 writing a temporary file.
8022
8023 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8024'writeany' 'wa' boolean (default off)
8025 global
8026 Allows writing to any file with no need for "!" override.
8027
8028 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8029'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8030 otherwise)
8031 global
8032 {not in Vi}
8033 Make a backup before overwriting a file. The backup is removed after
8034 the file was successfully written, unless the 'backup' option is
8035 also on. Reset this option if your file system is almost full. See
8036 |backup-table| for another explanation.
8037 When the 'backupskip' pattern matches, a backup is not made anyway.
8038 NOTE: This option is set to the default value when 'compatible' is
8039 set.
8040
8041 *'writedelay'* *'wd'*
8042'writedelay' 'wd' number (default 0)
8043 global
8044 {not in Vi}
8045 The number of microseconds to wait for each character sent to the
8046 screen. When non-zero, characters are sent to the terminal one by
8047 one. For MS-DOS pcterm this does not work. For debugging purposes.
8048
8049 vim:tw=78:ts=8:ft=help:norl: