blob: 4b5df2d689055e22d200a04096ef84e4107c89f4 [file] [log] [blame]
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01001*options.txt* For Vim version 7.3. Last change: 2010 Dec 11
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
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001437 unnamedplus A variant of "unnamed" flag which uses the clipboard
1438 register '+' (|quoteplus|) instead of register '*' for
1439 all operations except yank. Yank shall copy the text
1440 into register '+' and also into '*' when "unnamed" is
1441 included.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001442 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001443 Availability can be checked with: >
1444 if has('unnamedplus')
1445<
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 autoselect Works like the 'a' flag in 'guioptions': If present,
1447 then whenever Visual mode is started, or the Visual
1448 area extended, Vim tries to become the owner of the
1449 windowing system's global selection or put the
1450 selected text on the clipboard used by the selection
1451 register "*. See |guioptions_a| and |quotestar| for
1452 details. When the GUI is active, the 'a' flag in
1453 'guioptions' is used, when the GUI is not active, this
1454 "autoselect" flag is used.
1455 Also applies to the modeless selection.
1456
1457 autoselectml Like "autoselect", but for the modeless selection
1458 only. Compare to the 'A' flag in 'guioptions'.
1459
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001460 html When the clipboard contains HTML, use this when
1461 pasting. When putting text on the clipboard, mark it
1462 as HTML. This works to copy rendered HTML from
1463 Firefox, paste it as raw HTML in Vim, select the HTML
1464 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001465 You probably want to add this only temporarily,
1466 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001467 Only supported for GTK version 2 and later.
1468 Only available with the |+multi_byte| feature.
1469
Bram Moolenaar071d4272004-06-13 20:20:40 +00001470 exclude:{pattern}
1471 Defines a pattern that is matched against the name of
1472 the terminal 'term'. If there is a match, no
1473 connection will be made to the X server. This is
1474 useful in this situation:
1475 - Running Vim in a console.
1476 - $DISPLAY is set to start applications on another
1477 display.
1478 - You do not want to connect to the X server in the
1479 console, but do want this in a terminal emulator.
1480 To never connect to the X server use: >
1481 exclude:.*
1482< This has the same effect as using the |-X| argument.
1483 Note that when there is no connection to the X server
1484 the window title won't be restored and the clipboard
1485 cannot be accessed.
1486 The value of 'magic' is ignored, {pattern} is
1487 interpreted as if 'magic' was on.
1488 The rest of the option value will be used for
1489 {pattern}, this must be the last entry.
1490
1491 *'cmdheight'* *'ch'*
1492'cmdheight' 'ch' number (default 1)
1493 global
1494 {not in Vi}
1495 Number of screen lines to use for the command-line. Helps avoiding
1496 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001497 The value of this option is stored with the tab page, so that each tab
1498 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001499
1500 *'cmdwinheight'* *'cwh'*
1501'cmdwinheight' 'cwh' number (default 7)
1502 global
1503 {not in Vi}
1504 {not available when compiled without the |+vertsplit|
1505 feature}
1506 Number of screen lines to use for the command-line window. |cmdwin|
1507
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001508 *'colorcolumn'* *'cc'*
1509'colorcolumn' 'cc' string (default "")
1510 local to window
1511 {not in Vi}
1512 {not available when compiled without the |+syntax|
1513 feature}
1514 'colorcolumn' is a comma separated list of screen columns that are
1515 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1516 text. Will make screen redrawing slower.
1517 The screen column can be an absolute number, or a number preceded with
1518 '+' or '-', which is added to or subtracted from 'textwidth'. >
1519
1520 :set cc=+1 " highlight column after 'textwidth'
1521 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1522 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1523<
1524 When 'textwidth' is zero then the items with '-' and '+' are not used.
1525 A maximum of 256 columns are highlighted.
1526
Bram Moolenaar071d4272004-06-13 20:20:40 +00001527 *'columns'* *'co'* *E594*
1528'columns' 'co' number (default 80 or terminal width)
1529 global
1530 {not in Vi}
1531 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001532 initialization and does not have to be set by hand. Also see
1533 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001534 When Vim is running in the GUI or in a resizable window, setting this
1535 option will cause the window size to be changed. When you only want
1536 to use the size for the GUI, put the command in your |gvimrc| file.
1537 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001538 number of columns of the display, the display may be messed up. For
1539 the GUI it is always possible and Vim limits the number of columns to
1540 what fits on the screen. You can use this command to get the widest
1541 window possible: >
1542 :set columns=9999
1543< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001544
1545 *'comments'* *'com'* *E524* *E525*
1546'comments' 'com' string (default
1547 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1548 local to buffer
1549 {not in Vi}
1550 {not available when compiled without the |+comments|
1551 feature}
1552 A comma separated list of strings that can start a comment line. See
1553 |format-comments|. See |option-backslash| about using backslashes to
1554 insert a space.
1555
1556 *'commentstring'* *'cms'* *E537*
1557'commentstring' 'cms' string (default "/*%s*/")
1558 local to buffer
1559 {not in Vi}
1560 {not available when compiled without the |+folding|
1561 feature}
1562 A template for a comment. The "%s" in the value is replaced with the
1563 comment text. Currently only used to add markers for folding, see
1564 |fold-marker|.
1565
1566 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001567'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
1568 file is found)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001569 global
1570 {not in Vi}
1571 This option has the effect of making Vim either more Vi-compatible, or
1572 make Vim behave in a more useful way.
1573 This is a special kind of option, because when it's set or reset,
1574 other options are also changed as a side effect. CAREFUL: Setting or
1575 resetting this option can have a lot of unexpected effects: Mappings
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001576 are interpreted in another way, undo behaves differently, etc. If you
Bram Moolenaar071d4272004-06-13 20:20:40 +00001577 set this option in your vimrc file, you should probably put it at the
1578 very start.
1579 By default this option is on and the Vi defaults are used for the
1580 options. This default was chosen for those people who want to use Vim
1581 just like Vi, and don't even (want to) know about the 'compatible'
1582 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001583 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001584 this option is switched off, and all options that have not been
1585 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001586 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001587 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001588 happen for the system-wide vimrc or gvimrc file, nor for a file given
1589 with the |-u| argument). Also see |compatible-default| and
1590 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 You can also set this option with the "-C" argument, and reset it with
1592 "-N". See |-C| and |-N|.
1593 Switching this option off makes the Vim defaults be used for options
1594 that have a different Vi and Vim default value. See the options
1595 marked with a '+' below. Other options are not modified.
1596 At the moment this option is set, several other options will be set
1597 or reset to make Vim as Vi-compatible as possible. See the table
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001598 below. This can be used if you want to revert to Vi compatible
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 editing.
1600 See also 'cpoptions'.
1601
1602 option + set value effect ~
1603
1604 'allowrevins' off no CTRL-_ command
1605 'backupcopy' Unix: "yes" backup file is a copy
1606 others: "auto" copy or rename backup file
1607 'backspace' "" normal backspace
1608 'backup' off no backup file
1609 'cindent' off no C code indentation
1610 'cedit' + "" no key to open the |cmdwin|
1611 'cpoptions' + (all flags) Vi-compatible flags
1612 'cscopetag' off don't use cscope for ":tag"
1613 'cscopetagorder' 0 see |cscopetagorder|
1614 'cscopeverbose' off see |cscopeverbose|
1615 'digraph' off no digraphs
1616 'esckeys' + off no <Esc>-keys in Insert mode
1617 'expandtab' off tabs not expanded to spaces
1618 'fileformats' + "" no automatic file format detection,
1619 "dos,unix" except for DOS, Windows and OS/2
1620 'formatoptions' + "vt" Vi compatible formatting
1621 'gdefault' off no default 'g' flag for ":s"
1622 'history' + 0 no commandline history
1623 'hkmap' off no Hebrew keyboard mapping
1624 'hkmapp' off no phonetic Hebrew keyboard mapping
1625 'hlsearch' off no highlighting of search matches
1626 'incsearch' off no incremental searching
1627 'indentexpr' "" no indenting by expression
1628 'insertmode' off do not start in Insert mode
1629 'iskeyword' + "@,48-57,_" keywords contain alphanumeric
1630 characters and '_'
1631 'joinspaces' on insert 2 spaces after period
1632 'modeline' + off no modelines
1633 'more' + off no pauses in listings
1634 'revins' off no reverse insert
1635 'ruler' off no ruler
1636 'scrolljump' 1 no jump scroll
1637 'scrolloff' 0 no scroll offset
1638 'shiftround' off indent not rounded to shiftwidth
1639 'shortmess' + "" no shortening of messages
1640 'showcmd' + off command characters not shown
1641 'showmode' + off current mode not shown
1642 'smartcase' off no automatic ignore case switch
1643 'smartindent' off no smart indentation
1644 'smarttab' off no smart tab size
1645 'softtabstop' 0 tabs are always 'tabstop' positions
1646 'startofline' on goto startofline with some commands
1647 'tagrelative' + off tag file names are not relative
1648 'textauto' + off no automatic textmode detection
1649 'textwidth' 0 no automatic line wrap
1650 'tildeop' off tilde is not an operator
1651 'ttimeout' off no terminal timeout
1652 'whichwrap' + "" left-right movements don't wrap
1653 'wildchar' + CTRL-E only when the current value is <Tab>
1654 use CTRL-E for cmdline completion
Bram Moolenaardb84e452010-08-15 13:50:43 +02001655 'writebackup' on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001656
1657 *'complete'* *'cpt'* *E535*
1658'complete' 'cpt' string (default: ".,w,b,u,t,i")
1659 local to buffer
1660 {not in Vi}
1661 This option specifies how keyword completion |ins-completion| works
1662 when CTRL-P or CTRL-N are used. It is also used for whole-line
1663 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1664 and the places to scan. It is a comma separated list of flags:
1665 . scan the current buffer ('wrapscan' is ignored)
1666 w scan buffers from other windows
1667 b scan other loaded buffers that are in the buffer list
1668 u scan the unloaded buffers that are in the buffer list
1669 U scan the buffers that are not in the buffer list
1670 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001671 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001672 k{dict} scan the file {dict}. Several "k" flags can be given,
1673 patterns are valid too. For example: >
1674 :set cpt=k/usr/dict/*,k~/spanish
1675< s scan the files given with the 'thesaurus' option
1676 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1677 are valid too.
1678 i scan current and included files
1679 d scan current and included files for defined name or macro
1680 |i_CTRL-X_CTRL-D|
1681 ] tag completion
1682 t same as "]"
1683
1684 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1685 not executed, this may lead to unexpected completions from some files
1686 (gzipped files for example). Unloaded buffers are not scanned for
1687 whole-line completion.
1688
1689 The default is ".,w,b,u,t,i", which means to scan:
1690 1. the current buffer
1691 2. buffers in other windows
1692 3. other loaded buffers
1693 4. unloaded buffers
1694 5. tags
1695 6. included files
1696
1697 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001698 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1699 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001700
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001701 *'completefunc'* *'cfu'*
1702'completefunc' 'cfu' string (default: empty)
1703 local to buffer
1704 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02001705 {not available when compiled without the |+eval|
1706 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001707 This option specifies a function to be used for Insert mode completion
1708 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001709 See |complete-functions| for an explanation of how the function is
1710 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001711 This option cannot be set from a |modeline| or in the |sandbox|, for
1712 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001713
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001714 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001715'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001716 global
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00001717 {not available when compiled without the
1718 |+insert_expand| feature}
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001719 {not in Vi}
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001720 A comma separated list of options for Insert mode completion
1721 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001722
1723 menu Use a popup menu to show the possible completions. The
1724 menu is only shown when there is more than one match and
1725 sufficient colors are available. |ins-completion-menu|
1726
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001727 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001728 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001729 match, e.g., what file it comes from.
1730
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001731 longest Only insert the longest common text of the matches. If
1732 the menu is displayed you can use CTRL-L to add more
1733 characters. Whether case is ignored depends on the kind
1734 of completion. For buffer text the 'ignorecase' option is
1735 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001736
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001737 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001738 completion in the preview window. Only works in
1739 combination with "menu" or "menuone".
1740
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001741
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001742 *'concealcursor'* *'cocu'*
1743'concealcursor' 'cocu' string (default: "")
1744 local to window
1745 {not in Vi}
1746 {not available when compiled without the |+conceal|
1747 feature}
1748 Sets the modes in which text in the cursor line can also be concealed.
1749 When the current mode is listed then concealing happens just like in
1750 other lines.
1751 n Normal mode
1752 v Visual mode
1753 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001754 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001755
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001756 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001757 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001758 are moving around text is concealed, but when starting to insert text
1759 or selecting a Visual area the concealed text is displayed, so that
1760 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001761 Keep in mind that the cursor position is not always where it's
1762 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001763
1764
1765'conceallevel' 'cole' *'conceallevel'* *'cole'*
Bram Moolenaar860cae12010-06-05 23:22:07 +02001766 number (default 0)
1767 local to window
1768 {not in Vi}
1769 {not available when compiled without the |+conceal|
1770 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001771 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1772 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001773
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001774 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001775 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001776 1 Each block of concealed text is replaced with one
1777 character. If the syntax item does not have a custom
1778 replacement character defined (see |:syn-cchar|) the
1779 character defined in 'listchars' is used (default is a
1780 space).
1781 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001782 2 Concealed text is completely hidden unless it has a
1783 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001784 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001785 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001786
Bram Moolenaara7781e02010-07-19 20:13:22 +02001787 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001788 edit and copy the text. This can be changed with the 'concealcursor'
1789 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001790
Bram Moolenaar071d4272004-06-13 20:20:40 +00001791 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1792'confirm' 'cf' boolean (default off)
1793 global
1794 {not in Vi}
1795 When 'confirm' is on, certain operations that would normally
1796 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1797 instead raise a |dialog| asking if you wish to save the current
1798 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1799 If 'confirm' is off you can still activate confirmation for one
1800 command only (this is most useful in mappings) with the |:confirm|
1801 command.
1802 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
1803
1804 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
1805'conskey' 'consk' boolean (default off)
1806 global
1807 {not in Vi} {only for MS-DOS}
1808 When on direct console I/O is used to obtain a keyboard character.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001809 This should work in most cases. Also see |'bioskey'|. Together,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001810 three methods of console input are available:
1811 'conskey' 'bioskey' action ~
1812 on on or off direct console input
1813 off on BIOS
1814 off off STDIN
1815
1816 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
1817'copyindent' 'ci' boolean (default off)
1818 local to buffer
1819 {not in Vi}
1820 Copy the structure of the existing lines indent when autoindenting a
1821 new line. Normally the new indent is reconstructed by a series of
1822 tabs followed by spaces as required (unless |'expandtab'| is enabled,
1823 in which case only spaces are used). Enabling this option makes the
1824 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00001825 existing line. 'expandtab' has no effect on these characters, a Tab
1826 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 line, the remaining space is filled in the normal manner.
1828 NOTE: 'copyindent' is reset when 'compatible' is set.
1829 Also see 'preserveindent'.
1830
1831 *'cpoptions'* *'cpo'*
1832'cpoptions' 'cpo' string (Vim default: "aABceFs",
1833 Vi default: all flags)
1834 global
1835 {not in Vi}
1836 A sequence of single character flags. When a character is present
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001837 this indicates vi-compatible behavior. This is used for things where
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 not being vi-compatible is mostly or sometimes preferred.
1839 'cpoptions' stands for "compatible-options".
1840 Commas can be added for readability.
1841 To avoid problems with flags that are added in the future, use the
1842 "+=" and "-=" feature of ":set" |add-option-flags|.
1843 NOTE: This option is set to the Vi default value when 'compatible' is
1844 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001845 NOTE: This option is set to the POSIX default value at startup when
1846 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001847 variable exists |posix|. This means Vim tries to behave like the
1848 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001849
1850 contains behavior ~
1851 *cpo-a*
1852 a When included, a ":read" command with a file name
1853 argument will set the alternate file name for the
1854 current window.
1855 *cpo-A*
1856 A When included, a ":write" command with a file name
1857 argument will set the alternate file name for the
1858 current window.
1859 *cpo-b*
1860 b "\|" in a ":map" command is recognized as the end of
1861 the map command. The '\' is included in the mapping,
1862 the text after the '|' is interpreted as the next
1863 command. Use a CTRL-V instead of a backslash to
1864 include the '|' in the mapping. Applies to all
1865 mapping, abbreviation, menu and autocmd commands.
1866 See also |map_bar|.
1867 *cpo-B*
1868 B A backslash has no special meaning in mappings,
1869 abbreviations and the "to" part of the menu commands.
1870 Remove this flag to be able to use a backslash like a
1871 CTRL-V. For example, the command ":map X \<Esc>"
1872 results in X being mapped to:
1873 'B' included: "\^[" (^[ is a real <Esc>)
1874 'B' excluded: "<Esc>" (5 characters)
1875 ('<' excluded in both cases)
1876 *cpo-c*
1877 c Searching continues at the end of any match at the
1878 cursor position, but not further than the start of the
1879 next line. When not present searching continues
1880 one character from the cursor position. With 'c'
1881 "abababababab" only gets three matches when repeating
1882 "/abab", without 'c' there are five matches.
1883 *cpo-C*
1884 C Do not concatenate sourced lines that start with a
1885 backslash. See |line-continuation|.
1886 *cpo-d*
1887 d Using "./" in the 'tags' option doesn't mean to use
1888 the tags file relative to the current file, but the
1889 tags file in the current directory.
1890 *cpo-D*
1891 D Can't use CTRL-K to enter a digraph after Normal mode
1892 commands with a character argument, like |r|, |f| and
1893 |t|.
1894 *cpo-e*
1895 e When executing a register with ":@r", always add a
1896 <CR> to the last line, also when the register is not
1897 linewise. If this flag is not present, the register
1898 is not linewise and the last line does not end in a
1899 <CR>, then the last line is put on the command-line
1900 and can be edited before hitting <CR>.
1901 *cpo-E*
1902 E It is an error when using "y", "d", "c", "g~", "gu" or
1903 "gU" on an Empty region. The operators only work when
1904 at least one character is to be operate on. Example:
1905 This makes "y0" fail in the first column.
1906 *cpo-f*
1907 f When included, a ":read" command with a file name
1908 argument will set the file name for the current buffer,
1909 if the current buffer doesn't have a file name yet.
1910 *cpo-F*
1911 F When included, a ":write" command with a file name
1912 argument will set the file name for the current
1913 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00001914 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001915 *cpo-g*
1916 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001917 *cpo-H*
1918 H When using "I" on a line with only blanks, insert
1919 before the last blank. Without this flag insert after
1920 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001921 *cpo-i*
1922 i When included, interrupting the reading of a file will
1923 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00001924 *cpo-I*
1925 I When moving the cursor up or down just after inserting
1926 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001927 *cpo-j*
1928 j When joining lines, only add two spaces after a '.',
1929 not after '!' or '?'. Also see 'joinspaces'.
1930 *cpo-J*
1931 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00001932 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00001933 white space.
1934 *cpo-k*
1935 k Disable the recognition of raw key codes in
1936 mappings, abbreviations, and the "to" part of menu
1937 commands. For example, if <Key> sends ^[OA (where ^[
1938 is <Esc>), the command ":map X ^[OA" results in X
1939 being mapped to:
1940 'k' included: "^[OA" (3 characters)
1941 'k' excluded: "<Key>" (one key code)
1942 Also see the '<' flag below.
1943 *cpo-K*
1944 K Don't wait for a key code to complete when it is
1945 halfway a mapping. This breaks mapping <F1><F1> when
1946 only part of the second <F1> has been read. It
1947 enables cancelling the mapping by typing <F1><Esc>.
1948 *cpo-l*
1949 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001950 literally, only "\]", "\^", "\-" and "\\" are special.
1951 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001952 'l' included: "/[ \t]" finds <Space>, '\' and 't'
1953 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00001954 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001955 *cpo-L*
1956 L When the 'list' option is set, 'wrapmargin',
1957 'textwidth', 'softtabstop' and Virtual Replace mode
1958 (see |gR|) count a <Tab> as two characters, instead of
1959 the normal behavior of a <Tab>.
1960 *cpo-m*
1961 m When included, a showmatch will always wait half a
1962 second. When not included, a showmatch will wait half
1963 a second or until a character is typed. |'showmatch'|
1964 *cpo-M*
1965 M When excluded, "%" matching will take backslashes into
1966 account. Thus in "( \( )" and "\( ( \)" the outer
1967 parenthesis match. When included "%" ignores
1968 backslashes, which is Vi compatible.
1969 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02001970 n When included, the column used for 'number' and
1971 'relativenumber' will also be used for text of wrapped
1972 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001973 *cpo-o*
1974 o Line offset to search command is not remembered for
1975 next search.
1976 *cpo-O*
1977 O Don't complain if a file is being overwritten, even
1978 when it didn't exist when editing it. This is a
1979 protection against a file unexpectedly created by
1980 someone else. Vi didn't complain about this.
1981 *cpo-p*
1982 p Vi compatible Lisp indenting. When not present, a
1983 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00001984 *cpo-P*
1985 P When included, a ":write" command that appends to a
1986 file will set the file name for the current buffer, if
1987 the current buffer doesn't have a file name yet and
1988 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00001989 *cpo-q*
1990 q When joining multiple lines leave the cursor at the
1991 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 *cpo-r*
1993 r Redo ("." command) uses "/" to repeat a search
1994 command, instead of the actually used search string.
1995 *cpo-R*
1996 R Remove marks from filtered lines. Without this flag
1997 marks are kept like |:keepmarks| was used.
1998 *cpo-s*
1999 s Set buffer options when entering the buffer for the
2000 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002001 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002002 set when the buffer is created.
2003 *cpo-S*
2004 S Set buffer options always when entering a buffer
2005 (except 'readonly', 'fileformat', 'filetype' and
2006 'syntax'). This is the (most) Vi compatible setting.
2007 The options are set to the values in the current
2008 buffer. When you change an option and go to another
2009 buffer, the value is copied. Effectively makes the
2010 buffer options global to all buffers.
2011
2012 's' 'S' copy buffer options
2013 no no when buffer created
2014 yes no when buffer first entered (default)
2015 X yes each time when buffer entered (vi comp.)
2016 *cpo-t*
2017 t Search pattern for the tag command is remembered for
2018 "n" command. Otherwise Vim only puts the pattern in
2019 the history for search pattern, but doesn't change the
2020 last used search pattern.
2021 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002022 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 *cpo-v*
2024 v Backspaced characters remain visible on the screen in
2025 Insert mode. Without this flag the characters are
2026 erased from the screen right away. With this flag the
2027 screen newly typed text overwrites backspaced
2028 characters.
2029 *cpo-w*
2030 w When using "cw" on a blank character, only change one
2031 character and not all blanks until the start of the
2032 next word.
2033 *cpo-W*
2034 W Don't overwrite a readonly file. When omitted, ":w!"
2035 overwrites a readonly file, if possible.
2036 *cpo-x*
2037 x <Esc> on the command-line executes the command-line.
2038 The default in Vim is to abandon the command-line,
2039 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040 *cpo-X*
2041 X When using a count with "R" the replaced text is
2042 deleted only once. Also when repeating "R" with "."
2043 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044 *cpo-y*
2045 y A yank command can be redone with ".".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002046 *cpo-Z*
2047 Z When using "w!" while the 'readonly' option is set,
2048 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002049 *cpo-!*
2050 ! When redoing a filter command, use the last used
2051 external command, whatever it was. Otherwise the last
2052 used -filter- command is used.
2053 *cpo-$*
2054 $ When making a change to one line, don't redisplay the
2055 line, but put a '$' at the end of the changed text.
2056 The changed text will be overwritten when you type the
2057 new text. The line is redisplayed if you type any
2058 command that moves the cursor from the insertion
2059 point.
2060 *cpo-%*
2061 % Vi-compatible matching is done for the "%" command.
2062 Does not recognize "#if", "#endif", etc.
2063 Does not recognize "/*" and "*/".
2064 Parens inside single and double quotes are also
2065 counted, causing a string that contains a paren to
2066 disturb the matching. For example, in a line like
2067 "if (strcmp("foo(", s))" the first paren does not
2068 match the last one. When this flag is not included,
2069 parens inside single and double quotes are treated
2070 specially. When matching a paren outside of quotes,
2071 everything inside quotes is ignored. When matching a
2072 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002073 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002074 This flag is also used for other features, such as
2075 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002076 *cpo--*
2077 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002078 it would go above the first line or below the last
2079 line. Without it the cursor moves to the first or
2080 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002081 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002082 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002083 *cpo-+*
2084 + When included, a ":write file" command will reset the
2085 'modified' flag of the buffer, even though the buffer
2086 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002087 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002088 * Use ":*" in the same way as ":@". When not included,
2089 ":*" is an alias for ":'<,'>", select the Visual area.
2090 *cpo-<*
2091 < Disable the recognition of special key codes in |<>|
2092 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002093 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002094 ":map X <Tab>" results in X being mapped to:
2095 '<' included: "<Tab>" (5 characters)
2096 '<' excluded: "^I" (^I is a real <Tab>)
2097 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002098 *cpo->*
2099 > When appending to a register, put a line break before
2100 the appended text.
2101
2102 POSIX flags. These are not included in the Vi default value, except
2103 when $VIM_POSIX was set on startup. |posix|
2104
2105 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002106 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002107 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002108 *cpo-&*
2109 & When ":preserve" was used keep the swap file when
2110 exiting normally while this buffer is still loaded.
2111 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002112 *cpo-\*
2113 \ Backslash in a [] range in a search pattern is taken
2114 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002115 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2116 '\' excluded: "/[ \-]" finds <Space> and '-'
2117 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002118 *cpo-/*
2119 / When "%" is used as the replacement string in a |:s|
2120 command, use the previous replacement string. |:s%|
2121 *cpo-{*
2122 { The |{| and |}| commands also stop at a "{" character
2123 at the start of a line.
2124 *cpo-.*
2125 . The ":chdir" and ":cd" commands fail if the current
2126 buffer is modified, unless ! is used. Vim doesn't
2127 need this, since it remembers the full path of an
2128 opened file.
2129 *cpo-bar*
2130 | The value of the $LINES and $COLUMNS environment
2131 variables overrule the terminal size values obtained
2132 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002133
Bram Moolenaar071d4272004-06-13 20:20:40 +00002134
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002135 *'cryptmethod'* *'cm'*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002136'cryptmethod' string (default "zip")
2137 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002138 {not in Vi}
2139 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002140 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002141 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002142 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002143 *blowfish*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002144 blowfish Blowfish method. Strong encryption. Requires Vim 7.3
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002145 or later, files can NOT be read by Vim 7.2 and older.
2146 This adds a "seed" to the file, every time you write
2147 the file the encrypted bytes will be different.
2148
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002149 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002150 to the detected method of the file being read. Thus if you write it
2151 without changing 'cryptmethod' the same method will be used.
2152 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002153 explicitly write it, you don't get a warning unless there are other
2154 modifications. Also see |:X|.
2155
2156 When setting the global value to an empty string, it will end up with
2157 the value "zip". When setting the local value to an empty string the
2158 buffer will use the global value.
2159
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002160 When a new encryption method is added in a later version of Vim, and
2161 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002162 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002163
2164
Bram Moolenaar071d4272004-06-13 20:20:40 +00002165 *'cscopepathcomp'* *'cspc'*
2166'cscopepathcomp' 'cspc' number (default 0)
2167 global
2168 {not available when compiled without the |+cscope|
2169 feature}
2170 {not in Vi}
2171 Determines how many components of the path to show in a list of tags.
2172 See |cscopepathcomp|.
2173
2174 *'cscopeprg'* *'csprg'*
2175'cscopeprg' 'csprg' string (default "cscope")
2176 global
2177 {not available when compiled without the |+cscope|
2178 feature}
2179 {not in Vi}
2180 Specifies the command to execute cscope. See |cscopeprg|.
2181 This option cannot be set from a |modeline| or in the |sandbox|, for
2182 security reasons.
2183
2184 *'cscopequickfix'* *'csqf'*
2185'cscopequickfix' 'csqf' string (default "")
2186 global
2187 {not available when compiled without the |+cscope|
2188 or |+quickfix| features}
2189 {not in Vi}
2190 Specifies whether to use quickfix window to show cscope results.
2191 See |cscopequickfix|.
2192
2193 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2194'cscopetag' 'cst' boolean (default off)
2195 global
2196 {not available when compiled without the |+cscope|
2197 feature}
2198 {not in Vi}
2199 Use cscope for tag commands. See |cscope-options|.
2200 NOTE: This option is reset when 'compatible' is set.
2201
2202 *'cscopetagorder'* *'csto'*
2203'cscopetagorder' 'csto' number (default 0)
2204 global
2205 {not available when compiled without the |+cscope|
2206 feature}
2207 {not in Vi}
2208 Determines the order in which ":cstag" performs a search. See
2209 |cscopetagorder|.
2210 NOTE: This option is set to 0 when 'compatible' is set.
2211
2212 *'cscopeverbose'* *'csverb'*
2213 *'nocscopeverbose'* *'nocsverb'*
2214'cscopeverbose' 'csverb' boolean (default off)
2215 global
2216 {not available when compiled without the |+cscope|
2217 feature}
2218 {not in Vi}
2219 Give messages when adding a cscope database. See |cscopeverbose|.
2220 NOTE: This option is reset when 'compatible' is set.
2221
Bram Moolenaar860cae12010-06-05 23:22:07 +02002222 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2223'cursorbind' 'crb' boolean (default off)
2224 local to window
2225 {not in Vi}
2226 {not available when compiled without the |+cursorbind|
2227 feature}
2228 When this option is set, as the cursor in the current
2229 window moves other cursorbound windows (windows that also have
2230 this option set) move their cursors to the corresponding line and
2231 column. This option is useful for viewing the
2232 differences between two versions of a file (see 'diff'); in diff mode,
2233 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002234 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002235
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002236
2237 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2238'cursorcolumn' 'cuc' boolean (default off)
2239 local to window
2240 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002241 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002242 feature}
2243 Highlight the screen column of the cursor with CursorColumn
2244 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2245 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002246 If you only want the highlighting in the current window you can use
2247 these autocommands: >
2248 au WinLeave * set nocursorline nocursorcolumn
2249 au WinEnter * set cursorline cursorcolumn
2250<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002251
2252 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2253'cursorline' 'cul' boolean (default off)
2254 local to window
2255 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002256 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002257 feature}
2258 Highlight the screen line of the cursor with CursorLine
2259 |hl-CursorLine|. Useful to easily spot the cursor. Will make screen
2260 redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002261 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002262 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002263
2264
Bram Moolenaar071d4272004-06-13 20:20:40 +00002265 *'debug'*
2266'debug' string (default "")
2267 global
2268 {not in Vi}
Bram Moolenaar57657d82006-04-21 22:12:41 +00002269 These values can be used:
2270 msg Error messages that would otherwise be omitted will be given
2271 anyway.
2272 throw Error messages that would otherwise be omitted will be given
2273 anyway and also throw an exception and set |v:errmsg|.
2274 beep A message will be given when otherwise only a beep would be
2275 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002276 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002277 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2278 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279
2280 *'define'* *'def'*
2281'define' 'def' string (default "^\s*#\s*define")
2282 global or local to buffer |global-local|
2283 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 pattern, just like for the "/" command. This option is used for the
2286 commands like "[i" and "[d" |include-search|. The 'isident' option is
2287 used to recognize the defined name after the match:
2288 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2289 See |option-backslash| about inserting backslashes to include a space
2290 or backslash.
2291 The default value is for C programs. For C++ this value would be
2292 useful, to include const type declarations: >
2293 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
2294< When using the ":set" command, you need to double the backslashes!
2295
2296 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2297'delcombine' 'deco' boolean (default off)
2298 global
2299 {not in Vi}
2300 {only available when compiled with the |+multi_byte|
2301 feature}
2302 If editing Unicode and this option is set, backspace and Normal mode
2303 "x" delete each combining character on its own. When it is off (the
2304 default) the character along with its combining characters are
2305 deleted.
2306 Note: When 'delcombine' is set "xx" may work different from "2x"!
2307
2308 This is useful for Arabic, Hebrew and many other languages where one
2309 may have combining characters overtop of base characters, and want
2310 to remove only the combining ones.
2311
2312 *'dictionary'* *'dict'*
2313'dictionary' 'dict' string (default "")
2314 global or local to buffer |global-local|
2315 {not in Vi}
2316 List of file names, separated by commas, that are used to lookup words
2317 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2318 contain a list of words. This can be one word per line, or several
2319 words per line, separated by non-keyword characters (white space is
2320 preferred). Maximum line length is 510 bytes.
Bram Moolenaar0b238792006-03-02 22:49:12 +00002321 When this option is empty, or an entry "spell" is present, spell
2322 checking is enabled the currently active spelling is used. |spell|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002323 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002324 after a comma are ignored, otherwise spaces are included in the file
2325 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002326 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002327 Where to find a list of words?
2328 - On FreeBSD, there is the file "/usr/share/dict/words".
2329 - In the Simtel archive, look in the "msdos/linguist" directory.
2330 - In "miscfiles" of the GNU collection.
2331 The use of |:set+=| and |:set-=| is preferred when adding or removing
2332 directories from the list. This avoids problems when a future version
2333 uses another default.
2334 Backticks cannot be used in this option for security reasons.
2335
2336 *'diff'* *'nodiff'*
2337'diff' boolean (default off)
2338 local to window
2339 {not in Vi}
2340 {not available when compiled without the |+diff|
2341 feature}
2342 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002343 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002344
2345 *'dex'* *'diffexpr'*
2346'diffexpr' 'dex' string (default "")
2347 global
2348 {not in Vi}
2349 {not available when compiled without the |+diff|
2350 feature}
2351 Expression which is evaluated to obtain an ed-style diff file from two
2352 versions of a file. See |diff-diffexpr|.
2353 This option cannot be set from a |modeline| or in the |sandbox|, for
2354 security reasons.
2355
2356 *'dip'* *'diffopt'*
2357'diffopt' 'dip' string (default "filler")
2358 global
2359 {not in Vi}
2360 {not available when compiled without the |+diff|
2361 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002362 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002363 All are optional. Items must be separated by a comma.
2364
2365 filler Show filler lines, to keep the text
2366 synchronized with a window that has inserted
2367 lines at the same position. Mostly useful
2368 when windows are side-by-side and 'scrollbind'
2369 is set.
2370
2371 context:{n} Use a context of {n} lines between a change
2372 and a fold that contains unchanged lines.
2373 When omitted a context of six lines is used.
2374 See |fold-diff|.
2375
2376 icase Ignore changes in case of text. "a" and "A"
2377 are considered the same. Adds the "-i" flag
2378 to the "diff" command if 'diffexpr' is empty.
2379
2380 iwhite Ignore changes in amount of white space. Adds
2381 the "-b" flag to the "diff" command if
2382 'diffexpr' is empty. Check the documentation
2383 of the "diff" command for what this does
2384 exactly. It should ignore adding trailing
2385 white space, but not leading white space.
2386
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002387 horizontal Start diff mode with horizontal splits (unless
2388 explicitly specified otherwise).
2389
2390 vertical Start diff mode with vertical splits (unless
2391 explicitly specified otherwise).
2392
2393 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2394 starting diff mode. Without this 2 is used.
2395
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 Examples: >
2397
2398 :set diffopt=filler,context:4
2399 :set diffopt=
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002400 :set diffopt=filler,foldcolumn:3
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401<
2402 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2403'digraph' 'dg' boolean (default off)
2404 global
2405 {not in Vi}
2406 {not available when compiled without the |+digraphs|
2407 feature}
2408 Enable the entering of digraphs in Insert mode with {char1} <BS>
2409 {char2}. See |digraphs|.
2410 NOTE: This option is reset when 'compatible' is set.
2411
2412 *'directory'* *'dir'*
2413'directory' 'dir' string (default for Amiga: ".,t:",
2414 for MS-DOS and Win32: ".,c:\tmp,c:\temp"
2415 for Unix: ".,~/tmp,/var/tmp,/tmp")
2416 global
2417 List of directory names for the swap file, separated with commas.
2418 - The swap file will be created in the first directory where this is
2419 possible.
2420 - Empty means that no swap file will be used (recovery is
2421 impossible!).
2422 - A directory "." means to put the swap file in the same directory as
2423 the edited file. On Unix, a dot is prepended to the file name, so
2424 it doesn't show in a directory listing. On MS-Windows the "hidden"
2425 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002426 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 put the swap file relative to where the edited file is. The leading
2428 "." is replaced with the path name of the edited file.
Bram Moolenaar83bab712005-08-01 21:58:57 +00002429 - For Unix and Win32, if a directory ends in two path separators "//"
2430 or "\\", the swap file name will be built from the complete path to
2431 the file with all path separators substituted to percent '%' signs.
2432 This will ensure file name uniqueness in the preserve directory.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00002433 On Win32, when a separating comma is following, you must use "//",
2434 since "\\" will include the comma in the file name.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002435 - Spaces after the comma are ignored, other spaces are considered part
2436 of the directory name. To have a space at the start of a directory
2437 name, precede it with a backslash.
2438 - To include a comma in a directory name precede it with a backslash.
2439 - A directory name may end in an ':' or '/'.
2440 - Environment variables are expanded |:set_env|.
2441 - Careful with '\' characters, type one before a space, type two to
2442 get one in the option (see |option-backslash|), for example: >
2443 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2444< - For backwards compatibility with Vim version 3.0 a '>' at the start
2445 of the option is removed.
2446 Using "." first in the list is recommended. This means that editing
2447 the same file twice will result in a warning. Using "/tmp" on Unix is
2448 discouraged: When the system crashes you lose the swap file.
2449 "/var/tmp" is often not cleared when rebooting, thus is a better
2450 choice than "/tmp". But it can contain a lot of files, your swap
2451 files get lost in the crowd. That is why a "tmp" directory in your
2452 home directory is tried first.
2453 The use of |:set+=| and |:set-=| is preferred when adding or removing
2454 directories from the list. This avoids problems when a future version
2455 uses another default.
2456 This option cannot be set from a |modeline| or in the |sandbox|, for
2457 security reasons.
2458 {Vi: directory to put temp file in, defaults to "/tmp"}
2459
2460 *'display'* *'dy'*
2461'display' 'dy' string (default "")
2462 global
2463 {not in Vi}
2464 Change the way text is displayed. This is comma separated list of
2465 flags:
2466 lastline When included, as much as possible of the last line
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002467 in a window will be displayed. When not included, a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002468 last line that doesn't fit is replaced with "@" lines.
2469 uhex Show unprintable characters hexadecimal as <xx>
2470 instead of using ^C and ~C.
2471
2472 *'eadirection'* *'ead'*
2473'eadirection' 'ead' string (default "both")
2474 global
2475 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02002476 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002477 feature}
2478 Tells when the 'equalalways' option applies:
2479 ver vertically, width of windows is not affected
2480 hor horizontally, height of windows is not affected
2481 both width and height of windows is affected
2482
2483 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2484'edcompatible' 'ed' boolean (default off)
2485 global
2486 Makes the 'g' and 'c' flags of the ":substitute" command to be
2487 toggled each time the flag is given. See |complex-change|. See
2488 also 'gdefault' option.
2489 Switching this option on is discouraged!
2490
2491 *'encoding'* *'enc'* *E543*
2492'encoding' 'enc' string (default: "latin1" or value from $LANG)
2493 global
2494 {only available when compiled with the |+multi_byte|
2495 feature}
2496 {not in Vi}
2497 Sets the character encoding used inside Vim. It applies to text in
2498 the buffers, registers, Strings in expressions, text stored in the
2499 viminfo file, etc. It sets the kind of characters which Vim can work
2500 with. See |encoding-names| for the possible values.
2501
2502 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002503 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002504 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002505 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506
Bram Moolenaar865242e2010-07-14 21:12:05 +02002507 This option cannot be set from a |modeline|. It would most likely
2508 corrupt the text.
2509
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510 NOTE: For GTK+ 2 it is highly recommended to set 'encoding' to
2511 "utf-8". Although care has been taken to allow different values of
2512 'encoding', "utf-8" is the natural choice for the environment and
2513 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002514 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 versions, and to avoid changing the encoding of newly created files
2516 without your knowledge (in case 'fileencodings' is empty).
2517
2518 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002519 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002520 iconv() or as specified with 'charconvert'.
2521
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002522 If you need to know whether 'encoding' is a multi-byte encoding, you
2523 can use: >
2524 if has("multi_byte_encoding")
2525<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526 Normally 'encoding' will be equal to your current locale. This will
2527 be the default if Vim recognizes your environment settings. If
2528 'encoding' is not set to the current locale, 'termencoding' must be
2529 set to convert typed and displayed text. See |encoding-table|.
2530
2531 When you set this option, it fires the |EncodingChanged| autocommand
2532 event so that you can set up fonts if necessary.
2533
2534 When the option is set, the value is converted to lowercase. Thus
2535 you can set it with uppercase values too. Underscores are translated
2536 to '-' signs.
2537 When the encoding is recognized, it is changed to the standard name.
2538 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2539 "iso-8859-2" and "utf8" becomes "utf-8".
2540
2541 Note: "latin1" is also used when the encoding could not be detected.
2542 This only works when editing files in the same encoding! When the
2543 actual character set is not latin1, make sure 'fileencoding' and
2544 'fileencodings' are empty. When conversion is needed, switch to using
2545 utf-8.
2546
2547 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2548 You don't notice this while editing, but it does matter for the
2549 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2550 setting 'encoding' to one of these values instead of utf-8 only has
2551 effect for encoding used for files when 'fileencoding' is empty.
2552
Bram Moolenaar661b1822005-07-28 22:36:45 +00002553 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2554 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002555
2556 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2557'endofline' 'eol' boolean (default on)
2558 local to buffer
2559 {not in Vi}
2560 When writing a file and this option is off and the 'binary' option
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002561 is on, no <EOL> will be written for the last line in the file. This
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 option is automatically set when starting to edit a new file, unless
2563 the file does not have an <EOL> for the last line in the file, in
2564 which case it is reset. Normally you don't have to set or reset this
2565 option. When 'binary' is off the value is not used when writing the
2566 file. When 'binary' is on it is used to remember the presence of a
2567 <EOL> for the last line in the file, so that when you write the file
2568 the situation from the original file can be kept. But you can change
2569 it if you want to.
2570
2571 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2572'equalalways' 'ea' boolean (default on)
2573 global
2574 {not in Vi}
2575 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002576 splitting or closing a window. This also happens the moment the
2577 option is switched on. When off, splitting a window will reduce the
2578 size of the current window and leave the other windows the same. When
2579 closing a window the extra lines are given to the window next to it
2580 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002581 When mixing vertically and horizontally split windows, a minimal size
2582 is computed and some windows may be larger if there is room. The
2583 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002584 Changing the height and width of a window can be avoided by setting
2585 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002586 If a window size is specified when creating a new window sizes are
2587 currently not equalized (it's complicated, but may be implemented in
2588 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002589
2590 *'equalprg'* *'ep'*
2591'equalprg' 'ep' string (default "")
2592 global or local to buffer |global-local|
2593 {not in Vi}
2594 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002595 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002596 or 'indentexpr'. When Vim was compiled without internal formatting,
2597 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002598 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 about including spaces and backslashes.
2600 This option cannot be set from a |modeline| or in the |sandbox|, for
2601 security reasons.
2602
2603 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2604'errorbells' 'eb' boolean (default off)
2605 global
2606 Ring the bell (beep or screen flash) for error messages. This only
2607 makes a difference for error messages, the bell will be used always
2608 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002609 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar071d4272004-06-13 20:20:40 +00002610 screen flash or do nothing.
2611
2612 *'errorfile'* *'ef'*
2613'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2614 others: "errors.err")
2615 global
2616 {not in Vi}
2617 {not available when compiled without the |+quickfix|
2618 feature}
2619 Name of the errorfile for the QuickFix mode (see |:cf|).
2620 When the "-q" command-line argument is used, 'errorfile' is set to the
2621 following argument. See |-q|.
2622 NOT used for the ":make" command. See 'makeef' for that.
2623 Environment variables are expanded |:set_env|.
2624 See |option-backslash| about including spaces and backslashes.
2625 This option cannot be set from a |modeline| or in the |sandbox|, for
2626 security reasons.
2627
2628 *'errorformat'* *'efm'*
2629'errorformat' 'efm' string (default is very long)
2630 global or local to buffer |global-local|
2631 {not in Vi}
2632 {not available when compiled without the |+quickfix|
2633 feature}
2634 Scanf-like description of the format for the lines in the error file
2635 (see |errorformat|).
2636
2637 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2638'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2639 global
2640 {not in Vi}
2641 Function keys that start with an <Esc> are recognized in Insert
2642 mode. When this option is off, the cursor and function keys cannot be
2643 used in Insert mode if they start with an <Esc>. The advantage of
2644 this is that the single <Esc> is recognized immediately, instead of
2645 after one second. Instead of resetting this option, you might want to
2646 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2647 when 'esckeys' is off, you can still map anything, but the cursor keys
2648 won't work by default.
2649 NOTE: This option is set to the Vi default value when 'compatible' is
2650 set and to the Vim default value when 'compatible' is reset.
2651
2652 *'eventignore'* *'ei'*
2653'eventignore' 'ei' string (default "")
2654 global
2655 {not in Vi}
2656 {not available when compiled without the |+autocmd|
2657 feature}
2658 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002659 When set to "all" or when "all" is one of the items, all autocommand
2660 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661 Otherwise this is a comma separated list of event names. Example: >
2662 :set ei=WinEnter,WinLeave
2663<
2664 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2665'expandtab' 'et' boolean (default off)
2666 local to buffer
2667 {not in Vi}
2668 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002669 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002670 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2671 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
2672 NOTE: This option is reset when 'compatible' is set.
2673
2674 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2675'exrc' 'ex' boolean (default off)
2676 global
2677 {not in Vi}
2678 Enables the reading of .vimrc, .exrc and .gvimrc in the current
2679 directory. If you switch this option on you should also consider
2680 setting the 'secure' option (see |initialization|). Using a local
2681 .exrc, .vimrc or .gvimrc is a potential security leak, use with care!
2682 also see |.vimrc| and |gui-init|.
2683 This option cannot be set from a |modeline| or in the |sandbox|, for
2684 security reasons.
2685
2686 *'fileencoding'* *'fenc'* *E213*
2687'fileencoding' 'fenc' string (default: "")
2688 local to buffer
2689 {only available when compiled with the |+multi_byte|
2690 feature}
2691 {not in Vi}
2692 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002693
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002695 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 When 'fileencoding' is empty, the same value as 'encoding' will be
2697 used (no conversion when reading or writing a file).
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002698 Conversion will also be done when 'encoding' and 'fileencoding' are
2699 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2700 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002701 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002702 'encoding' is "utf-8" or another Unicode encoding, conversion
2703 is most likely done in a way that the reverse conversion
2704 results in the same text. When 'encoding' is not "utf-8" some
2705 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002706
Bram Moolenaar071d4272004-06-13 20:20:40 +00002707 See 'encoding' for the possible values. Additionally, values may be
2708 specified that can be handled by the converter, see
2709 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002710
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 When reading a file 'fileencoding' will be set from 'fileencodings'.
2712 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002713 'fileencoding', use the |++enc| argument. One exception: when
2714 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002715 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002716
Bram Moolenaar071d4272004-06-13 20:20:40 +00002717 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2718 When the option is set, the value is converted to lowercase. Thus
2719 you can set it with uppercase values too. '_' characters are
2720 replaced with '-'. If a name is recognized from the list for
2721 'encoding', it is replaced by the standard name. For example
2722 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002723
Bram Moolenaar071d4272004-06-13 20:20:40 +00002724 When this option is set, after starting to edit a file, the 'modified'
2725 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002726
2727 Keep in mind that changing 'fenc' from a modeline happens
2728 AFTER the text has been read, thus it applies to when the file will be
2729 written. If you do set 'fenc' in a modeline, you might want to set
2730 'nomodified' to avoid not being able to ":q".
2731
Bram Moolenaar071d4272004-06-13 20:20:40 +00002732 This option can not be changed when 'modifiable' is off.
2733
2734 *'fe'*
2735 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002736 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002737 old short name was 'fe', which is no longer used.
2738
2739 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002740'fileencodings' 'fencs' string (default: "ucs-bom",
2741 "ucs-bom,utf-8,default,latin1" when
2742 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 global
2744 {only available when compiled with the |+multi_byte|
2745 feature}
2746 {not in Vi}
2747 This is a list of character encodings considered when starting to edit
2748 an existing file. When a file is read, Vim tries to use the first
2749 mentioned character encoding. If an error is detected, the next one
2750 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002751 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 an empty string, which means the value of 'encoding' is used.
2753 WARNING: Conversion can cause loss of information! When
2754 'encoding' is "utf-8" (or one of the other Unicode variants)
2755 conversion is most likely done in a way that the reverse
2756 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002757 "utf-8" some non-ASCII characters may be lost! You can use
2758 the |++bad| argument to specify what is done with characters
2759 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 For an empty file or a file with only ASCII characters most encodings
2761 will work and the first entry of 'fileencodings' will be used (except
2762 "ucs-bom", which requires the BOM to be present). If you prefer
2763 another encoding use an BufReadPost autocommand event to test if your
2764 preferred encoding is to be used. Example: >
2765 au BufReadPost * if search('\S', 'w') == 0 |
2766 \ set fenc=iso-2022-jp | endif
2767< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
2768 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00002769 When the |++enc| argument is used then the value of 'fileencodings' is
2770 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002771 Note that 'fileencodings' is not used for a new file, the global value
2772 of 'fileencoding' is used instead. You can set it with: >
2773 :setglobal fenc=iso-8859-2
2774< This means that a non-existing file may get a different encoding than
2775 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776 The special value "ucs-bom" can be used to check for a Unicode BOM
2777 (Byte Order Mark) at the start of the file. It must not be preceded
2778 by "utf-8" or another Unicode encoding for this to work properly.
2779 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
2780 because Vim cannot detect an error, thus the encoding is always
2781 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002782 The special value "default" can be used for the encoding from the
2783 environment. This is the default value for 'encoding'. It is useful
2784 when 'encoding' is set to "utf-8" and your environment uses a
2785 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00002786 When 'encoding' is "utf-8" and a file contains an illegal byte
2787 sequence it won't be recognized as UTF-8. You can use the |8g8|
2788 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 WRONG VALUES: WHAT'S WRONG:
2790 latin1,utf-8 "latin1" will always be used
2791 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
2792 file
2793 cp1250,latin1 "cp1250" will always be used
2794 If 'fileencodings' is empty, 'fileencoding' is not modified.
2795 See 'fileencoding' for the possible values.
2796 Setting this option does not have an effect until the next time a file
2797 is read.
2798
2799 *'fileformat'* *'ff'*
2800'fileformat' 'ff' string (MS-DOS, MS-Windows, OS/2 default: "dos",
2801 Unix default: "unix",
2802 Macintosh default: "mac")
2803 local to buffer
2804 {not in Vi}
2805 This gives the <EOL> of the current buffer, which is used for
2806 reading/writing the buffer from/to a file:
2807 dos <CR> <NL>
2808 unix <NL>
2809 mac <CR>
2810 When "dos" is used, CTRL-Z at the end of a file is ignored.
2811 See |file-formats| and |file-read|.
2812 For the character encoding of the file see 'fileencoding'.
2813 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
2814 works like it was set to "unix'.
2815 This option is set automatically when starting to edit a file and
2816 'fileformats' is not empty and 'binary' is off.
2817 When this option is set, after starting to edit a file, the 'modified'
2818 option is set, because the file would be different when written.
2819 This option can not be changed when 'modifiable' is off.
2820 For backwards compatibility: When this option is set to "dos",
2821 'textmode' is set, otherwise 'textmode' is reset.
2822
2823 *'fileformats'* *'ffs'*
2824'fileformats' 'ffs' string (default:
2825 Vim+Vi MS-DOS, MS-Windows OS/2: "dos,unix",
2826 Vim Unix: "unix,dos",
2827 Vim Mac: "mac,unix,dos",
2828 Vi Cygwin: "unix,dos",
2829 Vi others: "")
2830 global
2831 {not in Vi}
2832 This gives the end-of-line (<EOL>) formats that will be tried when
2833 starting to edit a new buffer and when reading a file into an existing
2834 buffer:
2835 - When empty, the format defined with 'fileformat' will be used
2836 always. It is not set automatically.
2837 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002838 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00002839 'fileformats' name will be used when a file is read into an existing
2840 buffer, no matter what 'fileformat' for that buffer is set to.
2841 - When more than one name is present, separated by commas, automatic
2842 <EOL> detection will be done when reading a file. When starting to
2843 edit a file, a check is done for the <EOL>:
2844 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
2845 'fileformat' is set to "dos".
2846 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002847 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar00659062010-09-21 22:34:02 +02002849 3. If 'fileformat' has not yet been set, and if 'fileformats'
2850 includes "mac", 'fileformat' is set to "mac".
2851 This means that "mac" is only chosen when:
2852 "unix" is not present or no <NL> is found in the file, and
2853 "dos" is not present or no <CR><NL> is found in the file.
2854 Except: if "unix" was chosen, but there is a <CR> before
2855 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01002856 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002857 4. If 'fileformat' is still not set, the first name from
2858 'fileformats' is used.
2859 When reading a file into an existing buffer, the same is done, but
2860 this happens like 'fileformat' has been set appropriately for that
2861 file only, the option is not changed.
2862 When 'binary' is set, the value of 'fileformats' is not used.
2863
Bram Moolenaar81af9252010-12-10 20:35:50 +01002864 Note that when Vim starts up with an empty buffer this option is not
Bram Moolenaar2a8a3ec2011-01-08 16:06:37 +01002865 used. Set 'fileformat' in your .vimrc instead.
Bram Moolenaar81af9252010-12-10 20:35:50 +01002866
Bram Moolenaar071d4272004-06-13 20:20:40 +00002867 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
2868 are ":source"ed and for vimrc files, automatic <EOL> detection may be
2869 done:
2870 - When 'fileformats' is empty, there is no automatic detection. Dos
2871 format will be used.
2872 - When 'fileformats' is set to one or more names, automatic detection
2873 is done. This is based on the first <NL> in the file: If there is a
2874 <CR> in front of it, Dos format is used, otherwise Unix format is
2875 used.
2876 Also see |file-formats|.
2877 For backwards compatibility: When this option is set to an empty
2878 string or one format (no comma is included), 'textauto' is reset,
2879 otherwise 'textauto' is set.
2880 NOTE: This option is set to the Vi default value when 'compatible' is
2881 set and to the Vim default value when 'compatible' is reset.
2882
2883 *'filetype'* *'ft'*
2884'filetype' 'ft' string (default: "")
2885 local to buffer
2886 {not in Vi}
2887 {not available when compiled without the |+autocmd|
2888 feature}
2889 When this option is set, the FileType autocommand event is triggered.
2890 All autocommands that match with the value of this option will be
2891 executed. Thus the value of 'filetype' is used in place of the file
2892 name.
2893 Otherwise this option does not always reflect the current file type.
2894 This option is normally set when the file type is detected. To enable
2895 this use the ":filetype on" command. |:filetype|
2896 Setting this option to a different value is most useful in a modeline,
2897 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00002898 Example, for in an IDL file:
2899 /* vim: set filetype=idl : */ ~
2900 |FileType| |filetypes|
2901 When a dot appears in the value then this separates two filetype
2902 names. Example:
2903 /* vim: set filetype=c.doxygen : */ ~
2904 This will use the "c" filetype first, then the "doxygen" filetype.
2905 This works both for filetype plugins and for syntax files. More than
2906 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002907 Do not confuse this option with 'osfiletype', which is for the file
2908 type that is actually stored with the file.
2909 This option is not copied to another buffer, independent of the 's' or
2910 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002911 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002912
2913 *'fillchars'* *'fcs'*
2914'fillchars' 'fcs' string (default "vert:|,fold:-")
2915 global
2916 {not in Vi}
2917 {not available when compiled without the |+windows|
2918 and |+folding| features}
2919 Characters to fill the statuslines and vertical separators.
2920 It is a comma separated list of items:
2921
2922 item default Used for ~
2923 stl:c ' ' or '^' statusline of the current window
2924 stlnc:c ' ' or '-' statusline of the non-current windows
2925 vert:c '|' vertical separators |:vsplit|
2926 fold:c '-' filling 'foldtext'
2927 diff:c '-' deleted lines of the 'diff' option
2928
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002929 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 "stlnc" the space will be used when there is highlighting, '^' or '-'
2931 otherwise.
2932
2933 Example: >
2934 :set fillchars=stl:^,stlnc:-,vert:\|,fold:-,diff:-
2935< This is similar to the default, except that these characters will also
2936 be used when there is highlighting.
2937
Bram Moolenaar910f66f2006-04-05 20:41:53 +00002938 for "stl" and "stlnc" only single-byte values are supported.
2939
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 The highlighting used for these items:
2941 item highlight group ~
2942 stl:c StatusLine |hl-StatusLine|
2943 stlnc:c StatusLineNC |hl-StatusLineNC|
2944 vert:c VertSplit |hl-VertSplit|
2945 fold:c Folded |hl-Folded|
2946 diff:c DiffDelete |hl-DiffDelete|
2947
2948 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
2949'fkmap' 'fk' boolean (default off) *E198*
2950 global
2951 {not in Vi}
2952 {only available when compiled with the |+rightleft|
2953 feature}
2954 When on, the keyboard is mapped for the Farsi character set.
2955 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002956 toggle this option |i_CTRL-_|. See |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002957
2958 *'foldclose'* *'fcl'*
2959'foldclose' 'fcl' string (default "")
2960 global
2961 {not in Vi}
2962 {not available when compiled without the |+folding|
2963 feature}
2964 When set to "all", a fold is closed when the cursor isn't in it and
2965 its level is higher than 'foldlevel'. Useful if you want folds to
2966 automatically close when moving out of them.
2967
2968 *'foldcolumn'* *'fdc'*
2969'foldcolumn' 'fdc' number (default 0)
2970 local to window
2971 {not in Vi}
2972 {not available when compiled without the |+folding|
2973 feature}
2974 When non-zero, a column with the specified width is shown at the side
2975 of the window which indicates open and closed folds. The maximum
2976 value is 12.
2977 See |folding|.
2978
2979 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
2980'foldenable' 'fen' boolean (default on)
2981 local to window
2982 {not in Vi}
2983 {not available when compiled without the |+folding|
2984 feature}
2985 When off, all folds are open. This option can be used to quickly
2986 switch between showing all text unfolded and viewing the text with
2987 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002988 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 'foldenable' is off.
2990 This option is set by commands that create a new fold or close a fold.
2991 See |folding|.
2992
2993 *'foldexpr'* *'fde'*
2994'foldexpr' 'fde' string (default: "0")
2995 local to window
2996 {not in Vi}
2997 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02002998 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003000 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003001
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003002 The expression may be evaluated in the |sandbox|, see
3003 |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003004 This option can't be set from a |modeline| when the 'diff' option is
3005 on.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003006
3007 It is not allowed to change text or jump to another window while
3008 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009
3010 *'foldignore'* *'fdi'*
3011'foldignore' 'fdi' string (default: "#")
3012 local to window
3013 {not in Vi}
3014 {not available when compiled without the |+folding|
3015 feature}
3016 Used only when 'foldmethod' is "indent". Lines starting with
3017 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003018 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 The default "#" works well for C programs. See |fold-indent|.
3020
3021 *'foldlevel'* *'fdl'*
3022'foldlevel' 'fdl' number (default: 0)
3023 local to window
3024 {not in Vi}
3025 {not available when compiled without the |+folding|
3026 feature}
3027 Sets the fold level: Folds with a higher level will be closed.
3028 Setting this option to zero will close all folds. Higher numbers will
3029 close fewer folds.
3030 This option is set by commands like |zm|, |zM| and |zR|.
3031 See |fold-foldlevel|.
3032
3033 *'foldlevelstart'* *'fdls'*
3034'foldlevelstart' 'fdls' number (default: -1)
3035 global
3036 {not in Vi}
3037 {not available when compiled without the |+folding|
3038 feature}
3039 Sets 'foldlevel' when starting to edit another buffer in a window.
3040 Useful to always start editing with all folds closed (value zero),
3041 some folds closed (one) or no folds closed (99).
3042 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003043 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003044 ignores this option and closes all folds.
3045 It is also done before BufReadPre autocommands, to allow an autocmd to
3046 overrule the 'foldlevel' value for specific files.
3047 When the value is negative, it is not used.
3048
3049 *'foldmarker'* *'fmr'* *E536*
3050'foldmarker' 'fmr' string (default: "{{{,}}}")
3051 local to window
3052 {not in Vi}
3053 {not available when compiled without the |+folding|
3054 feature}
3055 The start and end marker used when 'foldmethod' is "marker". There
3056 must be one comma, which separates the start and end marker. The
3057 marker is a literal string (a regular expression would be too slow).
3058 See |fold-marker|.
3059
3060 *'foldmethod'* *'fdm'*
3061'foldmethod' 'fdm' string (default: "manual")
3062 local to window
3063 {not in Vi}
3064 {not available when compiled without the |+folding|
3065 feature}
3066 The kind of folding used for the current window. Possible values:
3067 |fold-manual| manual Folds are created manually.
3068 |fold-indent| indent Lines with equal indent form a fold.
3069 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3070 |fold-marker| marker Markers are used to specify folds.
3071 |fold-syntax| syntax Syntax highlighting items specify folds.
3072 |fold-diff| diff Fold text that is not changed.
3073
3074 *'foldminlines'* *'fml'*
3075'foldminlines' 'fml' number (default: 1)
3076 local to window
3077 {not in Vi}
3078 {not available when compiled without the |+folding|
3079 feature}
3080 Sets the minimum number of screen lines for a fold to be displayed
3081 closed. Also for manually closed folds.
3082 Note that this only has an effect of what is displayed. After using
3083 "zc" to close a fold, which is displayed open because it's smaller
3084 than 'foldminlines', a following "zc" may close a containing fold.
3085
3086 *'foldnestmax'* *'fdn'*
3087'foldnestmax' 'fdn' number (default: 20)
3088 local to window
3089 {not in Vi}
3090 {not available when compiled without the |+folding|
3091 feature}
3092 Sets the maximum nesting of folds for the "indent" and "syntax"
3093 methods. This avoids that too many folds will be created. Using more
3094 than 20 doesn't work, because the internal limit is 20.
3095
3096 *'foldopen'* *'fdo'*
3097'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3098 search,tag,undo")
3099 global
3100 {not in Vi}
3101 {not available when compiled without the |+folding|
3102 feature}
3103 Specifies for which type of commands folds will be opened, if the
3104 command moves the cursor into a closed fold. It is a comma separated
3105 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003106 NOTE: When the command is part of a mapping this option is not used.
3107 Add the |zv| command to the mapping to get the same effect.
3108 (rationale: the mapping may want to control opening folds itself)
3109
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 item commands ~
3111 all any
3112 block "(", "{", "[[", "[{", etc.
3113 hor horizontal movements: "l", "w", "fx", etc.
3114 insert any command in Insert mode
3115 jump far jumps: "G", "gg", etc.
3116 mark jumping to a mark: "'m", CTRL-O, etc.
3117 percent "%"
3118 quickfix ":cn", ":crew", ":make", etc.
3119 search search for a pattern: "/", "n", "*", "gd", etc.
3120 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003121 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 tag jumping to a tag: ":ta", CTRL-T, etc.
3123 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003124 When a movement command is used for an operator (e.g., "dl" or "y%")
3125 this option is not used. This means the operator will include the
3126 whole closed fold.
3127 Note that vertical movements are not here, because it would make it
3128 very difficult to move onto a closed fold.
3129 In insert mode the folds containing the cursor will always be open
3130 when text is inserted.
3131 To close folds you can re-apply 'foldlevel' with the |zx| command or
3132 set the 'foldclose' option to "all".
3133
3134 *'foldtext'* *'fdt'*
3135'foldtext' 'fdt' string (default: "foldtext()")
3136 local to window
3137 {not in Vi}
3138 {not available when compiled without the |+folding|
3139 feature}
3140 An expression which is used to specify the text displayed for a closed
3141 fold. See |fold-foldtext|.
3142
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003143 The expression may be evaluated in the |sandbox|, see
3144 |sandbox-option|.
3145
3146 It is not allowed to change text or jump to another window while
3147 evaluating 'foldtext' |textlock|.
3148
Bram Moolenaar071d4272004-06-13 20:20:40 +00003149 *'formatoptions'* *'fo'*
3150'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3151 local to buffer
3152 {not in Vi}
3153 This is a sequence of letters which describes how automatic
3154 formatting is to be done. See |fo-table|. When the 'paste' option is
3155 on, no formatting is done (like 'formatoptions' is empty). Commas can
3156 be inserted for readability.
3157 To avoid problems with flags that are added in the future, use the
3158 "+=" and "-=" feature of ":set" |add-option-flags|.
3159 NOTE: This option is set to the Vi default value when 'compatible' is
3160 set and to the Vim default value when 'compatible' is reset.
3161
Bram Moolenaar86b68352004-12-27 21:59:20 +00003162 *'formatlistpat'* *'flp'*
3163'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3164 local to buffer
3165 {not in Vi}
3166 A pattern that is used to recognize a list header. This is used for
3167 the "n" flag in 'formatoptions'.
3168 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003169 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003170 while still checking more characters. There must be a character
3171 following the pattern, when it matches the whole line it is handled
3172 like there is no match.
3173 The default recognizes a number, followed by an optional punctuation
3174 character and white space.
3175
Bram Moolenaar071d4272004-06-13 20:20:40 +00003176 *'formatprg'* *'fp'*
3177'formatprg' 'fp' string (default "")
3178 global
3179 {not in Vi}
3180 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003181 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003183 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003184 If the 'formatexpr' option is not empty it will be used instead.
3185 Otherwise, if 'formatprg' option is an empty string, the internal
3186 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003187 Environment variables are expanded |:set_env|. See |option-backslash|
3188 about including spaces and backslashes.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003189 The expression may be evaluated in the |sandbox|, see
3190 |sandbox-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003192 *'formatexpr'* *'fex'*
3193'formatexpr' 'fex' string (default "")
3194 local to buffer
3195 {not in Vi}
3196 {not available when compiled without the |+eval|
3197 feature}
3198 Expression which is evaluated to format a range of lines for the |gq|
Bram Moolenaar368373e2010-07-19 20:46:22 +02003199 operator or automatic formatting (see 'formatoptions'). When this
3200 option is empty 'formatprg' is used.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003201
3202 The |v:lnum| variable holds the first line to be formatted.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003203 The |v:count| variable holds the number of lines to be formatted.
3204 The |v:char| variable holds the character that is going to be
Bram Moolenaar368373e2010-07-19 20:46:22 +02003205 inserted if the expression is being evaluated due to
3206 automatic formatting. This can be empty. Don't insert
3207 it yet!
Bram Moolenaarf193fff2006-04-27 00:02:13 +00003208
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003209 Example: >
Bram Moolenaard1f56e62006-02-22 21:25:37 +00003210 :set formatexpr=mylang#Format()
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003211< This will invoke the mylang#Format() function in the
3212 autoload/mylang.vim file in 'runtimepath'. |autoload|
3213
3214 The expression is also evaluated when 'textwidth' is set and adding
3215 text beyond that limit. This happens under the same conditions as
3216 when internal formatting is used. Make sure the cursor is kept in the
3217 same spot relative to the text then! The |mode()| function will
Bram Moolenaar700303e2010-07-11 17:35:50 +02003218 return "i" or "R" in this situation.
3219
3220 When the expression evaluates to non-zero Vim will fall back to using
3221 the internal format mechanism.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003222
3223 The expression may be evaluated in the |sandbox|, see
Bram Moolenaar81af9252010-12-10 20:35:50 +01003224 |sandbox-option|. That stops the option from working, since changing
3225 the buffer text is not allowed.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003226
3227 *'fsync'* *'fs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003228'fsync' 'fs' boolean (default on)
3229 global
3230 {not in Vi}
3231 When on, the library function fsync() will be called after writing a
3232 file. This will flush a file to disk, ensuring that it is safely
3233 written even on filesystems which do metadata-only journaling. This
3234 will force the harddrive to spin up on Linux systems running in laptop
3235 mode, so it may be undesirable in some situations. Be warned that
3236 turning this off increases the chances of data loss after a crash. On
3237 systems without an fsync() implementation, this variable is always
3238 off.
3239 Also see 'swapsync' for controlling fsync() on swap files.
3240
Bram Moolenaar071d4272004-06-13 20:20:40 +00003241 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3242'gdefault' 'gd' boolean (default off)
3243 global
3244 {not in Vi}
3245 When on, the ":substitute" flag 'g' is default on. This means that
3246 all matches in a line are substituted instead of one. When a 'g' flag
3247 is given to a ":substitute" command, this will toggle the substitution
3248 of all or one match. See |complex-change|.
3249
3250 command 'gdefault' on 'gdefault' off ~
3251 :s/// subst. all subst. one
3252 :s///g subst. one subst. all
3253 :s///gg subst. all subst. one
3254
3255 NOTE: This option is reset when 'compatible' is set.
3256
3257 *'grepformat'* *'gfm'*
3258'grepformat' 'gfm' string (default "%f:%l%m,%f %l%m")
3259 global
3260 {not in Vi}
3261 Format to recognize for the ":grep" command output.
3262 This is a scanf-like string that uses the same format as the
3263 'errorformat' option: see |errorformat|.
3264
3265 *'grepprg'* *'gp'*
3266'grepprg' 'gp' string (default "grep -n ",
3267 Unix: "grep -n $* /dev/null",
3268 Win32: "findstr /n" or "grep -n",
3269 VMS: "SEARCH/NUMBERS ")
3270 global or local to buffer |global-local|
3271 {not in Vi}
Bram Moolenaar582fd852005-03-28 20:58:01 +00003272 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003273 and '#' characters, which are expanded like when used in a command-
3274 line. The placeholder "$*" is allowed to specify where the arguments
3275 will be included. Environment variables are expanded |:set_env|. See
3276 |option-backslash| about including spaces and backslashes.
3277 When your "grep" accepts the "-H" argument, use this to make ":grep"
3278 also work well with a single file: >
3279 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003280< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003281 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3282 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003283 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003284 apply equally to 'grepprg'.
3285 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3286 otherwise it's "grep -n".
3287 This option cannot be set from a |modeline| or in the |sandbox|, for
3288 security reasons.
3289
3290 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3291'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3292 ve:ver35-Cursor,
3293 o:hor50-Cursor,
3294 i-ci:ver25-Cursor/lCursor,
3295 r-cr:hor20-Cursor/lCursor,
3296 sm:block-Cursor
3297 -blinkwait175-blinkoff150-blinkon175",
3298 for MS-DOS and Win32 console:
3299 "n-v-c:block,o:hor50,i-ci:hor15,
3300 r-cr:hor30,sm:block")
3301 global
3302 {not in Vi}
3303 {only available when compiled with GUI enabled, and
3304 for MS-DOS and Win32 console}
3305 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003306 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 the height of the cursor can be changed. This can be done by
3308 specifying a block cursor, or a percentage for a vertical or
3309 horizontal cursor.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003310 For a console the 't_SI' and 't_EI' escape sequences are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003311
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003312 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 mode-list and an argument-list:
3314 mode-list:argument-list,mode-list:argument-list,..
3315 The mode-list is a dash separated list of these modes:
3316 n Normal mode
3317 v Visual mode
3318 ve Visual mode with 'selection' "exclusive" (same as 'v',
3319 if not specified)
3320 o Operator-pending mode
3321 i Insert mode
3322 r Replace mode
3323 c Command-line Normal (append) mode
3324 ci Command-line Insert mode
3325 cr Command-line Replace mode
3326 sm showmatch in Insert mode
3327 a all modes
3328 The argument-list is a dash separated list of these arguments:
3329 hor{N} horizontal bar, {N} percent of the character height
3330 ver{N} vertical bar, {N} percent of the character width
3331 block block cursor, fills the whole character
3332 [only one of the above three should be present]
3333 blinkwait{N} *cursor-blinking*
3334 blinkon{N}
3335 blinkoff{N}
3336 blink times for cursor: blinkwait is the delay before
3337 the cursor starts blinking, blinkon is the time that
3338 the cursor is shown and blinkoff is the time that the
3339 cursor is not shown. The times are in msec. When one
3340 of the numbers is zero, there is no blinking. The
3341 default is: "blinkwait700-blinkon400-blinkoff250".
3342 These numbers are used for a missing entry. This
3343 means that blinking is enabled by default. To switch
3344 blinking off you can use "blinkon0". The cursor only
3345 blinks when Vim is waiting for input, not while
3346 executing a command.
3347 To make the cursor blink in an xterm, see
3348 |xterm-blink|.
3349 {group-name}
3350 a highlight group name, that sets the color and font
3351 for the cursor
3352 {group-name}/{group-name}
3353 Two highlight group names, the first is used when
3354 no language mappings are used, the other when they
3355 are. |language-mapping|
3356
3357 Examples of parts:
3358 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3359 block cursor with colors from the "nCursor"
3360 highlight group
3361 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3362 In Insert and Command-line Insert mode, use a
3363 30% vertical bar cursor with colors from the
3364 "iCursor" highlight group. Blink a bit
3365 faster.
3366
3367 The 'a' mode is different. It will set the given argument-list for
3368 all modes. It does not reset anything to defaults. This can be used
3369 to do a common setting for all modes. For example, to switch off
3370 blinking: "a:blinkon0"
3371
3372 Examples of cursor highlighting: >
3373 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3374 :highlight Cursor gui=NONE guifg=bg guibg=fg
3375<
3376 *'guifont'* *'gfn'*
3377 *E235* *E596* *E610* *E611*
3378'guifont' 'gfn' string (default "")
3379 global
3380 {not in Vi}
3381 {only available when compiled with GUI enabled}
3382 This is a list of fonts which will be used for the GUI version of Vim.
3383 In its simplest form the value is just one font name. When
3384 the font cannot be found you will get an error message. To try other
3385 font names a list can be specified, font names separated with commas.
3386 The first valid font is used.
Bram Moolenaared203462004-06-16 11:19:22 +00003387
Bram Moolenaar05159a02005-02-26 23:04:13 +00003388 On systems where 'guifontset' is supported (X11) and 'guifontset' is
3389 not empty, then 'guifont' is not used.
Bram Moolenaared203462004-06-16 11:19:22 +00003390
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 Spaces after a comma are ignored. To include a comma in a font name
3392 precede it with a backslash. Setting an option requires an extra
3393 backslash before a space and a backslash. See also
3394 |option-backslash|. For example: >
3395 :set guifont=Screen15,\ 7x13,font\\,with\\,commas
Bram Moolenaared203462004-06-16 11:19:22 +00003396< will make Vim try to use the font "Screen15" first, and if it fails it
Bram Moolenaar071d4272004-06-13 20:20:40 +00003397 will try to use "7x13" and then "font,with,commas" instead.
Bram Moolenaared203462004-06-16 11:19:22 +00003398
3399 If none of the fonts can be loaded, Vim will keep the current setting.
3400 If an empty font list is given, Vim will try using other resource
3401 settings (for X, it will use the Vim.font resource), and finally it
3402 will try some builtin default which should always be there ("7x13" in
3403 the case of X). The font names given should be "normal" fonts. Vim
3404 will try to find the related bold and italic fonts.
3405
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003406 For Win32, GTK, Motif, Mac OS and Photon: >
Bram Moolenaared203462004-06-16 11:19:22 +00003407 :set guifont=*
3408< will bring up a font requester, where you can pick the font you want.
3409
3410 The font name depends on the GUI used. See |setting-guifont| for a
3411 way to set 'guifont' for various systems.
3412
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 For the GTK+ 2 GUI the font name looks like this: >
3414 :set guifont=Andale\ Mono\ 11
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003415< That's all. XLFDs are not used. For Chinese this is reported to work
3416 well: >
3417 if has("gui_gtk2")
3418 set guifont=Bitstream\ Vera\ Sans\ Mono\ 12,Fixed\ 12
3419 set guifontwide=Microsoft\ Yahei\ 12,WenQuanYi\ Zen\ Hei\ 12
3420 endif
3421<
Bram Moolenaar05159a02005-02-26 23:04:13 +00003422 For Mac OSX you can use something like this: >
3423 :set guifont=Monaco:h10
Bram Moolenaar06a89a52006-04-29 22:01:03 +00003424< Also see 'macatsui', it can help fix display problems.
3425 *E236*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 Note that the fonts must be mono-spaced (all characters have the same
Bram Moolenaared203462004-06-16 11:19:22 +00003427 width). An exception is GTK 2: all fonts are accepted, but
3428 mono-spaced fonts look best.
3429
Bram Moolenaar071d4272004-06-13 20:20:40 +00003430 To preview a font on X11, you might be able to use the "xfontsel"
3431 program. The "xlsfonts" program gives a list of all available fonts.
Bram Moolenaared203462004-06-16 11:19:22 +00003432
Bram Moolenaar071d4272004-06-13 20:20:40 +00003433 For the Win32 GUI *E244* *E245*
3434 - takes these options in the font name:
3435 hXX - height is XX (points, can be floating-point)
3436 wXX - width is XX (points, can be floating-point)
3437 b - bold
3438 i - italic
3439 u - underline
3440 s - strikeout
Bram Moolenaar582fd852005-03-28 20:58:01 +00003441 cXX - character set XX. Valid charsets are: ANSI, ARABIC,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003442 BALTIC, CHINESEBIG5, DEFAULT, EASTEUROPE, GB2312, GREEK,
3443 HANGEUL, HEBREW, JOHAB, MAC, OEM, RUSSIAN, SHIFTJIS,
3444 SYMBOL, THAI, TURKISH, VIETNAMESE ANSI and BALTIC.
Bram Moolenaard4755bb2004-09-02 19:12:26 +00003445 Normally you would use "cDEFAULT".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003446
3447 Use a ':' to separate the options.
3448 - A '_' can be used in the place of a space, so you don't need to use
3449 backslashes to escape the spaces.
3450 - Examples: >
3451 :set guifont=courier_new:h12:w5:b:cRUSSIAN
3452 :set guifont=Andale_Mono:h7.5:w4.5
3453< See also |font-sizes|.
3454
3455 *'guifontset'* *'gfs'*
3456 *E250* *E252* *E234* *E597* *E598*
3457'guifontset' 'gfs' string (default "")
3458 global
3459 {not in Vi}
3460 {only available when compiled with GUI enabled and
3461 with the |+xfontset| feature}
3462 {not available in the GTK+ 2 GUI}
3463 When not empty, specifies two (or more) fonts to be used. The first
3464 one for normal English, the second one for your special language. See
3465 |xfontset|.
3466 Setting this option also means that all font names will be handled as
3467 a fontset name. Also the ones used for the "font" argument of the
3468 |:highlight| command.
3469 The fonts must match with the current locale. If fonts for the
3470 character sets that the current locale uses are not included, setting
3471 'guifontset' will fail.
3472 Note the difference between 'guifont' and 'guifontset': In 'guifont'
3473 the comma-separated names are alternative names, one of which will be
3474 used. In 'guifontset' the whole string is one fontset name,
3475 including the commas. It is not possible to specify alternative
3476 fontset names.
3477 This example works on many X11 systems: >
3478 :set guifontset=-*-*-medium-r-normal--16-*-*-*-c-*-*-*
3479<
3480 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3481'guifontwide' 'gfw' string (default "")
3482 global
3483 {not in Vi}
3484 {only available when compiled with GUI enabled}
3485 When not empty, specifies a comma-separated list of fonts to be used
3486 for double-width characters. The first font that can be loaded is
3487 used.
3488 Note: The size of these fonts must be exactly twice as wide as the one
3489 specified with 'guifont' and the same height.
3490
3491 All GUI versions but GTK+ 2:
3492
3493 'guifontwide' is only used when 'encoding' is set to "utf-8" and
3494 'guifontset' is empty or invalid.
3495 When 'guifont' is set and a valid font is found in it and
3496 'guifontwide' is empty Vim will attempt to find a matching
3497 double-width font and set 'guifontwide' to it.
3498
3499 GTK+ 2 GUI only: *guifontwide_gtk2*
3500
3501 If set and valid, 'guifontwide' is always used for double width
3502 characters, even if 'encoding' is not set to "utf-8".
3503 Vim does not attempt to find an appropriate value for 'guifontwide'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003504 automatically. If 'guifontwide' is empty Pango/Xft will choose the
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 font for characters not available in 'guifont'. Thus you do not need
3506 to set 'guifontwide' at all unless you want to override the choice
3507 made by Pango/Xft.
3508
3509 *'guiheadroom'* *'ghr'*
3510'guiheadroom' 'ghr' number (default 50)
3511 global
3512 {not in Vi} {only for GTK and X11 GUI}
3513 The number of pixels subtracted from the screen height when fitting
3514 the GUI window on the screen. Set this before the GUI is started,
3515 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003516 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003517 lines will be left for window decorations and other items on the
3518 screen. Set it to a negative value to allow windows taller than the
3519 screen.
3520
3521 *'guioptions'* *'go'*
3522'guioptions' 'go' string (default "gmrLtT" (MS-Windows),
Bram Moolenaar582fd852005-03-28 20:58:01 +00003523 "agimrLtT" (GTK, Motif and Athena))
Bram Moolenaar071d4272004-06-13 20:20:40 +00003524 global
3525 {not in Vi}
3526 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003527 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003528 sequence of letters which describes what components and options of the
3529 GUI should be used.
3530 To avoid problems with flags that are added in the future, use the
3531 "+=" and "-=" feature of ":set" |add-option-flags|.
3532
3533 Valid letters are as follows:
Bram Moolenaar02467872007-05-06 13:22:01 +00003534 *guioptions_a* *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 'a' Autoselect: If present, then whenever VISUAL mode is started,
3536 or the Visual area extended, Vim tries to become the owner of
3537 the windowing system's global selection. This means that the
3538 Visually highlighted text is available for pasting into other
3539 applications as well as into Vim itself. When the Visual mode
3540 ends, possibly due to an operation on the text, or when an
3541 application wants to paste the selection, the highlighted text
3542 is automatically yanked into the "* selection register.
3543 Thus the selection is still available for pasting into other
3544 applications after the VISUAL mode has ended.
3545 If not present, then Vim won't become the owner of the
3546 windowing system's global selection unless explicitly told to
3547 by a yank or delete operation for the "* register.
3548 The same applies to the modeless selection.
Bram Moolenaar02467872007-05-06 13:22:01 +00003549 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003550 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 applies to the modeless selection.
3552
3553 'guioptions' autoselect Visual autoselect modeless ~
3554 "" - -
3555 "a" yes yes
3556 "A" - yes
3557 "aA" yes yes
3558
Bram Moolenaar02467872007-05-06 13:22:01 +00003559 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003560 'c' Use console dialogs instead of popup dialogs for simple
3561 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003562 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003563 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003564 'guitablabel' can be used to change the text in the labels.
3565 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003566 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003567 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003568 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003569 'f' Foreground: Don't use fork() to detach the GUI from the shell
3570 where it was started. Use this for programs that wait for the
3571 editor to finish (e.g., an e-mail program). Alternatively you
3572 can use "gvim -f" or ":gui -f" to start the GUI in the
3573 foreground. |gui-fork|
3574 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003575 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003576 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003577 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3578 corner of the window. It's black&white on non-GTK, because of
3579 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003580 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003582 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003583 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003584 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003585 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003586 file is sourced the system menu has already been loaded; the
3587 ":syntax on" and ":filetype on" commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003588 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003589 'g' Grey menu items: Make menu items that are not active grey. If
3590 'g' is not included inactive menu items are not shown at all.
3591 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003592 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 't' Include tearoff menu items. Currently only works for Win32,
3594 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003595 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003596 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003597 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003598 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003599 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003600 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601 'R' Right-hand scrollbar is present when there is a vertically
3602 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003603 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003605 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003606 'L' Left-hand scrollbar is present when there is a vertically
3607 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003608 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003609 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3610 the longest visible line, or on the cursor line if the 'h'
3611 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003612 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003613 'h' Limit horizontal scrollbar size to the length of the cursor
3614 line. Reduces computations. |gui-horiz-scroll|
3615
3616 And yes, you may even have scrollbars on the left AND the right if
3617 you really want to :-). See |gui-scrollbars| for more information.
3618
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003619 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003620 'v' Use a vertical button layout for dialogs. When not included,
3621 a horizontal layout is preferred, but when it doesn't fit a
3622 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003623 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003624 'p' Use Pointer callbacks for X11 GUI. This is required for some
3625 window managers. If the cursor is not blinking or hollow at
3626 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003627 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003628 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003629 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003630 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003631
Bram Moolenaar02467872007-05-06 13:22:01 +00003632
Bram Moolenaar071d4272004-06-13 20:20:40 +00003633 *'guipty'* *'noguipty'*
3634'guipty' boolean (default on)
3635 global
3636 {not in Vi}
3637 {only available when compiled with GUI enabled}
3638 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3639 I/O to/from shell commands. See |gui-pty|.
3640
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003641 *'guitablabel'* *'gtl'*
3642'guitablabel' 'gtl' string (default empty)
3643 global
3644 {not in Vi}
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003645 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003646 with the |+windows| feature}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003647 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003648 pages line. When empty and when the result is empty Vim will use a
3649 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003650
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003651 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003652 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003653
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003654 Only used when the GUI tab pages line is displayed. 'e' must be
3655 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3656 used.
3657
Bram Moolenaar57657d82006-04-21 22:12:41 +00003658 *'guitabtooltip'* *'gtt'*
3659'guitabtooltip' 'gtt' string (default empty)
3660 global
3661 {not in Vi}
3662 {only available when compiled with GUI enabled and
Bram Moolenaardb84e452010-08-15 13:50:43 +02003663 with the |+windows| feature}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003664 When nonempty describes the text to use in a tooltip for the GUI tab
3665 pages line. When empty Vim will use a default tooltip.
3666 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003667 You can include a line break. Simplest method is to use |:let|: >
3668 :let &guitabtooltip = "line one\nline two"
3669<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003670
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 *'helpfile'* *'hf'*
3672'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3673 (others) "$VIMRUNTIME/doc/help.txt")
3674 global
3675 {not in Vi}
3676 Name of the main help file. All distributed help files should be
3677 placed together in one directory. Additionally, all "doc" directories
3678 in 'runtimepath' will be used.
3679 Environment variables are expanded |:set_env|. For example:
3680 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003681 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 spaces and backslashes.
3683 This option cannot be set from a |modeline| or in the |sandbox|, for
3684 security reasons.
3685
3686 *'helpheight'* *'hh'*
3687'helpheight' 'hh' number (default 20)
3688 global
3689 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003690 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003691 feature}
3692 Minimal initial height of the help window when it is opened with the
3693 ":help" command. The initial height of the help window is half of the
3694 current window, or (when the 'ea' option is on) the same as other
3695 windows. When the height is less than 'helpheight', the height is
3696 set to 'helpheight'. Set to zero to disable.
3697
3698 *'helplang'* *'hlg'*
3699'helplang' 'hlg' string (default: messages language or empty)
3700 global
3701 {only available when compiled with the |+multi_lang|
3702 feature}
3703 {not in Vi}
3704 Comma separated list of languages. Vim will use the first language
3705 for which the desired help can be found. The English help will always
3706 be used as a last resort. You can add "en" to prefer English over
3707 another language, but that will only find tags that exist in that
3708 language and not in the English help.
3709 Example: >
3710 :set helplang=de,it
3711< This will first search German, then Italian and finally English help
3712 files.
3713 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3714 try to find the tag in the current language before using this option.
3715 See |help-translated|.
3716
3717 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3718'hidden' 'hid' boolean (default off)
3719 global
3720 {not in Vi}
3721 When off a buffer is unloaded when it is |abandon|ed. When on a
3722 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3723 displayed in another window, it does not become hidden, of course.
3724 The commands that move through the buffer list sometimes make a buffer
3725 hidden although the 'hidden' option is off: When the buffer is
3726 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003727 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003728 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 This option is set for one command with ":hide {command}" |:hide|.
3730 WARNING: It's easy to forget that you have changes in hidden buffers.
3731 Think twice when using ":q!" or ":qa!".
3732
3733 *'highlight'* *'hl'*
3734'highlight' 'hl' string (default (as a single string):
3735 "8:SpecialKey,@:NonText,d:Directory,
3736 e:ErrorMsg,i:IncSearch,l:Search,m:MoreMsg,
3737 M:ModeMsg,n:LineNr,r:Question,
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003738 s:StatusLine,S:StatusLineNC,c:VertSplit,
Bram Moolenaar071d4272004-06-13 20:20:40 +00003739 t:Title,v:Visual,w:WarningMsg,W:WildMenu,
3740 f:Folded,F:FoldColumn,A:DiffAdd,
3741 C:DiffChange,D:DiffDelete,T:DiffText,
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003742 >:SignColumn,B:SpellBad,P:SpellCap,
Bram Moolenaar860cae12010-06-05 23:22:07 +02003743 R:SpellRare,L:SpellLocal,-:Conceal,
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003744 +:Pmenu,=:PmenuSel,
3745 x:PmenuSbar,X:PmenuThumb")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003746 global
3747 {not in Vi}
3748 This option can be used to set highlighting mode for various
3749 occasions. It is a comma separated list of character pairs. The
3750 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003751 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003752 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
3753 |hl-NonText| @ '~' and '@' at the end of the window and
3754 characters from 'showbreak'
3755 |hl-Directory| d directories in CTRL-D listing and other special
3756 things in listings
3757 |hl-ErrorMsg| e error messages
3758 h (obsolete, ignored)
3759 |hl-IncSearch| i 'incsearch' highlighting
3760 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3761 |hl-MoreMsg| m |more-prompt|
3762 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003763 |hl-LineNr| n line number for ":number" and ":#" commands, and
3764 when 'number' or 'relativenumber' option is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003765 |hl-Question| r |hit-enter| prompt and yes/no questions
3766 |hl-StatusLine| s status line of current window |status-line|
3767 |hl-StatusLineNC| S status lines of not-current windows
3768 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3769 |hl-VertSplit| c column used to separate vertically split windows
3770 |hl-Visual| v Visual mode
3771 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3772 Selection" Only X11 Gui's |gui-x11| and
3773 |xterm-clipboard|.
3774 |hl-WarningMsg| w warning messages
3775 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3776 |hl-Folded| f line used for closed folds
3777 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003778 |hl-DiffAdd| A added line in diff mode
3779 |hl-DiffChange| C changed line in diff mode
3780 |hl-DiffDelete| D deleted line in diff mode
3781 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003782 |hl-SignColumn| > column used for |signs|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003783 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003784 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003785 |hl-SpellRare| R rare word |spell|
3786 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar860cae12010-06-05 23:22:07 +02003787 |hl-Conceal| - the placeholders used for concealed characters
3788 (see 'conceallevel')
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00003789 |hl-Pmenu| + popup menu normal line
3790 |hl-PmenuSel| = popup menu normal line
3791 |hl-PmenuSbar| x popup menu scrollbar
3792 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793
3794 The display modes are:
3795 r reverse (termcap entry "mr" and "me")
3796 i italic (termcap entry "ZH" and "ZR")
3797 b bold (termcap entry "md" and "me")
3798 s standout (termcap entry "so" and "se")
3799 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003800 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 n no highlighting
3802 - no highlighting
3803 : use a highlight group
3804 The default is used for occasions that are not included.
3805 If you want to change what the display modes do, see |dos-colors|
3806 for an example.
3807 When using the ':' display mode, this must be followed by the name of
3808 a highlight group. A highlight group can be used to define any type
3809 of highlighting, including using color. See |:highlight| on how to
3810 define one. The default uses a different group for each occasion.
3811 See |highlight-default| for the default highlight groups.
3812
3813 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
3814'hlsearch' 'hls' boolean (default off)
3815 global
3816 {not in Vi}
3817 {not available when compiled without the
3818 |+extra_search| feature}
3819 When there is a previous search pattern, highlight all its matches.
3820 The type of highlighting used can be set with the 'l' occasion in the
3821 'highlight' option. This uses the "Search" highlight group by
3822 default. Note that only the matching text is highlighted, any offsets
3823 are not applied.
3824 See also: 'incsearch' and |:match|.
3825 When you get bored looking at the highlighted matches, you can turn it
3826 off with |:nohlsearch|. As soon as you use a search command, the
3827 highlighting comes back.
Bram Moolenaar446cb832008-06-24 21:56:24 +00003828 'redrawtime' specifies the maximum time spent on finding matches.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 When the search pattern can match an end-of-line, Vim will try to
3830 highlight all of the matched text. However, this depends on where the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003831 search starts. This will be the first line in the window or the first
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 line below a closed fold. A match in a previous line which is not
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003833 drawn may not continue in a newly drawn line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003834 NOTE: This option is reset when 'compatible' is set.
3835
3836 *'history'* *'hi'*
3837'history' 'hi' number (Vim default: 20, Vi default: 0)
3838 global
3839 {not in Vi}
3840 A history of ":" commands, and a history of previous search patterns
3841 are remembered. This option decides how many entries may be stored in
3842 each of these histories (see |cmdline-editing|).
3843 NOTE: This option is set to the Vi default value when 'compatible' is
3844 set and to the Vim default value when 'compatible' is reset.
3845
3846 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
3847'hkmap' 'hk' boolean (default off)
3848 global
3849 {not in Vi}
3850 {only available when compiled with the |+rightleft|
3851 feature}
3852 When on, the keyboard is mapped for the Hebrew character set.
3853 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
3854 toggle this option. See |rileft.txt|.
3855 NOTE: This option is reset when 'compatible' is set.
3856
3857 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
3858'hkmapp' 'hkp' boolean (default off)
3859 global
3860 {not in Vi}
3861 {only available when compiled with the |+rightleft|
3862 feature}
3863 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
3864 This is useful if you have a non-Hebrew keyboard.
3865 See |rileft.txt|.
3866 NOTE: This option is reset when 'compatible' is set.
3867
3868 *'icon'* *'noicon'*
3869'icon' boolean (default off, on when title can be restored)
3870 global
3871 {not in Vi}
3872 {not available when compiled without the |+title|
3873 feature}
3874 When on, the icon text of the window will be set to the value of
3875 'iconstring' (if it is not empty), or to the name of the file
3876 currently being edited. Only the last part of the name is used.
3877 Overridden by the 'iconstring' option.
3878 Only works if the terminal supports setting window icons (currently
3879 only X11 GUI and terminals with a non-empty 't_IS' option - these are
3880 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
3881 builtin termcap).
3882 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00003883 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 X11.
3885
3886 *'iconstring'*
3887'iconstring' string (default "")
3888 global
3889 {not in Vi}
3890 {not available when compiled without the |+title|
3891 feature}
3892 When this option is not empty, it will be used for the icon text of
3893 the window. This happens only when the 'icon' option is on.
3894 Only works if the terminal supports setting window icon text
3895 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
3896 Does not work for MS Windows.
3897 When Vim was compiled with HAVE_X11 defined, the original icon will be
3898 restored if possible |X11|.
3899 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003900 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 'titlestring' for example settings.
3902 {not available when compiled without the |+statusline| feature}
3903
3904 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
3905'ignorecase' 'ic' boolean (default off)
3906 global
3907 Ignore case in search patterns. Also used when searching in the tags
3908 file.
3909 Also see 'smartcase'.
3910 Can be overruled by using "\c" or "\C" in the pattern, see
3911 |/ignorecase|.
3912
3913 *'imactivatekey'* *'imak'*
3914'imactivatekey' 'imak' string (default "")
3915 global
3916 {not in Vi}
3917 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02003918 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 Specifies the key that your Input Method in X-Windows uses for
3920 activation. When this is specified correctly, vim can fully control
3921 IM with 'imcmdline', 'iminsert' and 'imsearch'.
3922 You can't use this option to change the activation key, the option
3923 tells Vim what the key is.
3924 Format:
3925 [MODIFIER_FLAG-]KEY_STRING
3926
3927 These characters can be used for MODIFIER_FLAG (case is ignored):
3928 S Shift key
3929 L Lock key
3930 C Control key
3931 1 Mod1 key
3932 2 Mod2 key
3933 3 Mod3 key
3934 4 Mod4 key
3935 5 Mod5 key
3936 Combinations are allowed, for example "S-C-space" or "SC-space" are
3937 both shift+ctrl+space.
3938 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
3939
3940 Example: >
3941 :set imactivatekey=S-space
3942< "S-space" means shift+space. This is the activation key for kinput2 +
3943 canna (Japanese), and ami (Korean).
3944
3945 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
3946'imcmdline' 'imc' boolean (default off)
3947 global
3948 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003949 {only available when compiled with the |+xim|,
3950 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003951 When set the Input Method is always on when starting to edit a command
3952 line, unless entering a search pattern (see 'imsearch' for that).
3953 Setting this option is useful when your input method allows entering
3954 English characters directly, e.g., when it's used to type accented
3955 characters with dead keys.
3956
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003957 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958'imdisable' 'imd' boolean (default off, on for some systems (SGI))
3959 global
3960 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02003961 {only available when compiled with the |+xim|,
3962 |+multi_byte_ime| or |global-ime| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003963 When set the Input Method is never used. This is useful to disable
3964 the IM when it doesn't work properly.
3965 Currently this option is on by default for SGI/IRIX machines. This
3966 may change in later releases.
3967
3968 *'iminsert'* *'imi'*
3969'iminsert' 'imi' number (default 0, 2 when an input method is supported)
3970 local to buffer
3971 {not in Vi}
3972 Specifies whether :lmap or an Input Method (IM) is to be used in
3973 Insert mode. Valid values:
3974 0 :lmap is off and IM is off
3975 1 :lmap is ON and IM is off
3976 2 :lmap is off and IM is ON
3977 2 is available only when compiled with the |+multi_byte_ime|, |+xim|
3978 or |global-ime|.
3979 To always reset the option to zero when leaving Insert mode with <Esc>
3980 this can be used: >
3981 :inoremap <ESC> <ESC>:set iminsert=0<CR>
3982< This makes :lmap and IM turn off automatically when leaving Insert
3983 mode.
3984 Note that this option changes when using CTRL-^ in Insert mode
3985 |i_CTRL-^|.
3986 The value is set to 1 when setting 'keymap' to a valid keymap name.
3987 It is also used for the argument of commands like "r" and "f".
3988 The value 0 may not work correctly with Athena and Motif with some XIM
3989 methods. Use 'imdisable' to disable XIM then.
3990
3991 *'imsearch'* *'ims'*
3992'imsearch' 'ims' number (default 0, 2 when an input method is supported)
3993 local to buffer
3994 {not in Vi}
3995 Specifies whether :lmap or an Input Method (IM) is to be used when
3996 entering a search pattern. Valid values:
3997 -1 the value of 'iminsert' is used, makes it look like
3998 'iminsert' is also used when typing a search pattern
3999 0 :lmap is off and IM is off
4000 1 :lmap is ON and IM is off
4001 2 :lmap is off and IM is ON
4002 Note that this option changes when using CTRL-^ in Command-line mode
4003 |c_CTRL-^|.
4004 The value is set to 1 when it is not -1 and setting the 'keymap'
4005 option to a valid keymap name.
4006 The value 0 may not work correctly with Athena and Motif with some XIM
4007 methods. Use 'imdisable' to disable XIM then.
4008
4009 *'include'* *'inc'*
4010'include' 'inc' string (default "^\s*#\s*include")
4011 global or local to buffer |global-local|
4012 {not in Vi}
4013 {not available when compiled without the
4014 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004015 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 pattern, just like for the "/" command (See |pattern|). The default
4017 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004018 "]I", "[d", etc.
4019 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004020 comes after the matched pattern. But if "\zs" appears in the pattern
4021 then the text matched from "\zs" to the end, or until "\ze" if it
4022 appears, is used as the file name. Use this to include characters
4023 that are not in 'isfname', such as a space. You can then use
4024 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004025 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026
4027 *'includeexpr'* *'inex'*
4028'includeexpr' 'inex' string (default "")
4029 local to buffer
4030 {not in Vi}
4031 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004032 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004033 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004034 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004035 :set includeexpr=substitute(v:fname,'\\.','/','g')
4036< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004037
Bram Moolenaar071d4272004-06-13 20:20:40 +00004038 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004039 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004040 Also used for |<cfile>|.
4041
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004042 The expression may be evaluated in the |sandbox|, see
4043 |sandbox-option|.
4044
4045 It is not allowed to change text or jump to another window while
4046 evaluating 'includeexpr' |textlock|.
4047
Bram Moolenaar071d4272004-06-13 20:20:40 +00004048 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
4049'incsearch' 'is' boolean (default off)
4050 global
4051 {not in Vi}
4052 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004053 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004054 While typing a search command, show where the pattern, as it was typed
4055 so far, matches. The matched string is highlighted. If the pattern
4056 is invalid or not found, nothing is shown. The screen will be updated
4057 often, this is only useful on fast terminals.
4058 Note that the match will be shown, but the cursor will return to its
4059 original position when no match is found and when pressing <Esc>. You
4060 still need to finish the search command with <Enter> to move the
4061 cursor to the match.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004062 When compiled with the |+reltime| feature Vim only searches for about
4063 half a second. With a complicated pattern and/or a lot of text the
4064 match may not be found. This is to avoid that Vim hangs while you
4065 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004066 The highlighting can be set with the 'i' flag in 'highlight'.
4067 See also: 'hlsearch'.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004068 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004069 to the command line. If 'ignorecase' and 'smartcase' are set and the
4070 command line has no uppercase characters, the added character is
4071 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004072 CTRL-R CTRL-W can be used to add the word at the end of the current
4073 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 NOTE: This option is reset when 'compatible' is set.
4075
4076 *'indentexpr'* *'inde'*
4077'indentexpr' 'inde' string (default "")
4078 local to buffer
4079 {not in Vi}
4080 {not available when compiled without the |+cindent|
4081 or |+eval| features}
4082 Expression which is evaluated to obtain the proper indent for a line.
4083 It is used when a new line is created, for the |=| operator and
4084 in Insert mode as specified with the 'indentkeys' option.
4085 When this option is not empty, it overrules the 'cindent' and
4086 'smartindent' indenting.
4087 When 'paste' is set this option is not used for indenting.
4088 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004089 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004090 when the expression is evaluated (but it may be moved around).
4091 The expression must return the number of spaces worth of indent. It
4092 can return "-1" to keep the current indent (this means 'autoindent' is
4093 used for the indent).
4094 Functions useful for computing the indent are |indent()|, |cindent()|
4095 and |lispindent()|.
4096 The evaluation of the expression must not have side effects! It must
4097 not change the text, jump to another window, etc. Afterwards the
4098 cursor position is always restored, thus the cursor may be moved.
4099 Normally this option would be set to call a function: >
4100 :set indentexpr=GetMyIndent()
4101< Error messages will be suppressed, unless the 'debug' option contains
4102 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004103 See |indent-expression|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004104 NOTE: This option is made empty when 'compatible' is set.
4105
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004106 The expression may be evaluated in the |sandbox|, see
4107 |sandbox-option|.
4108
4109 It is not allowed to change text or jump to another window while
4110 evaluating 'indentexpr' |textlock|.
4111
4112
Bram Moolenaar071d4272004-06-13 20:20:40 +00004113 *'indentkeys'* *'indk'*
4114'indentkeys' 'indk' string (default "0{,0},:,0#,!^F,o,O,e")
4115 local to buffer
4116 {not in Vi}
4117 {not available when compiled without the |+cindent|
4118 feature}
4119 A list of keys that, when typed in Insert mode, cause reindenting of
4120 the current line. Only happens if 'indentexpr' isn't empty.
4121 The format is identical to 'cinkeys', see |indentkeys-format|.
4122 See |C-indenting| and |indent-expression|.
4123
4124 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4125'infercase' 'inf' boolean (default off)
4126 local to buffer
4127 {not in Vi}
4128 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004129 'ignorecase' is also on, the case of the match is adjusted depending
4130 on the typed text. If the typed text contains a lowercase letter
4131 where the match has an upper case letter, the completed part is made
4132 lowercase. If the typed text has no lowercase letters and the match
4133 has a lowercase letter where the typed text has an uppercase letter,
4134 and there is a letter before it, the completed part is made uppercase.
4135 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004136
4137 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4138'insertmode' 'im' boolean (default off)
4139 global
4140 {not in Vi}
4141 Makes Vim work in a way that Insert mode is the default mode. Useful
4142 if you want to use Vim as a modeless editor. Used for |evim|.
4143 These Insert mode commands will be useful:
4144 - Use the cursor keys to move around.
4145 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|). When
4146 this is a mapping, it is executed as if 'insertmode' was off.
4147 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004149 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4150 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004151
4152 These items change when 'insertmode' is set:
4153 - when starting to edit of a file, Vim goes to Insert mode.
4154 - <Esc> in Insert mode is a no-op and beeps.
4155 - <Esc> in Normal mode makes Vim go to Insert mode.
4156 - CTRL-L in Insert mode is a command, it is not inserted.
4157 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4158 However, when <Esc> is used inside a mapping, it behaves like
4159 'insertmode' was not set. This was done to be able to use the same
4160 mappings with 'insertmode' set or not set.
4161 When executing commands with |:normal| 'insertmode' is not used.
4162
4163 NOTE: This option is reset when 'compatible' is set.
4164
4165 *'isfname'* *'isf'*
4166'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4167 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4168 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4169 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4170 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4171 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4172 global
4173 {not in Vi}
4174 The characters specified by this option are included in file names and
4175 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004176 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 Multi-byte characters 256 and above are always included, only the
4178 characters up to 255 are specified with this option.
4179 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004180 Think twice before adding white space to this option. Although a
4181 space may appear inside a file name, the effect will be that Vim
4182 doesn't know where a file name starts or ends when doing completion.
4183 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184
4185 Note that on systems using a backslash as path separator, Vim tries to
4186 do its best to make it work as you would expect. That is a bit
4187 tricky, since Vi originally used the backslash to escape special
4188 characters. Vim will not remove a backslash in front of a normal file
4189 name character on these systems, but it will on Unix and alikes. The
4190 '&' and '^' are not included by default, because these are special for
4191 cmd.exe.
4192
4193 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004194 Each part can be a single character number or a range. A range is two
4195 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 decimal number between 0 and 255 or the ASCII character itself (does
4197 not work for digits). Example:
4198 "_,-,128-140,#-43" (include '_' and '-' and the range
4199 128 to 140 and '#' to 43)
4200 If a part starts with '^', the following character number or range
4201 will be excluded from the option. The option is interpreted from left
4202 to right. Put the excluded character after the range where it is
4203 included. To include '^' itself use it as the last character of the
4204 option or the end of a range. Example:
4205 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4206 If the character is '@', all characters where isalpha() returns TRUE
4207 are included. Normally these are the characters a to z and A to Z,
4208 plus accented characters. To include '@' itself use "@-@". Examples:
4209 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004210 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004211 "a-z,A-Z,@-@" All letters plus the '@' character.
4212 A comma can be included by using it where a character number is
4213 expected. Example:
4214 "48-57,,,_" Digits, comma and underscore.
4215 A comma can be excluded by prepending a '^'. Example:
4216 " -~,^,,9" All characters from space to '~', excluding
4217 comma, plus <Tab>.
4218 See |option-backslash| about including spaces and backslashes.
4219
4220 *'isident'* *'isi'*
4221'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4222 "@,48-57,_,128-167,224-235"
4223 otherwise: "@,48-57,_,192-255")
4224 global
4225 {not in Vi}
4226 The characters given by this option are included in identifiers.
4227 Identifiers are used in recognizing environment variables and after a
4228 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004229 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar071d4272004-06-13 20:20:40 +00004230 option.
4231 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004232 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004233 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4234
4235 *'iskeyword'* *'isk'*
4236'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4237 "@,48-57,_,128-167,224-235"
4238 otherwise: "@,48-57,_,192-255"
4239 Vi default: "@,48-57,_")
4240 local to buffer
4241 {not in Vi}
4242 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004243 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004244 'isfname' for a description of the format of this option. For C
4245 programs you could use "a-z,A-Z,48-57,_,.,-,>".
4246 For a help file it is set to all non-blank printable characters except
4247 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4248 command).
4249 When the 'lisp' option is on the '-' character is always included.
4250 NOTE: This option is set to the Vi default value when 'compatible' is
4251 set and to the Vim default value when 'compatible' is reset.
4252
4253 *'isprint'* *'isp'*
4254'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4255 "@,~-255"; otherwise: "@,161-255")
4256 global
4257 {not in Vi}
4258 The characters given by this option are displayed directly on the
4259 screen. It is also used for "\p" in a |pattern|. The characters from
4260 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4261 even when they are not included in 'isprint' or excluded. See
4262 'isfname' for a description of the format of this option.
4263
4264 Non-printable characters are displayed with two characters:
4265 0 - 31 "^@" - "^_"
4266 32 - 126 always single characters
4267 127 "^?"
4268 128 - 159 "~@" - "~_"
4269 160 - 254 "| " - "|~"
4270 255 "~?"
4271 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4272 displayed as <xx>, with the hexadecimal value of the byte.
4273 When 'display' contains "uhex" all unprintable characters are
4274 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004275 The SpecialKey highlighting will be used for unprintable characters.
4276 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277
4278 Multi-byte characters 256 and above are always included, only the
4279 characters up to 255 are specified with this option. When a character
4280 is printable but it is not available in the current font, a
4281 replacement character will be shown.
4282 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4283 There is no option to specify these characters.
4284
4285 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4286'joinspaces' 'js' boolean (default on)
4287 global
4288 {not in Vi}
4289 Insert two spaces after a '.', '?' and '!' with a join command.
4290 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4291 Otherwise only one space is inserted.
4292 NOTE: This option is set when 'compatible' is set.
4293
4294 *'key'*
4295'key' string (default "")
4296 local to buffer
4297 {not in Vi}
Bram Moolenaar996343d2010-07-04 22:20:21 +02004298 {only available when compiled with the |+cryptv|
4299 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004300 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004301 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004302 Careful: Do not set the key value by hand, someone might see the typed
4303 key. Use the |:X| command. But you can make 'key' empty: >
4304 :set key=
4305< It is not possible to get the value of this option with ":set key" or
4306 "echo &key". This is to avoid showing it to someone who shouldn't
4307 know. It also means you cannot see it yourself once you have set it,
4308 be careful not to make a typing error!
4309
4310 *'keymap'* *'kmp'* *E544*
4311'keymap' 'kmp' string (default "")
4312 local to buffer
4313 {not in Vi}
4314 {only available when compiled with the |+keymap|
4315 feature}
4316 Name of a keyboard mapping. See |mbyte-keymap|.
4317 Setting this option to a valid keymap name has the side effect of
4318 setting 'iminsert' to one, so that the keymap becomes effective.
4319 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004320 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004321
4322 *'keymodel'* *'km'*
4323'keymodel' 'km' string (default "")
4324 global
4325 {not in Vi}
4326 List of comma separated words, which enable special things that keys
4327 can do. These values can be used:
4328 startsel Using a shifted special key starts selection (either
4329 Select mode or Visual mode, depending on "key" being
4330 present in 'selectmode').
4331 stopsel Using a not-shifted special key stops selection.
4332 Special keys in this context are the cursor keys, <End>, <Home>,
4333 <PageUp> and <PageDown>.
4334 The 'keymodel' option is set by the |:behave| command.
4335
4336 *'keywordprg'* *'kp'*
4337'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
4338 OS/2: "view /", VMS: "help")
4339 global or local to buffer |global-local|
4340 {not in Vi}
4341 Program to use for the |K| command. Environment variables are
4342 expanded |:set_env|. ":help" may be used to access the Vim internal
4343 help. (Note that previously setting the global option to the empty
4344 value did this, which is now deprecated.)
4345 When "man" is used, Vim will automatically translate a count for the
4346 "K" command to a section number. Also for "man -s", in which case the
4347 "-s" is removed when there is no count.
4348 See |option-backslash| about including spaces and backslashes.
4349 Example: >
4350 :set keywordprg=man\ -s
4351< This option cannot be set from a |modeline| or in the |sandbox|, for
4352 security reasons.
4353
4354 *'langmap'* *'lmap'* *E357* *E358*
4355'langmap' 'lmap' string (default "")
4356 global
4357 {not in Vi}
4358 {only available when compiled with the |+langmap|
4359 feature}
4360 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004361 mode. When you are typing text in Insert mode the characters are
Bram Moolenaar071d4272004-06-13 20:20:40 +00004362 inserted directly. When in command mode the 'langmap' option takes
4363 care of translating these special characters to the original meaning
4364 of the key. This means you don't have to change the keyboard mode to
4365 be able to execute Normal mode commands.
4366 This is the opposite of the 'keymap' option, where characters are
4367 mapped in Insert mode.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004369 Example (for Greek, in UTF-8): *greek* >
4370 :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 +00004371< Example (exchanges meaning of z and y for commands): >
4372 :set langmap=zy,yz,ZY,YZ
4373<
4374 The 'langmap' option is a list of parts, separated with commas. Each
4375 part can be in one of two forms:
4376 1. A list of pairs. Each pair is a "from" character immediately
4377 followed by the "to" character. Examples: "aA", "aAbBcC".
4378 2. A list of "from" characters, a semi-colon and a list of "to"
4379 characters. Example: "abc;ABC"
4380 Example: "aA,fgh;FGH,cCdDeE"
4381 Special characters need to be preceded with a backslash. These are
4382 ";", ',' and backslash itself.
4383
4384 This will allow you to activate vim actions without having to switch
4385 back and forth between the languages. Your language characters will
4386 be understood as normal vim English characters (according to the
4387 langmap mappings) in the following cases:
4388 o Normal/Visual mode (commands, buffer/register names, user mappings)
4389 o Insert/Replace Mode: Register names after CTRL-R
4390 o Insert/Replace Mode: Mappings
4391 Characters entered in Command-line mode will NOT be affected by
4392 this option. Note that this option can be changed at any time
4393 allowing to switch between mappings for different languages/encodings.
4394 Use a mapping to avoid having to type it each time!
4395
4396 *'langmenu'* *'lm'*
4397'langmenu' 'lm' string (default "")
4398 global
4399 {not in Vi}
4400 {only available when compiled with the |+menu| and
4401 |+multi_lang| features}
4402 Language to use for menu translation. Tells which file is loaded
4403 from the "lang" directory in 'runtimepath': >
4404 "lang/menu_" . &langmenu . ".vim"
4405< (without the spaces). For example, to always use the Dutch menus, no
4406 matter what $LANG is set to: >
4407 :set langmenu=nl_NL.ISO_8859-1
4408< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004409 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 If your $LANG is set to a non-English language but you do want to use
4411 the English menus: >
4412 :set langmenu=none
4413< This option must be set before loading menus, switching on filetype
4414 detection or syntax highlighting. Once the menus are defined setting
4415 this option has no effect. But you could do this: >
4416 :source $VIMRUNTIME/delmenu.vim
4417 :set langmenu=de_DE.ISO_8859-1
4418 :source $VIMRUNTIME/menu.vim
4419< Warning: This deletes all menus that you defined yourself!
4420
4421 *'laststatus'* *'ls'*
4422'laststatus' 'ls' number (default 1)
4423 global
4424 {not in Vi}
4425 The value of this option influences when the last window will have a
4426 status line:
4427 0: never
4428 1: only if there are at least two windows
4429 2: always
4430 The screen looks nicer with a status line if you have several
4431 windows, but it takes another screen line. |status-line|
4432
4433 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4434'lazyredraw' 'lz' boolean (default off)
4435 global
4436 {not in Vi}
4437 When this option is set, the screen will not be redrawn while
4438 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 update use |:redraw|.
4441
4442 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4443'linebreak' 'lbr' boolean (default off)
4444 local to window
4445 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004446 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447 feature}
4448 If on Vim will wrap long lines at a character in 'breakat' rather
4449 than at the last character that fits on the screen. Unlike
4450 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
4451 it only affects the way the file is displayed, not its contents. The
4452 value of 'showbreak' is used to put in front of wrapped lines.
4453 This option is not used when the 'wrap' option is off or 'list' is on.
4454 Note that <Tab> characters after an <EOL> are mostly not displayed
4455 with the right amount of white space.
4456
4457 *'lines'* *E593*
4458'lines' number (default 24 or terminal height)
4459 global
4460 Number of lines of the Vim window.
4461 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004462 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004463 When Vim is running in the GUI or in a resizable window, setting this
4464 option will cause the window size to be changed. When you only want
4465 to use the size for the GUI, put the command in your |gvimrc| file.
4466 Vim limits the number of lines to what fits on the screen. You can
4467 use this command to get the tallest window possible: >
4468 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004469< Minimum value is 2, maximum value is 1000.
4470 If you get less lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004471 When you set this option and Vim is unable to change the physical
4472 number of lines of the display, the display may be messed up.
4473
4474 *'linespace'* *'lsp'*
4475'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4476 global
4477 {not in Vi}
4478 {only in the GUI}
4479 Number of pixel lines inserted between characters. Useful if the font
4480 uses the full character cell height, making lines touch each other.
4481 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004482 With some fonts there can be too much room between lines (to have
4483 space for ascents and descents). Then it makes sense to set
4484 'linespace' to a negative value. This may cause display problems
4485 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004486
4487 *'lisp'* *'nolisp'*
4488'lisp' boolean (default off)
4489 local to buffer
4490 {not available when compiled without the |+lispindent|
4491 feature}
4492 Lisp mode: When <Enter> is typed in insert mode set the indent for
4493 the next line to Lisp standards (well, sort of). Also happens with
4494 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4495 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4496 better. Also see 'lispwords'.
4497 The '-' character is included in keyword characters. Redefines the
4498 "=" operator to use this same indentation algorithm rather than
4499 calling an external program if 'equalprg' is empty.
4500 This option is not used when 'paste' is set.
4501 {Vi: Does it a little bit differently}
4502
4503 *'lispwords'* *'lw'*
4504'lispwords' 'lw' string (default is very long)
4505 global
4506 {not in Vi}
4507 {not available when compiled without the |+lispindent|
4508 feature}
4509 Comma separated list of words that influence the Lisp indenting.
4510 |'lisp'|
4511
4512 *'list'* *'nolist'*
4513'list' boolean (default off)
4514 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004515 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4516 line. Useful to see the difference between tabs and spaces and for
4517 trailing blanks. Further changed by the 'listchars' option.
4518
4519 The cursor is displayed at the start of the space a Tab character
4520 occupies, not at the end as usual in Normal mode. To get this cursor
4521 position while displaying Tabs with spaces, use: >
4522 :set list lcs=tab\ \
4523<
4524 Note that list mode will also affect formatting (set with 'textwidth'
4525 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004526 changing the way tabs are displayed.
4527
4528 *'listchars'* *'lcs'*
4529'listchars' 'lcs' string (default "eol:$")
4530 global
4531 {not in Vi}
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004532 Strings to use in 'list' mode and for the |:list| command. It is a
4533 comma separated list of string settings.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004534 eol:c Character to show at the end of each line. When
4535 omitted, there is no extra character at the end of the
4536 line.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004537 tab:xy Two characters to be used to show a tab. The first
Bram Moolenaar071d4272004-06-13 20:20:40 +00004538 char is used once. The second char is repeated to
Bram Moolenaarebcbd022007-05-12 14:28:25 +00004539 fill the space that the tab normally occupies.
4540 "tab:>-" will show a tab that takes four spaces as
4541 ">---". When omitted, a tab is show as ^I.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004542 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar071d4272004-06-13 20:20:40 +00004543 trailing spaces are blank.
4544 extends:c Character to show in the last column, when 'wrap' is
4545 off and the line continues beyond the right of the
4546 screen.
4547 precedes:c Character to show in the first column, when 'wrap'
4548 is off and there is text preceding the character
4549 visible in the first column.
Bram Moolenaar860cae12010-06-05 23:22:07 +02004550 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004551 'conceallevel' is set to 1.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00004552 nbsp:c Character to show for a non-breakable space (character
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00004553 0xA0, 160). Left blank when omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004555 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004557 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004558
4559 Examples: >
4560 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004561 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004562 :set lcs=extends:>,precedes:<
4563< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004564 "precedes". "SpecialKey" for "nbsp", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004565 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566
4567 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4568'loadplugins' 'lpl' boolean (default on)
4569 global
4570 {not in Vi}
4571 When on the plugin scripts are loaded when starting up |load-plugins|.
4572 This option can be reset in your |vimrc| file to disable the loading
4573 of plugins.
4574 Note that using the "-u NONE" and "--noplugin" command line arguments
4575 reset this option. |-u| |--noplugin|
4576
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004577 *'macatsui'* *'nomacatsui'*
4578'macatsui' boolean (default on)
4579 global
4580 {only available in Mac GUI version}
4581 This is a workaround for when drawing doesn't work properly. When set
4582 and compiled with multi-byte support ATSUI text drawing is used. When
4583 not set ATSUI text drawing is not used. Switch this option off when
4584 you experience drawing problems. In a future version the problems may
4585 be solved and this option becomes obsolete. Therefore use this method
4586 to unset it: >
4587 if exists('&macatsui')
4588 set nomacatsui
4589 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004590< Another option to check if you have drawing problems is
4591 'termencoding'.
4592
Bram Moolenaar071d4272004-06-13 20:20:40 +00004593 *'magic'* *'nomagic'*
4594'magic' boolean (default on)
4595 global
4596 Changes the special characters that can be used in search patterns.
4597 See |pattern|.
4598 NOTE: To avoid portability problems with using patterns, always keep
4599 this option at the default "on". Only switch it off when working with
4600 old Vi scripts. In any other situation write patterns that work when
Bram Moolenaar5eb86f92004-07-26 12:53:41 +00004601 'magic' is on. Include "\M" when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602
4603 *'makeef'* *'mef'*
4604'makeef' 'mef' string (default: "")
4605 global
4606 {not in Vi}
4607 {not available when compiled without the |+quickfix|
4608 feature}
4609 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4610 and the |:grep| command.
4611 When it is empty, an internally generated temp file will be used.
4612 When "##" is included, it is replaced by a number to make the name
4613 unique. This makes sure that the ":make" command doesn't overwrite an
4614 existing file.
4615 NOT used for the ":cf" command. See 'errorfile' for that.
4616 Environment variables are expanded |:set_env|.
4617 See |option-backslash| about including spaces and backslashes.
4618 This option cannot be set from a |modeline| or in the |sandbox|, for
4619 security reasons.
4620
4621 *'makeprg'* *'mp'*
4622'makeprg' 'mp' string (default "make", VMS: "MMS")
4623 global or local to buffer |global-local|
4624 {not in Vi}
Bram Moolenaar02467872007-05-06 13:22:01 +00004625 Program to use for the ":make" command. See |:make_makeprg|.
4626 This option may contain '%' and '#' characters, which are expanded to
4627 the current and alternate file name. |:_%| |:_#|
4628 Environment variables are expanded |:set_env|. See |option-backslash|
4629 about including spaces and backslashes.
4630 Note that a '|' must be escaped twice: once for ":set" and once for
4631 the interpretation of a command. When you use a filter called
4632 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 :set makeprg=gmake\ \\\|\ myfilter
4634< The placeholder "$*" can be given (even multiple times) to specify
4635 where the arguments will be included, for example: >
4636 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4637< This option cannot be set from a |modeline| or in the |sandbox|, for
4638 security reasons.
4639
4640 *'matchpairs'* *'mps'*
4641'matchpairs' 'mps' string (default "(:),{:},[:]")
4642 local to buffer
4643 {not in Vi}
4644 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaar02467872007-05-06 13:22:01 +00004645 other. Currently only single byte character pairs are allowed, and
4646 they must be different. The characters must be separated by a colon.
4647 The pairs must be separated by a comma. Example for including '<' and
4648 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004649 :set mps+=<:>
4650
4651< A more exotic example, to jump between the '=' and ';' in an
4652 assignment, useful for languages like C and Java: >
4653 :au FileType c,cpp,java set mps+==:;
4654
4655< For a more advanced way of using "%", see the matchit.vim plugin in
4656 the $VIMRUNTIME/macros directory. |add-local-help|
4657
4658 *'matchtime'* *'mat'*
4659'matchtime' 'mat' number (default 5)
4660 global
4661 {not in Vi}{in Nvi}
4662 Tenths of a second to show the matching paren, when 'showmatch' is
4663 set. Note that this is not in milliseconds, like other options that
4664 set a time. This is to be compatible with Nvi.
4665
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004666 *'maxcombine'* *'mco'*
4667'maxcombine' 'mco' number (default 2)
4668 global
4669 {not in Vi}
4670 {only available when compiled with the |+multi_byte|
4671 feature}
4672 The maximum number of combining characters supported for displaying.
4673 Only used when 'encoding' is "utf-8".
4674 The default is OK for most languages. Hebrew may require 4.
4675 Maximum value is 6.
4676 Even when this option is set to 2 you can still edit text with more
4677 combining characters, you just can't see them. Use |g8| or |ga|.
4678 See |mbyte-combining|.
4679
Bram Moolenaar071d4272004-06-13 20:20:40 +00004680 *'maxfuncdepth'* *'mfd'*
4681'maxfuncdepth' 'mfd' number (default 100)
4682 global
4683 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02004684 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004685 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004686 Maximum depth of function calls for user functions. This normally
4687 catches endless recursion. When using a recursive function with
4688 more depth, set 'maxfuncdepth' to a bigger number. But this will use
4689 more memory, there is the danger of failing when memory is exhausted.
4690 See also |:function|.
4691
4692 *'maxmapdepth'* *'mmd'* *E223*
4693'maxmapdepth' 'mmd' number (default 1000)
4694 global
4695 {not in Vi}
4696 Maximum number of times a mapping is done without resulting in a
4697 character to be used. This normally catches endless mappings, like
4698 ":map x y" with ":map y x". It still does not catch ":map g wg",
4699 because the 'w' is used before the next mapping is done. See also
4700 |key-mapping|.
4701
4702 *'maxmem'* *'mm'*
4703'maxmem' 'mm' number (default between 256 to 5120 (system
4704 dependent) or half the amount of memory
4705 available)
4706 global
4707 {not in Vi}
4708 Maximum amount of memory (in Kbyte) to use for one buffer. When this
4709 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004710 other memory to be freed. The maximum usable value is about 2000000.
4711 Use this to work without a limit. Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004713 *'maxmempattern'* *'mmp'*
4714'maxmempattern' 'mmp' number (default 1000)
4715 global
4716 {not in Vi}
4717 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004718 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004719 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00004720 When Vim runs into the limit it gives an error message and mostly
4721 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00004722 Running into the limit often means that the pattern is very
4723 inefficient or too complex. This may already happen with the pattern
4724 "\(.\)*" on a very long line. ".*" works much better.
4725 Vim may run out of memory before hitting the 'maxmempattern' limit.
4726
Bram Moolenaar071d4272004-06-13 20:20:40 +00004727 *'maxmemtot'* *'mmt'*
4728'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
4729 dependent) or half the amount of memory
4730 available)
4731 global
4732 {not in Vi}
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004733 Maximum amount of memory in Kbyte to use for all buffers together.
4734 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
4735 without a limit. On 64 bit machines higher values might work. But
4736 hey, do you really need more than 2 Gbyte for text editing?
4737 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004738
4739 *'menuitems'* *'mis'*
4740'menuitems' 'mis' number (default 25)
4741 global
4742 {not in Vi}
4743 {not available when compiled without the |+menu|
4744 feature}
4745 Maximum number of items to use in a menu. Used for menus that are
4746 generated from a list of items, e.g., the Buffers menu. Changing this
4747 option has no direct effect, the menu must be refreshed first.
4748
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00004749 *'mkspellmem'* *'msm'*
4750'mkspellmem' 'msm' string (default "460000,2000,500")
4751 global
4752 {not in Vi}
4753 {not available when compiled without the |+syntax|
4754 feature}
4755 Parameters for |:mkspell|. This tunes when to start compressing the
4756 word tree. Compression can be slow when there are many words, but
4757 it's needed to avoid running out of memory. The amount of memory used
4758 per word depends very much on how similar the words are, that's why
4759 this tuning is complicated.
4760
4761 There are three numbers, separated by commas:
4762 {start},{inc},{added}
4763
4764 For most languages the uncompressed word tree fits in memory. {start}
4765 gives the amount of memory in Kbyte that can be used before any
4766 compression is done. It should be a bit smaller than the amount of
4767 memory that is available to Vim.
4768
4769 When going over the {start} limit the {inc} number specifies the
4770 amount of memory in Kbyte that can be allocated before another
4771 compression is done. A low number means compression is done after
4772 less words are added, which is slow. A high number means more memory
4773 will be allocated.
4774
4775 After doing compression, {added} times 1024 words can be added before
4776 the {inc} limit is ignored and compression is done when any extra
4777 amount of memory is needed. A low number means there is a smaller
4778 chance of hitting the {inc} limit, less memory is used but it's
4779 slower.
4780
4781 The languages for which these numbers are important are Italian and
4782 Hungarian. The default works for when you have about 512 Mbyte. If
4783 you have 1 Gbyte you could use: >
4784 :set mkspellmem=900000,3000,800
4785< If you have less than 512 Mbyte |:mkspell| may fail for some
4786 languages, no matter what you set 'mkspellmem' to.
4787
Bram Moolenaar071d4272004-06-13 20:20:40 +00004788 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00004789'modeline' 'ml' boolean (Vim default: on (off for root),
4790 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004791 local to buffer
4792 *'modelines'* *'mls'*
4793'modelines' 'mls' number (default 5)
4794 global
4795 {not in Vi}
4796 If 'modeline' is on 'modelines' gives the number of lines that is
4797 checked for set commands. If 'modeline' is off or 'modelines' is zero
4798 no lines are checked. See |modeline|.
4799 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
4800 set and to the Vim default value when 'compatible' is reset.
4801
4802 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
4803'modifiable' 'ma' boolean (default on)
4804 local to buffer
4805 {not in Vi} *E21*
4806 When off the buffer contents cannot be changed. The 'fileformat' and
4807 'fileencoding' options also can't be changed.
4808 Can be reset with the |-M| command line argument.
4809
4810 *'modified'* *'mod'* *'nomodified'* *'nomod'*
4811'modified' 'mod' boolean (default off)
4812 local to buffer
4813 {not in Vi}
4814 When on, the buffer is considered to be modified. This option is set
4815 when:
4816 1. A change was made to the text since it was last written. Using the
4817 |undo| command to go back to the original text will reset the
4818 option. But undoing changes that were made before writing the
4819 buffer will set the option again, since the text is different from
4820 when it was written.
4821 2. 'fileformat' or 'fileencoding' is different from its original
4822 value. The original value is set when the buffer is read or
4823 written. A ":set nomodified" command also resets the original
4824 values to the current values and the 'modified' option will be
4825 reset.
4826 When 'buftype' is "nowrite" or "nofile" this option may be set, but
4827 will be ignored.
4828
4829 *'more'* *'nomore'*
4830'more' boolean (Vim default: on, Vi default: off)
4831 global
4832 {not in Vi}
4833 When on, listings pause when the whole screen is filled. You will get
4834 the |more-prompt|. When this option is off there are no pauses, the
4835 listing continues until finished.
4836 NOTE: This option is set to the Vi default value when 'compatible' is
4837 set and to the Vim default value when 'compatible' is reset.
4838
4839 *'mouse'* *E538*
4840'mouse' string (default "", "a" for GUI, MS-DOS and Win32)
4841 global
4842 {not in Vi}
4843 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00004844 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
4845 sysmouse and Linux console with gpm). For using the mouse in the
4846 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847 The mouse can be enabled for different modes:
4848 n Normal mode
4849 v Visual mode
4850 i Insert mode
4851 c Command-line mode
4852 h all previous modes when editing a help file
4853 a all previous modes
4854 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855 Normally you would enable the mouse in all four modes with: >
4856 :set mouse=a
4857< When the mouse is not enabled, the GUI will still use the mouse for
4858 modeless selection. This doesn't move the text cursor.
4859
4860 See |mouse-using|. Also see |'clipboard'|.
4861
4862 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004863 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864 the mouse buttons can still be used by keeping the shift key pressed.
4865 Also see the 'clipboard' option.
4866
4867 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
4868'mousefocus' 'mousef' boolean (default off)
4869 global
4870 {not in Vi}
4871 {only works in the GUI}
4872 The window that the mouse pointer is on is automatically activated.
4873 When changing the window layout or window focus in another way, the
4874 mouse pointer is moved to the window with keyboard focus. Off is the
4875 default because it makes using the pull down menus a little goofy, as
4876 a pointer transit may activate a window unintentionally.
4877
4878 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
4879'mousehide' 'mh' boolean (default on)
4880 global
4881 {not in Vi}
4882 {only works in the GUI}
4883 When on, the mouse pointer is hidden when characters are typed.
4884 The mouse pointer is restored when the mouse is moved.
4885
4886 *'mousemodel'* *'mousem'*
4887'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
4888 global
4889 {not in Vi}
4890 Sets the model to use for the mouse. The name mostly specifies what
4891 the right mouse button is used for:
4892 extend Right mouse button extends a selection. This works
4893 like in an xterm.
4894 popup Right mouse button pops up a menu. The shifted left
4895 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00004896 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004897 popup_setpos Like "popup", but the cursor will be moved to the
4898 position where the mouse was clicked, and thus the
4899 selected operation will act upon the clicked object.
4900 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00004901 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902 course, that right clicking outside a selection will
4903 end Visual mode.
4904 Overview of what button does what for each model:
4905 mouse extend popup(_setpos) ~
4906 left click place cursor place cursor
4907 left drag start selection start selection
4908 shift-left search word extend selection
4909 right click extend selection popup menu (place cursor)
4910 right drag extend selection -
4911 middle click paste paste
4912
4913 In the "popup" model the right mouse button produces a pop-up menu.
4914 You need to define this first, see |popup-menu|.
4915
4916 Note that you can further refine the meaning of buttons with mappings.
4917 See |gui-mouse-mapping|. But mappings are NOT used for modeless
4918 selection (because that's handled in the GUI code directly).
4919
4920 The 'mousemodel' option is set by the |:behave| command.
4921
4922 *'mouseshape'* *'mouses'* *E547*
4923'mouseshape' 'mouses' string (default "i:beam,r:beam,s:updown,sd:cross,
Bram Moolenaar582fd852005-03-28 20:58:01 +00004924 m:no,ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004925 global
4926 {not in Vi}
4927 {only available when compiled with the |+mouseshape|
4928 feature}
4929 This option tells Vim what the mouse pointer should look like in
4930 different modes. The option is a comma separated list of parts, much
4931 like used for 'guicursor'. Each part consist of a mode/location-list
4932 and an argument-list:
4933 mode-list:shape,mode-list:shape,..
4934 The mode-list is a dash separated list of these modes/locations:
4935 In a normal window: ~
4936 n Normal mode
4937 v Visual mode
4938 ve Visual mode with 'selection' "exclusive" (same as 'v',
4939 if not specified)
4940 o Operator-pending mode
4941 i Insert mode
4942 r Replace mode
4943
4944 Others: ~
4945 c appending to the command-line
4946 ci inserting in the command-line
4947 cr replacing in the command-line
4948 m at the 'Hit ENTER' or 'More' prompts
4949 ml idem, but cursor in the last line
4950 e any mode, pointer below last window
4951 s any mode, pointer on a status line
4952 sd any mode, while dragging a status line
4953 vs any mode, pointer on a vertical separator line
4954 vd any mode, while dragging a vertical separator line
4955 a everywhere
4956
4957 The shape is one of the following:
4958 avail name looks like ~
4959 w x arrow Normal mouse pointer
4960 w x blank no pointer at all (use with care!)
4961 w x beam I-beam
4962 w x updown up-down sizing arrows
4963 w x leftright left-right sizing arrows
4964 w x busy The system's usual busy pointer
4965 w x no The system's usual 'no input' pointer
4966 x udsizing indicates up-down resizing
4967 x lrsizing indicates left-right resizing
4968 x crosshair like a big thin +
4969 x hand1 black hand
4970 x hand2 white hand
4971 x pencil what you write with
4972 x question big ?
4973 x rightup-arrow arrow pointing right-up
4974 w x up-arrow arrow pointing up
4975 x <number> any X11 pointer number (see X11/cursorfont.h)
4976
4977 The "avail" column contains a 'w' if the shape is available for Win32,
4978 x for X11.
4979 Any modes not specified or shapes not available use the normal mouse
4980 pointer.
4981
4982 Example: >
4983 :set mouseshape=s:udsizing,m:no
4984< will make the mouse turn to a sizing arrow over the status lines and
4985 indicate no input when the hit-enter prompt is displayed (since
4986 clicking the mouse has no effect in this state.)
4987
4988 *'mousetime'* *'mouset'*
4989'mousetime' 'mouset' number (default 500)
4990 global
4991 {not in Vi}
4992 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
4993 time in msec between two mouse clicks for the second click to be
4994 recognized as a multi click.
4995
Bram Moolenaar325b7a22004-07-05 15:58:32 +00004996 *'mzquantum'* *'mzq'*
4997'mzquantum' 'mzq' number (default 100)
4998 global
4999 {not in Vi}
5000 {not available when compiled without the |+mzscheme|
5001 feature}
5002 The number of milliseconds between polls for MzScheme threads.
5003 Negative or zero value means no thread scheduling.
5004
Bram Moolenaar071d4272004-06-13 20:20:40 +00005005 *'nrformats'* *'nf'*
5006'nrformats' 'nf' string (default "octal,hex")
5007 local to buffer
5008 {not in Vi}
5009 This defines what bases Vim will consider for numbers when using the
5010 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5011 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005012 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 incremented or decremented. This is useful for a list with a
Bram Moolenaara3f41662010-07-11 19:01:06 +02005014 letter index a), b), etc. *octal-number*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005015 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005016 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005017 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005018 considered to be hexadecimal. Example: Using CTRL-X on
5019 "0x100" results in "0x0ff".
5020 Numbers which simply begin with a digit in the range 1-9 are always
5021 considered decimal. This also happens for numbers that are not
5022 recognized as octal or hex.
5023
5024 *'number'* *'nu'* *'nonumber'* *'nonu'*
5025'number' 'nu' boolean (default off)
5026 local to window
5027 Print the line number in front of each line. When the 'n' option is
5028 excluded from 'cpoptions' a wrapped line will not use the column of
5029 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005030 The 'numberwidth' option can be used to set the room used for the line
5031 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005032 When a long, wrapped line doesn't start with the first character, '-'
5033 characters are put before the number.
5034 See |hl-LineNr| for the highlighting used for the number.
Bram Moolenaar64486672010-05-16 15:46:46 +02005035 When setting this option, 'relativenumber' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005036
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005037 *'numberwidth'* *'nuw'*
5038'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5039 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005040 {not in Vi}
5041 {only available when compiled with the |+linebreak|
5042 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005043 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005044 when the 'number' or 'relativenumber' option is set or printing lines
5045 with a line number. Since one space is always between the number and
5046 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005047 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005048 fit the highest line number in the buffer respectively the number of
5049 rows in the window, depending on whether 'number' or 'relativenumber'
5050 is set. Thus with the Vim default of 4 there is room for a line number
5051 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005052 The minimum value is 1, the maximum value is 10.
5053 NOTE: 'numberwidth' is reset to 8 when 'compatible' is set.
5054
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005055 *'omnifunc'* *'ofu'*
5056'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005057 local to buffer
5058 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005059 {not available when compiled without the |+eval|
5060 or |+insert_expand| features}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005061 This option specifies a function to be used for Insert mode omni
5062 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005063 See |complete-functions| for an explanation of how the function is
5064 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005065 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005066 |:filetype-plugin-on|
Bram Moolenaare344bea2005-09-01 20:46:49 +00005067
5068
Bram Moolenaar02467872007-05-06 13:22:01 +00005069 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005070'opendevice' 'odev' boolean (default off)
5071 global
5072 {not in Vi}
5073 {only for MS-DOS, MS-Windows and OS/2}
5074 Enable reading and writing from devices. This may get Vim stuck on a
5075 device that can be opened but doesn't actually do the I/O. Therefore
5076 it is off by default.
5077 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5078 result in editing a device.
5079
5080
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005081 *'operatorfunc'* *'opfunc'*
5082'operatorfunc' 'opfunc' string (default: empty)
5083 global
5084 {not in Vi}
5085 This option specifies a function to be called by the |g@| operator.
5086 See |:map-operator| for more info and an example.
5087
5088 This option cannot be set from a |modeline| or in the |sandbox|, for
5089 security reasons.
5090
5091
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 *'osfiletype'* *'oft'* *E366*
5093'osfiletype' 'oft' string (RISC-OS default: "Text",
5094 others default: "")
5095 local to buffer
5096 {not in Vi}
5097 {only available when compiled with the |+osfiletype|
5098 feature}
5099 Some operating systems store extra information about files besides
5100 name, datestamp and permissions. This option contains the extra
5101 information, the nature of which will vary between systems.
5102 The value of this option is usually set when the file is loaded, and
Bram Moolenaare37d50a2008-08-06 17:06:04 +00005103 is used to set the operating system file type when file is written.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005104 It can affect the pattern matching of the automatic commands.
5105 |autocmd-osfiletypes|
5106
5107 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005108'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005109 global
5110 Specifies the nroff macros that separate paragraphs. These are pairs
5111 of two letters (see |object-motions|).
5112
5113 *'paste'* *'nopaste'*
5114'paste' boolean (default off)
5115 global
5116 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005117 Put Vim in Paste mode. This is useful if you want to cut or copy
5118 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005119 unexpected effects.
5120 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005121 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005122 knows about pasting and will mostly do the right thing without 'paste'
5123 being set. The same is true for a terminal where Vim handles the
5124 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005125 This option is reset when starting the GUI. Thus if you set it in
5126 your .vimrc it will work in a terminal, but not in the GUI. Setting
5127 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5128 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005129 When the 'paste' option is switched on (also when it was already on):
5130 - mapping in Insert mode and Command-line mode is disabled
5131 - abbreviations are disabled
5132 - 'textwidth' is set to 0
5133 - 'wrapmargin' is set to 0
5134 - 'autoindent' is reset
5135 - 'smartindent' is reset
5136 - 'softtabstop' is set to 0
5137 - 'revins' is reset
5138 - 'ruler' is reset
5139 - 'showmatch' is reset
5140 - 'formatoptions' is used like it is empty
5141 These options keep their value, but their effect is disabled:
5142 - 'lisp'
5143 - 'indentexpr'
5144 - 'cindent'
5145 NOTE: When you start editing another file while the 'paste' option is
5146 on, settings from the modelines or autocommands may change the
5147 settings again, causing trouble when pasting text. You might want to
5148 set the 'paste' option again.
5149 When the 'paste' option is reset the mentioned options are restored to
5150 the value before the moment 'paste' was switched from off to on.
5151 Resetting 'paste' before ever setting it does not have any effect.
5152 Since mapping doesn't work while 'paste' is active, you need to use
5153 the 'pastetoggle' option to toggle the 'paste' option with some key.
5154
5155 *'pastetoggle'* *'pt'*
5156'pastetoggle' 'pt' string (default "")
5157 global
5158 {not in Vi}
5159 When non-empty, specifies the key sequence that toggles the 'paste'
5160 option. This is like specifying a mapping: >
5161 :map {keys} :set invpaste<CR>
5162< Where {keys} is the value of 'pastetoggle'.
5163 The difference is that it will work even when 'paste' is set.
5164 'pastetoggle' works in Insert mode and Normal mode, but not in
5165 Command-line mode.
5166 Mappings are checked first, thus overrule 'pastetoggle'. However,
5167 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5168 this: >
5169 :map <F10> :set paste<CR>
5170 :map <F11> :set nopaste<CR>
5171 :imap <F10> <C-O>:set paste<CR>
5172 :imap <F11> <nop>
5173 :set pastetoggle=<F11>
5174< This will make <F10> start paste mode and <F11> stop paste mode.
5175 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5176 mode everything is inserted literally, except the 'pastetoggle' key
5177 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005178 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179
5180 *'pex'* *'patchexpr'*
5181'patchexpr' 'pex' string (default "")
5182 global
5183 {not in Vi}
5184 {not available when compiled without the |+diff|
5185 feature}
5186 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005187 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005188
5189 *'patchmode'* *'pm'* *E206*
5190'patchmode' 'pm' string (default "")
5191 global
5192 {not in Vi}
5193 When non-empty the oldest version of a file is kept. This can be used
5194 to keep the original version of a file if you are changing files in a
5195 source distribution. Only the first time that a file is written a
5196 copy of the original file will be kept. The name of the copy is the
5197 name of the original file with the string in the 'patchmode' option
5198 appended. This option should start with a dot. Use a string like
5199 ".org". 'backupdir' must not be empty for this to work (Detail: The
5200 backup file is renamed to the patchmode file after the new file has
5201 been successfully written, that's why it must be possible to write a
5202 backup file). If there was no file to be backed up, an empty file is
5203 created.
5204 When the 'backupskip' pattern matches, a patchmode file is not made.
5205 Using 'patchmode' for compressed files appends the extension at the
5206 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5207 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005208 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209
5210 *'path'* *'pa'* *E343* *E345* *E347*
5211'path' 'pa' string (default on Unix: ".,/usr/include,,"
5212 on OS/2: ".,/emx/include,,"
5213 other systems: ".,,")
5214 global or local to buffer |global-local|
5215 {not in Vi}
5216 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005217 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5218 provided that the file being searched for has a relative path (not
5219 starting with "/", "./" or "../"). The directories in the 'path'
5220 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005221 - Use commas to separate directory names: >
5222 :set path=.,/usr/local/include,/usr/include
5223< - Spaces can also be used to separate directory names (for backwards
5224 compatibility with version 3.0). To have a space in a directory
5225 name, precede it with an extra backslash, and escape the space: >
5226 :set path=.,/dir/with\\\ space
5227< - To include a comma in a directory name precede it with an extra
5228 backslash: >
5229 :set path=.,/dir/with\\,comma
5230< - To search relative to the directory of the current file, use: >
5231 :set path=.
5232< - To search in the current directory use an empty string between two
5233 commas: >
5234 :set path=,,
5235< - A directory name may end in a ':' or '/'.
5236 - Environment variables are expanded |:set_env|.
5237 - When using |netrw.vim| URLs can be used. For example, adding
5238 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005239 - Search upwards and downwards in a directory tree using "*", "**" and
5240 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005241 {not available when compiled without the |+path_extra| feature}
5242 - Careful with '\' characters, type two to get one in the option: >
5243 :set path=.,c:\\include
5244< Or just use '/' instead: >
5245 :set path=.,c:/include
5246< Don't forget "." or files won't even be found in the same directory as
5247 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005248 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005249 it is something like 256 or 1024 characters.
5250 You can check if all the include files are found, using the value of
5251 'path', see |:checkpath|.
5252 The use of |:set+=| and |:set-=| is preferred when adding or removing
5253 directories from the list. This avoids problems when a future version
5254 uses another default. To remove the current directory use: >
5255 :set path-=
5256< To add the current directory use: >
5257 :set path+=
5258< To use an environment variable, you probably need to replace the
5259 separator. Here is an example to append $INCL, in which directory
5260 names are separated with a semi-colon: >
5261 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5262< Replace the ';' with a ':' or whatever separator is used. Note that
5263 this doesn't work when $INCL contains a comma or white space.
5264
5265 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5266'preserveindent' 'pi' boolean (default off)
5267 local to buffer
5268 {not in Vi}
5269 When changing the indent of the current line, preserve as much of the
5270 indent structure as possible. Normally the indent is replaced by a
5271 series of tabs followed by spaces as required (unless |'expandtab'| is
5272 enabled, in which case only spaces are used). Enabling this option
5273 means the indent will preserve as many existing characters as possible
5274 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005275 'expandtab' does not apply to the preserved white space, a Tab remains
5276 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 NOTE: When using ">>" multiple times the resulting indent is a mix of
5278 tabs and spaces. You might not like this.
5279 NOTE: 'preserveindent' is reset when 'compatible' is set.
5280 Also see 'copyindent'.
5281 Use |:retab| to clean up white space.
5282
5283 *'previewheight'* *'pvh'*
5284'previewheight' 'pvh' number (default 12)
5285 global
5286 {not in Vi}
5287 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005288 |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005289 Default height for a preview window. Used for |:ptag| and associated
5290 commands. Used for |CTRL-W_}| when no count is given.
5291
5292 *'previewwindow'* *'nopreviewwindow'*
5293 *'pvw'* *'nopvw'* *E590*
5294'previewwindow' 'pvw' boolean (default off)
5295 local to window
5296 {not in Vi}
5297 {not available when compiled without the |+windows| or
Bram Moolenaardb84e452010-08-15 13:50:43 +02005298 |+quickfix| features}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005299 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 set. It's normally not set directly, but by using one of the commands
5301 |:ptag|, |:pedit|, etc.
5302
5303 *'printdevice'* *'pdev'*
5304'printdevice' 'pdev' string (default empty)
5305 global
5306 {not in Vi}
5307 {only available when compiled with the |+printer|
5308 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005309 The name of the printer to be used for |:hardcopy|.
5310 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005311 This option cannot be set from a |modeline| or in the |sandbox|, for
5312 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005313
Bram Moolenaar8299df92004-07-10 09:47:34 +00005314 *'printencoding'* *'penc'*
5315'printencoding' 'penc' String (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005316 global
5317 {not in Vi}
5318 {only available when compiled with the |+printer|
5319 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005320 Sets the character encoding used when printing.
5321 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005322
5323 *'printexpr'* *'pexpr'*
5324'printexpr' 'pexpr' String (default: see below)
5325 global
5326 {not in Vi}
5327 {only available when compiled with the |+printer|
5328 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005329 Expression used to print the PostScript produced with |:hardcopy|.
5330 See |pexpr-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005331
Bram Moolenaar8299df92004-07-10 09:47:34 +00005332 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005333'printfont' 'pfn' string (default "courier")
5334 global
5335 {not in Vi}
5336 {only available when compiled with the |+printer|
5337 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005338 The name of the font that will be used for |:hardcopy|.
5339 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005340
5341 *'printheader'* *'pheader'*
5342'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5343 global
5344 {not in Vi}
5345 {only available when compiled with the |+printer|
5346 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005347 The format of the header produced in |:hardcopy| output.
5348 See |pheader-option|.
5349
5350 *'printmbcharset'* *'pmbcs'*
5351'printmbcharset' 'pmbcs' string (default "")
5352 global
5353 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005354 {only available when compiled with the |+printer|,
5355 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005356 The CJK character set to be used for CJK output from |:hardcopy|.
5357 See |pmbcs-option|.
5358
5359 *'printmbfont'* *'pmbfn'*
5360'printmbfont' 'pmbfn' string (default "")
5361 global
5362 {not in Vi}
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00005363 {only available when compiled with the |+printer|,
5364 |+postscript| and |+multi_byte| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005365 List of font names to be used for CJK output from |:hardcopy|.
5366 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367
5368 *'printoptions'* *'popt'*
5369'printoptions' 'popt' string (default "")
5370 global
5371 {not in Vi}
5372 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005373 List of items that control the format of the output of |:hardcopy|.
5374 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005376 *'prompt'* *'noprompt'*
5377'prompt' boolean (default on)
5378 global
5379 When on a ":" prompt is used in Ex mode.
5380
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005381 *'pumheight'* *'ph'*
5382'pumheight' 'ph' number (default 0)
5383 global
5384 {not available when compiled without the
5385 |+insert_expand| feature}
5386 {not in Vi}
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005387 Determines the maximum number of items to show in the popup menu for
5388 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005389 |ins-completion-menu|.
5390
5391
Bram Moolenaar677ee682005-01-27 14:41:15 +00005392 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005393'quoteescape' 'qe' string (default "\")
5394 local to buffer
5395 {not in Vi}
5396 The characters that are used to escape quotes in a string. Used for
5397 objects like a', a" and a` |a'|.
5398 When one of the characters in this option is found inside a string,
5399 the following character will be skipped. The default value makes the
5400 text "foo\"bar\\" considered to be one string.
5401
Bram Moolenaar071d4272004-06-13 20:20:40 +00005402 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5403'readonly' 'ro' boolean (default off)
5404 local to buffer
5405 If on, writes fail unless you use a '!'. Protects you from
5406 accidentally overwriting a file. Default on when Vim is started
5407 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005408 When using ":w!" the 'readonly' option is reset for the current
5409 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 {not in Vi:} When using the ":view" command the 'readonly' option is
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005411 set for the newly edited buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005413 *'redrawtime'* *'rdt'*
5414'redrawtime' 'rdt' number (default 2000)
5415 global
5416 {not in Vi}
5417 {only available when compiled with the |+reltime|
5418 feature}
5419 The time in milliseconds for redrawing the display. This applies to
5420 searching for patterns for 'hlsearch' and |:match| highlighting.
5421 When redrawing takes more than this many milliseconds no further
5422 matches will be highlighted. This is used to avoid that Vim hangs
5423 when using a very complicated pattern.
5424
Bram Moolenaar64486672010-05-16 15:46:46 +02005425 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5426'relativenumber' 'rnu' boolean (default off)
5427 local to window
5428 {not in Vi}
5429 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005430 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005431 precede some vertical motion commands (e.g. j k + -) with, without
5432 having to calculate it yourself. Especially useful in combination with
5433 other commands (e.g. y d c < > gq gw =).
5434 When the 'n' option is excluded from 'cpoptions' a wrapped
5435 line will not use the column of line numbers (this is the default when
5436 'compatible' isn't set).
5437 The 'numberwidth' option can be used to set the room used for the line
5438 number.
5439 When a long, wrapped line doesn't start with the first character, '-'
5440 characters are put before the number.
5441 See |hl-LineNr| for the highlighting used for the number.
5442 When setting this option, 'number' is reset.
5443
Bram Moolenaar071d4272004-06-13 20:20:40 +00005444 *'remap'* *'noremap'*
5445'remap' boolean (default on)
5446 global
5447 Allows for mappings to work recursively. If you do not want this for
5448 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005449 NOTE: To avoid portability problems with Vim scripts, always keep
5450 this option at the default "on". Only switch it off when working with
5451 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005452
5453 *'report'*
5454'report' number (default 2)
5455 global
5456 Threshold for reporting number of lines changed. When the number of
5457 changed lines is more than 'report' a message will be given for most
5458 ":" commands. If you want it always, set 'report' to 0.
5459 For the ":substitute" command the number of substitutions is used
5460 instead of the number of lines.
5461
5462 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
5463'restorescreen' 'rs' boolean (default on)
5464 global
5465 {not in Vi} {only in Windows 95/NT console version}
5466 When set, the screen contents is restored when exiting Vim. This also
5467 happens when executing external commands.
5468
5469 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
5470 options in your .vimrc. To disable restoring:
5471 set t_ti= t_te=
5472 To enable restoring (for an xterm):
5473 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
5474 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
5475
5476 *'revins'* *'ri'* *'norevins'* *'nori'*
5477'revins' 'ri' boolean (default off)
5478 global
5479 {not in Vi}
5480 {only available when compiled with the |+rightleft|
5481 feature}
5482 Inserting characters in Insert mode will work backwards. See "typing
5483 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
5484 command in Insert mode, when 'allowrevins' is set.
5485 NOTE: This option is reset when 'compatible' or 'paste' is set.
5486
5487 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
5488'rightleft' 'rl' boolean (default off)
5489 local to window
5490 {not in Vi}
5491 {only available when compiled with the |+rightleft|
5492 feature}
5493 When on, display orientation becomes right-to-left, i.e., characters
5494 that are stored in the file appear from the right to the left.
5495 Using this option, it is possible to edit files for languages that
5496 are written from the right to the left such as Hebrew and Arabic.
5497 This option is per window, so it is possible to edit mixed files
5498 simultaneously, or to view the same file in both ways (this is
5499 useful whenever you have a mixed text file with both right-to-left
5500 and left-to-right strings so that both sets are displayed properly
5501 in different windows). Also see |rileft.txt|.
5502
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02005503 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504'rightleftcmd' 'rlc' string (default "search")
5505 local to window
5506 {not in Vi}
5507 {only available when compiled with the |+rightleft|
5508 feature}
5509 Each word in this option enables the command line editing to work in
5510 right-to-left mode for a group of commands:
5511
5512 search "/" and "?" commands
5513
5514 This is useful for languages such as Hebrew, Arabic and Farsi.
5515 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
5516
5517 *'ruler'* *'ru'* *'noruler'* *'noru'*
5518'ruler' 'ru' boolean (default off)
5519 global
5520 {not in Vi}
5521 {not available when compiled without the
5522 |+cmdline_info| feature}
5523 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005524 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00005525 text in the file is shown on the far right:
5526 Top first line is visible
5527 Bot last line is visible
5528 All first and last line are visible
5529 45% relative position in the file
5530 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005531 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005532 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00005533 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 this option takes precedence over 'ruler' and 'rulerformat'
5535 If the number of characters displayed is different from the number of
5536 bytes in the text (e.g., for a TAB or a multi-byte character), both
5537 the text column (byte number) and the screen column are shown,
5538 separated with a dash.
5539 For an empty line "0-1" is shown.
5540 For an empty buffer the line number will also be zero: "0,0-1".
5541 This option is reset when the 'paste' option is set.
5542 If you don't want to see the ruler all the time but want to know where
5543 you are, use "g CTRL-G" |g_CTRL-G|.
5544 NOTE: This option is reset when 'compatible' is set.
5545
5546 *'rulerformat'* *'ruf'*
5547'rulerformat' 'ruf' string (default empty)
5548 global
5549 {not in Vi}
5550 {not available when compiled without the |+statusline|
5551 feature}
5552 When this option is not empty, it determines the content of the ruler
5553 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00005554 The format of this option is like that of 'statusline'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 The default ruler width is 17 characters. To make the ruler 15
5556 characters wide, put "%15(" at the start and "%)" at the end.
5557 Example: >
5558 :set rulerformat=%15(%c%V\ %p%%%)
5559<
5560 *'runtimepath'* *'rtp'* *vimfiles*
5561'runtimepath' 'rtp' string (default:
5562 Unix: "$HOME/.vim,
5563 $VIM/vimfiles,
5564 $VIMRUNTIME,
5565 $VIM/vimfiles/after,
5566 $HOME/.vim/after"
5567 Amiga: "home:vimfiles,
5568 $VIM/vimfiles,
5569 $VIMRUNTIME,
5570 $VIM/vimfiles/after,
5571 home:vimfiles/after"
5572 PC, OS/2: "$HOME/vimfiles,
5573 $VIM/vimfiles,
5574 $VIMRUNTIME,
5575 $VIM/vimfiles/after,
5576 $HOME/vimfiles/after"
5577 Macintosh: "$VIM:vimfiles,
5578 $VIMRUNTIME,
5579 $VIM:vimfiles:after"
5580 RISC-OS: "Choices:vimfiles,
5581 $VIMRUNTIME,
5582 Choices:vimfiles/after"
5583 VMS: "sys$login:vimfiles,
5584 $VIM/vimfiles,
5585 $VIMRUNTIME,
5586 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00005587 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588 global
5589 {not in Vi}
5590 This is a list of directories which will be searched for runtime
5591 files:
5592 filetype.vim filetypes by file name |new-filetype|
5593 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005594 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595 colors/ color scheme files |:colorscheme|
5596 compiler/ compiler files |:compiler|
5597 doc/ documentation |write-local-help|
5598 ftplugin/ filetype plugins |write-filetype-plugin|
5599 indent/ indent scripts |indent-expression|
5600 keymap/ key mapping files |mbyte-keymap|
5601 lang/ menu translations |:menutrans|
5602 menu.vim GUI menus |menu.vim|
5603 plugin/ plugin scripts |write-plugin|
5604 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00005605 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005606 syntax/ syntax files |mysyntaxfile|
5607 tutor/ files for vimtutor |tutor|
5608
5609 And any other file searched for with the |:runtime| command.
5610
5611 The defaults for most systems are setup to search five locations:
5612 1. In your home directory, for your personal preferences.
5613 2. In a system-wide Vim directory, for preferences from the system
5614 administrator.
5615 3. In $VIMRUNTIME, for files distributed with Vim.
5616 *after-directory*
5617 4. In the "after" directory in the system-wide Vim directory. This is
5618 for the system administrator to overrule or add to the distributed
5619 defaults (rarely needed)
5620 5. In the "after" directory in your home directory. This is for
5621 personal preferences to overrule or add to the distributed defaults
5622 or system-wide settings (rarely needed).
5623
5624 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
5625 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005626 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 wildcards.
5628 See |:runtime|.
5629 Example: >
5630 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
5631< This will use the directory "~/vimruntime" first (containing your
5632 personal Vim runtime files), then "/mygroup/vim" (shared between a
5633 group of people) and finally "$VIMRUNTIME" (the distributed runtime
5634 files).
5635 You probably should always include $VIMRUNTIME somewhere, to use the
5636 distributed runtime files. You can put a directory before $VIMRUNTIME
5637 to find files which replace a distributed runtime files. You can put
5638 a directory after $VIMRUNTIME to find files which add to distributed
5639 runtime files.
5640 This option cannot be set from a |modeline| or in the |sandbox|, for
5641 security reasons.
5642
5643 *'scroll'* *'scr'*
5644'scroll' 'scr' number (default: half the window height)
5645 local to window
5646 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
5647 set to half the number of lines in the window when the window size
5648 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005649 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar071d4272004-06-13 20:20:40 +00005650 height with ":set scroll=0". {Vi is a bit different: 'scroll' gives
5651 the number of screen lines instead of file lines, makes a difference
5652 when lines wrap}
5653
5654 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
5655'scrollbind' 'scb' boolean (default off)
5656 local to window
5657 {not in Vi}
5658 {not available when compiled without the |+scrollbind|
5659 feature}
5660 See also |scroll-binding|. When this option is set, the current
5661 window scrolls as other scrollbind windows (windows that also have
5662 this option set) scroll. This option is useful for viewing the
5663 differences between two versions of a file, see 'diff'.
5664 See |'scrollopt'| for options that determine how this option should be
5665 interpreted.
5666 This option is mostly reset when splitting a window to edit another
5667 file. This means that ":split | edit file" results in two windows
5668 with scroll-binding, but ":split file" does not.
5669
5670 *'scrolljump'* *'sj'*
5671'scrolljump' 'sj' number (default 1)
5672 global
5673 {not in Vi}
5674 Minimal number of lines to scroll when the cursor gets off the
5675 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
5676 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00005677 When set to a negative number from -1 to -100 this is used as the
5678 percentage of the window height. Thus -50 scrolls half the window
5679 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 NOTE: This option is set to 1 when 'compatible' is set.
5681
5682 *'scrolloff'* *'so'*
5683'scrolloff' 'so' number (default 0)
5684 global
5685 {not in Vi}
5686 Minimal number of screen lines to keep above and below the cursor.
5687 This will make some context visible around where you are working. If
5688 you set it to a very large value (999) the cursor line will always be
5689 in the middle of the window (except at the start or end of the file or
5690 when long lines wrap).
5691 For scrolling horizontally see 'sidescrolloff'.
5692 NOTE: This option is set to 0 when 'compatible' is set.
5693
5694 *'scrollopt'* *'sbo'*
5695'scrollopt' 'sbo' string (default "ver,jump")
5696 global
5697 {not available when compiled without the |+scrollbind|
5698 feature}
5699 {not in Vi}
5700 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00005701 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
5702 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 The following words are available:
5704 ver Bind vertical scrolling for 'scrollbind' windows
5705 hor Bind horizontal scrolling for 'scrollbind' windows
5706 jump Applies to the offset between two windows for vertical
5707 scrolling. This offset is the difference in the first
5708 displayed line of the bound windows. When moving
5709 around in a window, another 'scrollbind' window may
5710 reach a position before the start or after the end of
5711 the buffer. The offset is not changed though, when
5712 moving back the 'scrollbind' window will try to scroll
5713 to the desired position when possible.
5714 When now making that window the current one, two
5715 things can be done with the relative offset:
5716 1. When "jump" is not included, the relative offset is
5717 adjusted for the scroll position in the new current
5718 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00005719 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 2. When "jump" is included, the other windows are
5721 scrolled to keep the same relative offset. When
5722 going back to the other window, it still uses the
5723 same relative offset.
5724 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00005725 When 'diff' mode is active there always is vertical scroll binding,
5726 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727
5728 *'sections'* *'sect'*
5729'sections' 'sect' string (default "SHNHH HUnhsh")
5730 global
5731 Specifies the nroff macros that separate sections. These are pairs of
5732 two letters (See |object-motions|). The default makes a section start
5733 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
5734
5735 *'secure'* *'nosecure'* *E523*
5736'secure' boolean (default off)
5737 global
5738 {not in Vi}
5739 When on, ":autocmd", shell and write commands are not allowed in
5740 ".vimrc" and ".exrc" in the current directory and map commands are
5741 displayed. Switch it off only if you know that you will not run into
5742 problems, or when the 'exrc' option is off. On Unix this option is
5743 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005744 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 'secure' at the end of your ~/.vimrc then.
5746 This option cannot be set from a |modeline| or in the |sandbox|, for
5747 security reasons.
5748
5749 *'selection'* *'sel'*
5750'selection' 'sel' string (default "inclusive")
5751 global
5752 {not in Vi}
5753 This option defines the behavior of the selection. It is only used
5754 in Visual and Select mode.
5755 Possible values:
5756 value past line inclusive ~
5757 old no yes
5758 inclusive yes yes
5759 exclusive yes no
5760 "past line" means that the cursor is allowed to be positioned one
5761 character past the line.
5762 "inclusive" means that the last character of the selection is included
5763 in an operation. For example, when "x" is used to delete the
5764 selection.
5765 Note that when "exclusive" is used and selecting from the end
5766 backwards, you cannot include the last character of a line, when
5767 starting in Normal mode and 'virtualedit' empty.
5768
5769 The 'selection' option is set by the |:behave| command.
5770
5771 *'selectmode'* *'slm'*
5772'selectmode' 'slm' string (default "")
5773 global
5774 {not in Vi}
5775 This is a comma separated list of words, which specifies when to start
5776 Select mode instead of Visual mode, when a selection is started.
5777 Possible values:
5778 mouse when using the mouse
5779 key when using shifted special keys
5780 cmd when using "v", "V" or CTRL-V
5781 See |Select-mode|.
5782 The 'selectmode' option is set by the |:behave| command.
5783
5784 *'sessionoptions'* *'ssop'*
5785'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaar18144c82006-04-12 21:52:12 +00005786 help,options,tabpages,winsize")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787 global
5788 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02005789 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005790 feature}
5791 Changes the effect of the |:mksession| command. It is a comma
5792 separated list of words. Each word enables saving and restoring
5793 something:
5794 word save and restore ~
5795 blank empty windows
5796 buffers hidden and unloaded buffers, not just those in windows
5797 curdir the current directory
5798 folds manually created folds, opened/closed folds and local
5799 fold options
5800 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00005801 and contain at least one lowercase letter. Only
5802 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005803 help the help window
5804 localoptions options and mappings local to a window or buffer (not
5805 global values for local options)
5806 options all options and mappings (also global values for local
5807 options)
5808 resize size of the Vim window: 'lines' and 'columns'
5809 sesdir the directory in which the session file is located
5810 will become the current directory (useful with
5811 projects accessed over a network from different
5812 systems)
5813 slash backslashes in file names replaced with forward
5814 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00005815 tabpages all tab pages; without this only the current tab page
5816 is restored, so that you can make a session for each
5817 tab page separately
Bram Moolenaar071d4272004-06-13 20:20:40 +00005818 unix with Unix end-of-line format (single <NL>), even when
5819 on Windows or DOS
5820 winpos position of the whole Vim window
5821 winsize window sizes
5822
5823 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005824 When neither "curdir" nor "sesdir" is included, file names are stored
5825 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005826 "slash" and "unix" are useful on Windows when sharing session files
5827 with Unix. The Unix version of Vim cannot source dos format scripts,
5828 but the Windows version of Vim can source unix format scripts.
5829
5830 *'shell'* *'sh'* *E91*
5831'shell' 'sh' string (default $SHELL or "sh",
5832 MS-DOS and Win32: "command.com" or
5833 "cmd.exe", OS/2: "cmd")
5834 global
5835 Name of the shell to use for ! and :! commands. When changing the
5836 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
5837 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005838 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005839 See |option-backslash| about including spaces and backslashes.
5840 Environment variables are expanded |:set_env|.
5841 If the name of the shell contains a space, you might need to enclose
5842 it in quotes. Example: >
5843 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
5844< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005845 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00005846 "-f" is not inside the quotes, because it is not part of the command
5847 name. And Vim automagically recognizes the backslashes that are path
5848 separators.
5849 For Dos 32 bits (DJGPP), you can set the $DJSYSFLAGS environment
5850 variable to change the way external commands are executed. See the
5851 libc.inf file of DJGPP.
5852 Under MS-Windows, when the executable ends in ".com" it must be
5853 included. Thus setting the shell to "command.com" or "4dos.com"
5854 works, but "command" and "4dos" do not work for all commands (e.g.,
5855 filtering).
5856 For unknown reasons, when using "4dos.com" the current directory is
5857 changed to "C:\". To avoid this set 'shell' like this: >
5858 :set shell=command.com\ /c\ 4dos
5859< This option cannot be set from a |modeline| or in the |sandbox|, for
5860 security reasons.
5861
5862 *'shellcmdflag'* *'shcf'*
5863'shellcmdflag' 'shcf' string (default: "-c", MS-DOS and Win32, when 'shell'
5864 does not contain "sh" somewhere: "/c")
5865 global
5866 {not in Vi}
5867 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
5868 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
5869 systems, the default is set according to the value of 'shell', to
5870 reduce the need to set this option by the user. It's not used for
5871 OS/2 (EMX figures this out itself). See |option-backslash| about
5872 including spaces and backslashes. See |dos-shell|.
5873 This option cannot be set from a |modeline| or in the |sandbox|, for
5874 security reasons.
5875
5876 *'shellpipe'* *'sp'*
5877'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
5878 global
5879 {not in Vi}
5880 {not available when compiled without the |+quickfix|
5881 feature}
5882 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005883 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884 including spaces and backslashes.
5885 The name of the temporary file can be represented by "%s" if necessary
5886 (the file name is appended automatically if no %s appears in the value
5887 of this option).
5888 For the Amiga and MS-DOS the default is ">". The output is directly
5889 saved in a file and not echoed to the screen.
5890 For Unix the default it "| tee". The stdout of the compiler is saved
5891 in a file and echoed to the screen. If the 'shell' option is "csh" or
5892 "tcsh" after initializations, the default becomes "|& tee". If the
5893 'shell' option is "sh", "ksh", "zsh" or "bash" the default becomes
Bram Moolenaar00a927d2010-05-14 23:24:24 +02005894 "2>&1| tee". This means that stderr is also included. Before using
5895 the 'shell' option a path is removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005896 The initialization of this option is done after reading the ".vimrc"
5897 and the other initializations, so that when the 'shell' option is set
5898 there, the 'shellpipe' option changes automatically, unless it was
5899 explicitly set before.
5900 When 'shellpipe' is set to an empty string, no redirection of the
5901 ":make" output will be done. This is useful if you use a 'makeprg'
5902 that writes to 'makeef' by itself. If you want no piping, but do
5903 want to include the 'makeef', set 'shellpipe' to a single space.
5904 Don't forget to precede the space with a backslash: ":set sp=\ ".
5905 In the future pipes may be used for filtering and this option will
5906 become obsolete (at least for Unix).
5907 This option cannot be set from a |modeline| or in the |sandbox|, for
5908 security reasons.
5909
5910 *'shellquote'* *'shq'*
5911'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
5912 contains "sh" somewhere: "\"")
5913 global
5914 {not in Vi}
5915 Quoting character(s), put around the command passed to the shell, for
5916 the "!" and ":!" commands. The redirection is kept outside of the
5917 quoting. See 'shellxquote' to include the redirection. It's
5918 probably not useful to set both options.
5919 This is an empty string by default. Only known to be useful for
5920 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
5921 or bash, where it should be "\"". The default is adjusted according
5922 the value of 'shell', to reduce the need to set this option by the
5923 user. See |dos-shell|.
5924 This option cannot be set from a |modeline| or in the |sandbox|, for
5925 security reasons.
5926
5927 *'shellredir'* *'srr'*
5928'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
5929 global
5930 {not in Vi}
5931 String to be used to put the output of a filter command in a temporary
5932 file. See also |:!|. See |option-backslash| about including spaces
5933 and backslashes.
5934 The name of the temporary file can be represented by "%s" if necessary
5935 (the file name is appended automatically if no %s appears in the value
5936 of this option).
5937 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
5938 or "zsh" during initializations, the default becomes ">&". If the
5939 'shell' option is "sh", "ksh" or "bash" the default becomes
5940 ">%s 2>&1". This means that stderr is also included.
5941 For Win32, the Unix checks are done and additionally "cmd" is checked
5942 for, which makes the default ">%s 2>&1". Also, the same names with
5943 ".exe" appended are checked for.
5944 The initialization of this option is done after reading the ".vimrc"
5945 and the other initializations, so that when the 'shell' option is set
5946 there, the 'shellredir' option changes automatically unless it was
5947 explicitly set before.
5948 In the future pipes may be used for filtering and this option will
5949 become obsolete (at least for Unix).
5950 This option cannot be set from a |modeline| or in the |sandbox|, for
5951 security reasons.
5952
5953 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
5954'shellslash' 'ssl' boolean (default off)
5955 global
5956 {not in Vi} {only for MSDOS, MS-Windows and OS/2}
5957 When set, a forward slash is used when expanding file names. This is
5958 useful when a Unix-like shell is used instead of command.com or
5959 cmd.exe. Backward slashes can still be typed, but they are changed to
5960 forward slashes by Vim.
5961 Note that setting or resetting this option has no effect for some
5962 existing file names, thus this option needs to be set before opening
5963 any file for best results. This might change in the future.
5964 'shellslash' only works when a backslash can be used as a path
5965 separator. To test if this is so use: >
5966 if exists('+shellslash')
5967<
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005968 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
5969'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
5970 global
5971 {not in Vi}
5972 When on, use temp files for shell commands. When off use a pipe.
5973 When using a pipe is not possible temp files are used anyway.
5974 Currently a pipe is only supported on Unix. You can check it with: >
5975 :if has("filterpipe")
5976< The advantage of using a pipe is that nobody can read the temp file
5977 and the 'shell' command does not need to support redirection.
5978 The advantage of using a temp file is that the file type and encoding
5979 can be detected.
5980 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
5981 |FilterWritePost| autocommands event are not triggered when
5982 'shelltemp' is off.
5983
Bram Moolenaar071d4272004-06-13 20:20:40 +00005984 *'shelltype'* *'st'*
5985'shelltype' 'st' number (default 0)
5986 global
5987 {not in Vi} {only for the Amiga}
5988 On the Amiga this option influences the way how the commands work
5989 which use a shell.
5990 0 and 1: always use the shell
5991 2 and 3: use the shell only to filter lines
5992 4 and 5: use shell only for ':sh' command
5993 When not using the shell, the command is executed directly.
5994
5995 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
5996 1 and 3: use "shell cmd" to start external commands
5997
5998 *'shellxquote'* *'sxq'*
5999'shellxquote' 'sxq' string (default: "";
6000 for Win32, when 'shell' contains "sh"
6001 somewhere: "\""
6002 for Unix, when using system(): "\"")
6003 global
6004 {not in Vi}
6005 Quoting character(s), put around the command passed to the shell, for
6006 the "!" and ":!" commands. Includes the redirection. See
6007 'shellquote' to exclude the redirection. It's probably not useful
6008 to set both options.
6009 This is an empty string by default. Known to be useful for
6010 third-party shells when using the Win32 version, such as the MKS Korn
6011 Shell or bash, where it should be "\"". The default is adjusted
6012 according the value of 'shell', to reduce the need to set this option
6013 by the user. See |dos-shell|.
6014 This option cannot be set from a |modeline| or in the |sandbox|, for
6015 security reasons.
6016
6017 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6018'shiftround' 'sr' boolean (default off)
6019 global
6020 {not in Vi}
6021 Round indent to multiple of 'shiftwidth'. Applies to > and <
6022 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6023 a multiple of 'shiftwidth' (this is Vi compatible).
6024 NOTE: This option is reset when 'compatible' is set.
6025
6026 *'shiftwidth'* *'sw'*
6027'shiftwidth' 'sw' number (default 8)
6028 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006029 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006030 |'cindent'|, |>>|, |<<|, etc.
6031
6032 *'shortmess'* *'shm'*
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006033'shortmess' 'shm' string (Vim default "filnxtToO", Vi default: "",
6034 POSIX default: "A")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006035 global
6036 {not in Vi}
6037 This option helps to avoid all the |hit-enter| prompts caused by file
6038 messages, for example with CTRL-G, and to avoid some other messages.
6039 It is a list of flags:
6040 flag meaning when present ~
6041 f use "(3 of 5)" instead of "(file 3 of 5)"
6042 i use "[noeol]" instead of "[Incomplete last line]"
6043 l use "999L, 888C" instead of "999 lines, 888 characters"
6044 m use "[+]" instead of "[Modified]"
6045 n use "[New]" instead of "[New File]"
6046 r use "[RO]" instead of "[readonly]"
6047 w use "[w]" instead of "written" for file write message
6048 and "[a]" instead of "appended" for ':w >> file' command
6049 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6050 "[unix format]" and "[mac]" instead of "[mac format]".
6051 a all of the above abbreviations
6052
6053 o overwrite message for writing a file with subsequent message
6054 for reading a file (useful for ":wn" or when 'autowrite' on)
6055 O message for reading a file overwrites any previous message.
6056 Also for quickfix message (e.g., ":cn").
6057 s don't give "search hit BOTTOM, continuing at TOP" or "search
6058 hit TOP, continuing at BOTTOM" messages
6059 t truncate file message at the start if it is too long to fit
6060 on the command-line, "<" will appear in the left most column.
6061 Ignored in Ex mode.
6062 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006063 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006064 Ignored in Ex mode.
6065 W don't give "written" or "[w]" when writing a file
6066 A don't give the "ATTENTION" message when an existing swap file
6067 is found.
6068 I don't give the intro message when starting Vim |:intro|.
6069
6070 This gives you the opportunity to avoid that a change between buffers
6071 requires you to hit <Enter>, but still gives as useful a message as
6072 possible for the space available. To get the whole message that you
6073 would have got with 'shm' empty, use ":file!"
6074 Useful values:
6075 shm= No abbreviation of message.
6076 shm=a Abbreviation, but no loss of information.
6077 shm=at Abbreviation, and truncate message when necessary.
6078
6079 NOTE: This option is set to the Vi default value when 'compatible' is
6080 set and to the Vim default value when 'compatible' is reset.
6081
6082 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6083'shortname' 'sn' boolean (default off)
6084 local to buffer
6085 {not in Vi, not in MS-DOS versions}
6086 Filenames are assumed to be 8 characters plus one extension of 3
6087 characters. Multiple dots in file names are not allowed. When this
6088 option is on, dots in file names are replaced with underscores when
6089 adding an extension (".~" or ".swp"). This option is not available
6090 for MS-DOS, because then it would always be on. This option is useful
6091 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6092 or crossdos. When running the Win32 GUI version under Win32s, this
6093 option is always on by default.
6094
6095 *'showbreak'* *'sbr'* *E595*
6096'showbreak' 'sbr' string (default "")
6097 global
6098 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006099 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006100 feature}
6101 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006102 values are "> " or "+++ ": >
6103 :set showbreak=>\
6104< Note the backslash to escape the trailing space. It's easier like
6105 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006106 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006107< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006108 comma (in a future version the comma might be used to separate the
6109 part that is shown at the end and at the start of a line).
6110 The characters are highlighted according to the '@' flag in
6111 'highlight'.
6112 Note that tabs after the showbreak will be displayed differently.
6113 If you want the 'showbreak' to appear in between line numbers, add the
6114 "n" flag to 'cpoptions'.
6115
6116 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
6117'showcmd' 'sc' boolean (Vim default: on, off for Unix, Vi default:
6118 off)
6119 global
6120 {not in Vi}
6121 {not available when compiled without the
6122 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006123 Show (partial) command in the last line of the screen. Set this
6124 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 In Visual mode the size of the selected area is shown:
6126 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006127 If the number of bytes is different it is also displayed: "2-6"
6128 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006129 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006130 - When selecting a block, the size in screen characters:
6131 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 NOTE: This option is set to the Vi default value when 'compatible' is
6133 set and to the Vim default value when 'compatible' is reset.
6134
6135 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6136'showfulltag' 'sft' boolean (default off)
6137 global
6138 {not in Vi}
6139 When completing a word in insert mode (see |ins-completion|) from the
6140 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006141 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 matched a C function, you can see a template for what arguments are
6143 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006144 Note that this doesn't work well together with having "longest" in
6145 'completeopt', because the completion from the search pattern may not
6146 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006147
6148 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6149'showmatch' 'sm' boolean (default off)
6150 global
6151 When a bracket is inserted, briefly jump to the matching one. The
6152 jump is only done if the match can be seen on the screen. The time to
6153 show the match can be set with 'matchtime'.
6154 A Beep is given if there is no match (no matter if the match can be
6155 seen or not). This option is reset when the 'paste' option is set.
6156 When the 'm' flag is not included in 'cpoptions', typing a character
6157 will immediately move the cursor back to where it belongs.
6158 See the "sm" field in 'guicursor' for setting the cursor shape and
6159 blinking when showing the match.
6160 The 'matchpairs' option can be used to specify the characters to show
6161 matches for. 'rightleft' and 'revins' are used to look for opposite
6162 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006163 Also see the matchparen plugin for highlighting the match when moving
6164 around |pi_paren.txt|.
6165 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006166
6167 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6168'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6169 global
6170 If in Insert, Replace or Visual mode put a message on the last line.
6171 Use the 'M' flag in 'highlight' to set the type of highlighting for
6172 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006173 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 doesn't mean XIM is really active, especially when 'imactivatekey' is
6175 not set.
6176 NOTE: This option is set to the Vi default value when 'compatible' is
6177 set and to the Vim default value when 'compatible' is reset.
6178
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006179 *'showtabline'* *'stal'*
6180'showtabline' 'stal' number (default 1)
6181 global
6182 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006183 {not available when compiled without the |+windows|
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006184 feature}
6185 The value of this option specifies when the line with tab page labels
6186 will be displayed:
6187 0: never
6188 1: only if there are at least two tab pages
6189 2: always
6190 This is both for the GUI and non-GUI implementation of the tab pages
6191 line.
6192 See |tab-page| for more information about tab pages.
6193
Bram Moolenaar071d4272004-06-13 20:20:40 +00006194 *'sidescroll'* *'ss'*
6195'sidescroll' 'ss' number (default 0)
6196 global
6197 {not in Vi}
6198 The minimal number of columns to scroll horizontally. Used only when
6199 the 'wrap' option is off and the cursor is moved off of the screen.
6200 When it is zero the cursor will be put in the middle of the screen.
6201 When using a slow terminal set it to a large number or 0. When using
6202 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6203 commands.
6204
6205 *'sidescrolloff'* *'siso'*
6206'sidescrolloff' 'siso' number (default 0)
6207 global
6208 {not in Vi}
6209 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006210 right of the cursor if 'nowrap' is set. Setting this option to a
6211 value greater than 0 while having |'sidescroll'| also at a non-zero
6212 value makes some context visible in the line you are scrolling in
6213 horizontally (except at beginning of the line). Setting this option
6214 to a large value (like 999) has the effect of keeping the cursor
6215 horizontally centered in the window, as long as one does not come too
6216 close to the beginning of the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 NOTE: This option is set to 0 when 'compatible' is set.
6218
6219 Example: Try this together with 'sidescroll' and 'listchars' as
6220 in the following example to never allow the cursor to move
6221 onto the "extends" character:
6222
6223 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6224 :set sidescrolloff=1
6225
6226
6227 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6228'smartcase' 'scs' boolean (default off)
6229 global
6230 {not in Vi}
6231 Override the 'ignorecase' option if the search pattern contains upper
6232 case characters. Only used when the search pattern is typed and
6233 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006234 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc.. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006235 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6236 recalling the search pattern from history and hitting <Enter>.
6237 NOTE: This option is reset when 'compatible' is set.
6238
6239 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6240'smartindent' 'si' boolean (default off)
6241 local to buffer
6242 {not in Vi}
6243 {not available when compiled without the
6244 |+smartindent| feature}
6245 Do smart autoindenting when starting a new line. Works for C-like
6246 programs, but can also be used for other languages. 'cindent' does
6247 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006248 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006249 setting 'si' has no effect. 'indentexpr' is a more advanced
6250 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 Normally 'autoindent' should also be on when using 'smartindent'.
6252 An indent is automatically inserted:
6253 - After a line ending in '{'.
6254 - After a line starting with a keyword from 'cinwords'.
6255 - Before a line starting with '}' (only with the "O" command).
6256 When typing '}' as the first character in a new line, that line is
6257 given the same indent as the matching '{'.
6258 When typing '#' as the first character in a new line, the indent for
6259 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006260 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006261 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6262 When using the ">>" command, lines starting with '#' are not shifted
6263 right.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006264 NOTE: 'smartindent' is reset when 'compatible' is set. When 'paste'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006265 is set smart indenting is disabled.
6266
6267 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6268'smarttab' 'sta' boolean (default off)
6269 global
6270 {not in Vi}
6271 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006272 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6273 <BS> will delete a 'shiftwidth' worth of space at the start of the
6274 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006275 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006276 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6277 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006278 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006279 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006280 number of spaces is minimized by using <Tab>s.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 NOTE: This option is reset when 'compatible' is set.
6282
6283 *'softtabstop'* *'sts'*
6284'softtabstop' 'sts' number (default 0)
6285 local to buffer
6286 {not in Vi}
6287 Number of spaces that a <Tab> counts for while performing editing
6288 operations, like inserting a <Tab> or using <BS>. It "feels" like
6289 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6290 used. This is useful to keep the 'ts' setting at its standard value
6291 of 8, while being able to edit like it is set to 'sts'. However,
6292 commands like "x" still work on the actual characters.
6293 When 'sts' is zero, this feature is off.
6294 'softtabstop' is set to 0 when the 'paste' option is set.
6295 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6296 spaces is minimized by using <Tab>s.
6297 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6298 set.
6299 NOTE: This option is set to 0 when 'compatible' is set.
6300
Bram Moolenaar217ad922005-03-20 22:37:15 +00006301 *'spell'* *'nospell'*
6302'spell' boolean (default off)
6303 local to window
6304 {not in Vi}
6305 {not available when compiled without the |+syntax|
6306 feature}
6307 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006308 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006309
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006310 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006311'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006312 local to buffer
6313 {not in Vi}
6314 {not available when compiled without the |+syntax|
6315 feature}
6316 Pattern to locate the end of a sentence. The following word will be
6317 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006318 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006319 When this check is not wanted make this option empty.
6320 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006321 Be careful with special characters, see |option-backslash| about
6322 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006323 To set this option automatically depending on the language, see
6324 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006325
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006326 *'spellfile'* *'spf'*
6327'spellfile' 'spf' string (default empty)
6328 local to buffer
6329 {not in Vi}
6330 {not available when compiled without the |+syntax|
6331 feature}
6332 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006333 commands. It must end in ".{encoding}.add". You need to include the
6334 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006335 *E765*
6336 It may also be a comma separated list of names. A count before the
6337 |zg| and |zw| commands can be used to access each. This allows using
6338 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006339 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006340 you: Using the first directory in 'runtimepath' that is writable. If
6341 there is no "spell" directory yet it will be created. For the file
6342 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006343 ignoring the region.
6344 The resulting ".spl" file will be used for spell checking, it does not
6345 have to appear in 'spelllang'.
6346 Normally one file is used for all regions, but you can add the region
6347 name if you want to. However, it will then only be used when
6348 'spellfile' is set to it, for entries in 'spelllang' only files
6349 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006350 This option cannot be set from a |modeline| or in the |sandbox|, for
6351 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006352
Bram Moolenaar217ad922005-03-20 22:37:15 +00006353 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006354'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006355 local to buffer
6356 {not in Vi}
6357 {not available when compiled without the |+syntax|
6358 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006359 A comma separated list of word list names. When the 'spell' option is
6360 on spellchecking will be done for these languages. Example: >
6361 set spelllang=en_us,nl,medical
6362< This means US English, Dutch and medical words are recognized. Words
6363 that are not recognized will be highlighted.
6364 The word list name must not include a comma or dot. Using a dash is
6365 recommended to separate the two letter language name from a
6366 specification. Thus "en-rare" is used for rare English words.
6367 A region name must come last and have the form "_xx", where "xx" is
6368 the two-letter, lower case region name. You can use more than one
6369 region by listing them: "en_us,en_ca" supports both US and Canadian
6370 English, but not words specific for Australia, New Zealand or Great
6371 Britain.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006372 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006373 As a special case the name of a .spl file can be given as-is. The
6374 first "_xx" in the name is removed and used as the region name
6375 (_xx is an underscore, two letters and followed by a non-letter).
6376 This is mainly for testing purposes. You must make sure the correct
6377 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006378 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006379 idea to set 'spelllang' after setting 'encoding' to avoid loading the
6380 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00006381 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006382
Bram Moolenaar98692072006-02-04 00:57:42 +00006383 If the |spellfile.vim| plugin is active and you use a language name
6384 for which Vim cannot find the .spl file in 'runtimepath' the plugin
6385 will ask you if you want to download the file.
6386
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006387 After this option has been set successfully, Vim will source the files
6388 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006389 up to the first comma, dot or underscore.
6390 Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006391
6392
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006393 *'spellsuggest'* *'sps'*
6394'spellsuggest' 'sps' string (default "best")
6395 global
6396 {not in Vi}
6397 {not available when compiled without the |+syntax|
6398 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006399 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006400 the |spellsuggest()| function. This is a comma-separated list of
6401 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006402
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006403 best Internal method that works best for English. Finds
6404 changes like "fast" and uses a bit of sound-a-like
6405 scoring to improve the ordering.
6406
6407 double Internal method that uses two methods and mixes the
6408 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006409 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006410 word. That only works when the language specifies
6411 sound folding. Can be slow and doesn't always give
6412 better results.
6413
6414 fast Internal method that only checks for simple changes:
6415 character inserts/deletes/swaps. Works well for
6416 simple typing mistakes.
6417
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006418 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006419 Not used for |spellsuggest()|. The number of
6420 suggestions is never more than the value of 'lines'
6421 minus two.
6422
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006423 file:{filename} Read file {filename}, which must have two columns,
6424 separated by a slash. The first column contains the
6425 bad word, the second column the suggested good word.
6426 Example:
6427 theribal/terrible ~
6428 Use this for common mistakes that do not appear at the
6429 top of the suggestion list with the internal methods.
6430 Lines without a slash are ignored, use this for
6431 comments.
6432 The file is used for all languages.
6433
6434 expr:{expr} Evaluate expression {expr}. Use a function to avoid
6435 trouble with spaces. |v:val| holds the badly spelled
6436 word. The expression must evaluate to a List of
6437 Lists, each with a suggestion and a score.
6438 Example:
6439 [['the', 33], ['that', 44]]
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00006440 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00006441 internal methods use. A lower score is better.
6442 This may invoke |spellsuggest()| if you temporarily
6443 set 'spellsuggest' to exclude the "expr:" part.
6444 Errors are silently ignored, unless you set the
6445 'verbose' option to a non-zero value.
6446
6447 Only one of "best", "double" or "fast" may be used. The others may
6448 appear several times in any order. Example: >
6449 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
6450<
6451 This option cannot be set from a |modeline| or in the |sandbox|, for
6452 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00006453
6454
Bram Moolenaar071d4272004-06-13 20:20:40 +00006455 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
6456'splitbelow' 'sb' boolean (default off)
6457 global
6458 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006459 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006460 feature}
6461 When on, splitting a window will put the new window below the current
6462 one. |:split|
6463
6464 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
6465'splitright' 'spr' boolean (default off)
6466 global
6467 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006468 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 feature}
6470 When on, splitting a window will put the new window right of the
6471 current one. |:vsplit|
6472
6473 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
6474'startofline' 'sol' boolean (default on)
6475 global
6476 {not in Vi}
6477 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00006478 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006479 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00006480 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 with a linewise operator, with "%" with a count and to buffer changing
6482 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
6483 only has a line number, e.g., ":25" or ":+".
6484 In case of buffer changing commands the cursor is placed at the column
6485 where it was the last time the buffer was edited.
6486 NOTE: This option is set when 'compatible' is set.
6487
6488 *'statusline'* *'stl'* *E540* *E541* *E542*
6489'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00006490 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 {not in Vi}
6492 {not available when compiled without the |+statusline|
6493 feature}
6494 When nonempty, this option determines the content of the status line.
6495 Also see |status-line|.
6496
6497 The option consists of printf style '%' items interspersed with
6498 normal text. Each status line item is of the form:
6499 %-0{minwid}.{maxwid}{item}
6500 All fields except the {item} is optional. A single percent sign can
6501 be given as "%%". Up to 80 items can be specified.
6502
Bram Moolenaar238a5642006-02-21 22:12:05 +00006503 When the option starts with "%!" then it is used as an expression,
6504 evaluated and the result is used as the option value. Example: >
6505 :set statusline=%!MyStatusLine()
6506< The result can contain %{} items that will be evaluated too.
6507
6508 When there is error while evaluating the option then it will be made
6509 empty to avoid further errors. Otherwise screen updating would loop.
6510
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 Note that the only effect of 'ruler' when this option is set (and
6512 'laststatus' is 2) is controlling the output of |CTRL-G|.
6513
6514 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00006515 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00006516 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006517 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 minwid Minimum width of the item, padding as set by '-' & '0'.
6519 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006520 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 on the left for text items. Numeric items will be
6522 shifted down to maxwid-2 digits followed by '>'number
6523 where number is the amount of missing digits, much like
6524 an exponential notation.
6525 item A one letter code as described below.
6526
6527 Following is a description of the possible statusline items. The
6528 second character in "item" is the type:
6529 N for number
6530 S for string
6531 F for flags as described below
6532 - not applicable
6533
6534 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00006535 f S Path to the file in the buffer, as typed or relative to current
6536 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 F S Full path to the file in the buffer.
6538 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006539 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006540 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006541 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006542 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006543 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006544 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006545 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006546 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006547 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006548 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
6549 {not available when compiled without |+autocmd| feature}
Bram Moolenaar7fd73202010-07-25 16:58:46 +02006550 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006551 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
6552 being used: "<keymap>"
6553 n N Buffer number.
6554 b N Value of byte under cursor.
6555 B N As above, in hexadecimal.
6556 o N Byte number in file of byte under cursor, first byte is 1.
6557 Mnemonic: Offset from start of file (with one added)
6558 {not available when compiled without |+byte_offset| feature}
6559 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006560 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006561 l N Line number.
6562 L N Number of lines in buffer.
6563 c N Column number.
6564 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006565 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006566 p N Percentage through file in lines as in |CTRL-G|.
6567 P S Percentage through file of displayed window. This is like the
6568 percentage described for 'ruler'. Always 3 in length.
Bram Moolenaar582fd852005-03-28 20:58:01 +00006569 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006571 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar4770d092006-01-12 23:22:24 +00006572 Note that there is no '%' before the closing '}'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006573 ( - Start of item group. Can be used for setting the width and
6574 alignment of a section. Must be followed by %) somewhere.
6575 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006576 T N For 'tabline': start of tab page N label. Use %T after the last
6577 label. This information is used for mouse clicks.
6578 X N For 'tabline': start of close tab N label. Use %X after the
6579 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
6580 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 < - Where to truncate line if too long. Default is at the start.
6582 No width fields allowed.
6583 = - Separation point between left and right aligned items.
6584 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00006585 # - Set highlight group. The name must follow and then a # again.
6586 Thus use %#HLname# for highlight group HLname. The same
6587 highlighting is used, also for the statusline of non-current
6588 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006589 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006590 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 The difference between User{N} and StatusLine will be applied
6592 to StatusLineNC for the statusline of non-current windows.
6593 The number N must be between 1 and 9. See |hl-User1..9|
6594
Bram Moolenaare37d50a2008-08-06 17:06:04 +00006595 When displaying a flag, Vim removes the leading comma, if any, when
6596 that flag comes right after plaintext. This will make a nice display
6597 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006598
Bram Moolenaar582fd852005-03-28 20:58:01 +00006599 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00006600 not set) and a minwid is not set for the group, the whole group will
6601 become empty. This will make a group like the following disappear
6602 completely from the statusline when none of the flags are set. >
6603 :set statusline=...%(\ [%M%R%H]%)...
6604<
6605 Beware that an expression is evaluated each and every time the status
6606 line is displayed. The current buffer and current window will be set
6607 temporarily to that of the window (and buffer) whose statusline is
Bram Moolenaar582fd852005-03-28 20:58:01 +00006608 currently being drawn. The expression will evaluate in this context.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006609 The variable "actual_curbuf" is set to the 'bufnr()' number of the
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00006610 real current buffer.
6611
6612 The 'statusline' option may be evaluated in the |sandbox|, see
6613 |sandbox-option|.
6614
6615 It is not allowed to change text or jump to another window while
6616 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617
6618 If the statusline is not updated when you want it (e.g., after setting
6619 a variable that's used in an expression), you can force an update by
6620 setting an option without changing its value. Example: >
6621 :let &ro = &ro
6622
6623< A result of all digits is regarded a number for display purposes.
6624 Otherwise the result is taken as flag text and applied to the rules
6625 described above.
6626
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00006627 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
6629 edit your .vimrc or whatever with "vim -u NONE" to get it right.
6630
6631 Examples:
6632 Emulate standard status line with 'ruler' set >
6633 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
6634< Similar, but add ASCII value of char under the cursor (like "ga") >
6635 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
6636< Display byte count and byte value, modified flag in red. >
6637 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
6638 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
6639< Display a ,GZ flag if a compressed file is loaded >
6640 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
6641< In the |:autocmd|'s: >
6642 :let b:gzflag = 1
6643< And: >
6644 :unlet b:gzflag
6645< And define this function: >
6646 :function VarExists(var, val)
6647 : if exists(a:var) | return a:val | else | return '' | endif
6648 :endfunction
6649<
6650 *'suffixes'* *'su'*
6651'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
6652 global
6653 {not in Vi}
6654 Files with these suffixes get a lower priority when multiple files
6655 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006656 suffixes. Spaces after the comma are ignored. A dot is also seen as
6657 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006658 separator, precede it with a backslash (see |option-backslash| about
6659 including spaces and backslashes).
6660 See 'wildignore' for completely ignoring files.
6661 The use of |:set+=| and |:set-=| is preferred when adding or removing
6662 suffixes from the list. This avoids problems when a future version
6663 uses another default.
6664
6665 *'suffixesadd'* *'sua'*
6666'suffixesadd' 'sua' string (default "")
6667 local to buffer
6668 {not in Vi}
6669 {not available when compiled without the
6670 |+file_in_path| feature}
6671 Comma separated list of suffixes, which are used when searching for a
6672 file for the "gf", "[I", etc. commands. Example: >
6673 :set suffixesadd=.java
6674<
6675 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
6676'swapfile' 'swf' boolean (default on)
6677 local to buffer
6678 {not in Vi}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006679 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00006680 swapfile is not wanted for a specific buffer. For example, with
6681 confidential information that even root must not be able to access.
6682 Careful: All text will be in memory:
6683 - Don't use this for big files.
6684 - Recovery will be impossible!
6685 A swapfile will only be present when |'updatecount'| is non-zero and
6686 'swapfile' is set.
6687 When 'swapfile' is reset, the swap file for the current buffer is
6688 immediately deleted. When 'swapfile' is set, and 'updatecount' is
6689 non-zero, a swap file is immediately created.
6690 Also see |swap-file| and |'swapsync'|.
6691
6692 This option is used together with 'bufhidden' and 'buftype' to
6693 specify special kinds of buffers. See |special-buffers|.
6694
6695 *'swapsync'* *'sws'*
6696'swapsync' 'sws' string (default "fsync")
6697 global
6698 {not in Vi}
6699 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006700 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006701 When this option is empty parts of the swap file may be in memory and
6702 not written to disk. When the system crashes you may lose more work.
6703 On Unix the system does a sync now and then without Vim asking for it,
6704 so the disadvantage of setting this option off is small. On some
6705 systems the swap file will not be written at all. For a unix system
6706 setting it to "sync" will use the sync() call instead of the default
6707 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006708 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006709
6710 *'switchbuf'* *'swb'*
6711'switchbuf' 'swb' string (default "")
6712 global
6713 {not in Vi}
6714 This option controls the behavior when switching between buffers.
6715 Possible values (comma separated list):
6716 useopen If included, jump to the first open window that
6717 contains the specified buffer (if there is one).
6718 Otherwise: Do not examine other windows.
6719 This setting is checked with |quickfix| commands, when
6720 jumping to errors (":cc", ":cn", "cp", etc.). It is
6721 also used in all buffer related split commands, for
6722 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00006723 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00006724 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006725 split If included, split the current window before loading
Bram Moolenaar582fd852005-03-28 20:58:01 +00006726 a buffer. Otherwise: do not split, use current window.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 Supported in |quickfix| commands that display errors.
Bram Moolenaar446cb832008-06-24 21:56:24 +00006728 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02006729 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006730
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006731 *'synmaxcol'* *'smc'*
6732'synmaxcol' 'smc' number (default 3000)
6733 local to buffer
6734 {not in Vi}
6735 {not available when compiled without the |+syntax|
6736 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00006737 Maximum column in which to search for syntax items. In long lines the
6738 text after this column is not highlighted and following lines may not
6739 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00006740 This helps to avoid very slow redrawing for an XML file that is one
6741 long line.
6742 Set to zero to remove the limit.
6743
Bram Moolenaar071d4272004-06-13 20:20:40 +00006744 *'syntax'* *'syn'*
6745'syntax' 'syn' string (default empty)
6746 local to buffer
6747 {not in Vi}
6748 {not available when compiled without the |+syntax|
6749 feature}
6750 When this option is set, the syntax with this name is loaded, unless
6751 syntax highlighting has been switched off with ":syntax off".
6752 Otherwise this option does not always reflect the current syntax (the
6753 b:current_syntax variable does).
6754 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00006755 not automatically recognized. Example, in an IDL file:
6756 /* vim: set syntax=idl : */ ~
6757 When a dot appears in the value then this separates two filetype
6758 names. Example:
6759 /* vim: set syntax=c.doxygen : */ ~
6760 This will use the "c" syntax first, then the "doxygen" syntax.
6761 Note that the second one must be prepared to be loaded as an addition,
6762 otherwise it will be skipped. More than one dot may appear.
6763 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 :set syntax=OFF
6765< To switch syntax highlighting on according to the current value of the
6766 'filetype' option: >
6767 :set syntax=ON
6768< What actually happens when setting the 'syntax' option is that the
6769 Syntax autocommand event is triggered with the value as argument.
6770 This option is not copied to another buffer, independent of the 's' or
6771 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00006772 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006773
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006774 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006775'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006776 global
6777 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006778 {not available when compiled without the |+windows|
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006779 feature}
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006780 When nonempty, this option determines the content of the tab pages
6781 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006782 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006783
6784 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00006785 option and only when there is no GUI tab line. When 'e' is in
6786 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02006787 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006788
6789 The value is evaluated like with 'statusline'. You can use
6790 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00006791 the text to be displayed. Use "%1T" for the first label, "%2T" for
6792 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006793
6794 Keep in mind that only one of the tab pages is the current one, others
6795 are invisible and you can't jump to their windows.
6796
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00006797
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006798 *'tabpagemax'* *'tpm'*
6799'tabpagemax' 'tpm' number (default 10)
6800 global
6801 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02006802 {not available when compiled without the |+windows|
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006803 feature}
6804 Maximum number of tab pages to be opened by the |-p| command line
6805 argument or the ":tab all" command. |tabpage|
6806
6807
6808 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809'tabstop' 'ts' number (default 8)
6810 local to buffer
6811 Number of spaces that a <Tab> in the file counts for. Also see
6812 |:retab| command, and 'softtabstop' option.
6813
6814 Note: Setting 'tabstop' to any other value than 8 can make your file
6815 appear wrong in many places (e.g., when printing it).
6816
6817 There are four main ways to use tabs in Vim:
6818 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
6819 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006820 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 behave like a tab appears every 4 (or 3) characters.
6822 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
6823 'expandtab'. This way you will always insert spaces. The
6824 formatting will never be messed up when 'tabstop' is changed.
6825 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006826 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00006827 works when using Vim to edit the file.
6828 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
6829 'noexpandtab'. This should then work (for initial indents only)
6830 for any tabstop setting that people use. It might be nice to have
6831 tabs after the first non-blank inserted as spaces if you do this
6832 though. Otherwise aligned comments will be wrong when 'tabstop' is
6833 changed.
6834
6835 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
6836'tagbsearch' 'tbs' boolean (default on)
6837 global
6838 {not in Vi}
6839 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006840 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 searching makes searching for a tag a LOT faster, but a linear search
6842 will find more tags if the tags file wasn't properly sorted.
6843 Vim normally assumes that your tags files are sorted, or indicate that
6844 they are not sorted. Only when this is not the case does the
6845 'tagbsearch' option need to be switched off.
6846
6847 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006848 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006849 certain files, or retry all files with a linear search. When
6850 'tagbsearch' is off, only a linear search is done.
6851
6852 Linear searching is done anyway, for one file, when Vim finds a line
6853 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00006854 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00006855< [The whitespace before and after the '0' must be a single <Tab>]
6856
6857 When a binary search was done and no match was found in any of the
6858 files listed in 'tags', and 'ignorecase' is set or a pattern is used
6859 instead of a normal tag name, a retry is done with a linear search.
6860 Tags in unsorted tags files, and matches with different case will only
6861 be found in the retry.
6862
Bram Moolenaard4755bb2004-09-02 19:12:26 +00006863 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar071d4272004-06-13 20:20:40 +00006864 linear search can be avoided for the 'ignorecase' case. Use a value
6865 of '2' in the "!_TAG_FILE_SORTED" line for this. A tag file can be
6866 case-fold sorted with the -f switch to "sort" in most unices, as in
6867 the command: "sort -f -o tags tags". For "Exuberant ctags" version
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006868 5.x or higher (at least 5.5) the --sort=foldcase switch can be used
6869 for this as well. Note that case must be folded to uppercase for this
6870 to work.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871
6872 When 'tagbsearch' is off, tags searching is slower when a full match
6873 exists, but faster when no full match exists. Tags in unsorted tags
6874 files may only be found with 'tagbsearch' off.
6875 When the tags file is not sorted, or sorted in a wrong way (not on
6876 ASCII byte value), 'tagbsearch' should be off, or the line given above
6877 must be included in the tags file.
6878 This option doesn't affect commands that find all matching tags (e.g.,
6879 command-line completion and ":help").
6880 {Vi: always uses binary search in some versions}
6881
6882 *'taglength'* *'tl'*
6883'taglength' 'tl' number (default 0)
6884 global
6885 If non-zero, tags are significant up to this number of characters.
6886
6887 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
6888'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
6889 global
6890 {not in Vi}
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00006891 If on and using a tags file in another directory, file names in that
6892 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006893 NOTE: This option is set to the Vi default value when 'compatible' is
6894 set and to the Vim default value when 'compatible' is reset.
6895
6896 *'tags'* *'tag'* *E433*
6897'tags' 'tag' string (default "./tags,tags", when compiled with
6898 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
6899 global or local to buffer |global-local|
6900 Filenames for the tag command, separated by spaces or commas. To
6901 include a space or comma in a file name, precede it with a backslash
6902 (see |option-backslash| about including spaces and backslashes).
6903 When a file name starts with "./", the '.' is replaced with the path
6904 of the current file. But only when the 'd' flag is not included in
6905 'cpoptions'. Environment variables are expanded |:set_env|. Also see
6906 |tags-option|.
6907 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02006908 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
6909 find all files named "tags" below "/lib". The filename itself cannot
6910 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
6911 files called "tags?". {not available when compiled without the
6912 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00006913 The |tagfiles()| function can be used to get a list of the file names
6914 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
6916 files are also supported. They are automatically recognized. The
6917 default value becomes "./tags,./TAGS,tags,TAGS", unless case
6918 differences are ignored (MS-Windows). |emacs-tags|
6919 The use of |:set+=| and |:set-=| is preferred when adding or removing
6920 file names from the list. This avoids problems when a future version
6921 uses another default.
6922 {Vi: default is "tags /usr/lib/tags"}
6923
6924 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
6925'tagstack' 'tgst' boolean (default on)
6926 global
6927 {not in all versions of Vi}
6928 When on, the |tagstack| is used normally. When off, a ":tag" or
6929 ":tselect" command with an argument will not push the tag onto the
6930 tagstack. A following ":tag" without an argument, a ":pop" command or
6931 any other command that uses the tagstack will use the unmodified
6932 tagstack, but does change the pointer to the active entry.
6933 Resetting this option is useful when using a ":tag" command in a
6934 mapping which should not change the tagstack.
6935
6936 *'term'* *E529* *E530* *E531*
6937'term' string (default is $TERM, if that fails:
6938 in the GUI: "builtin_gui"
6939 on Amiga: "amiga"
6940 on BeOS: "beos-ansi"
6941 on Mac: "mac-ansi"
6942 on MiNT: "vt52"
6943 on MS-DOS: "pcterm"
6944 on OS/2: "os2ansi"
6945 on Unix: "ansi"
6946 on VMS: "ansi"
6947 on Win 32: "win32")
6948 global
6949 Name of the terminal. Used for choosing the terminal control
6950 characters. Environment variables are expanded |:set_env|.
6951 For example: >
6952 :set term=$TERM
6953< See |termcap|.
6954
6955 *'termbidi'* *'tbidi'*
6956 *'notermbidi'* *'notbidi'*
6957'termbidi' 'tbidi' boolean (default off, on for "mlterm")
6958 global
6959 {not in Vi}
6960 {only available when compiled with the |+arabic|
6961 feature}
6962 The terminal is in charge of Bi-directionality of text (as specified
6963 by Unicode). The terminal is also expected to do the required shaping
6964 that some languages (such as Arabic) require.
6965 Setting this option implies that 'rightleft' will not be set when
6966 'arabic' is set and the value of 'arabicshape' will be ignored.
6967 Note that setting 'termbidi' has the immediate effect that
6968 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
6969 This option is reset when the GUI is started.
6970 For further details see |arabic.txt|.
6971
6972 *'termencoding'* *'tenc'*
6973'termencoding' 'tenc' string (default ""; with GTK+ 2 GUI: "utf-8"; with
6974 Macintosh GUI: "macroman")
6975 global
6976 {only available when compiled with the |+multi_byte|
6977 feature}
6978 {not in Vi}
6979 Encoding used for the terminal. This specifies what character
6980 encoding the keyboard produces and the display will understand. For
6981 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00006982 display). Except for the Mac when 'macatsui' is off, then
6983 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006984 In the Win32 console version the default value is the console codepage
6985 when it differs from the ANSI codepage.
6986 *E617*
6987 Note: This does not apply to the GTK+ 2 GUI. After the GUI has been
6988 successfully initialized, 'termencoding' is forcibly set to "utf-8".
6989 Any attempts to set a different value will be rejected, and an error
6990 message is shown.
6991 For the Win32 GUI 'termencoding' is not used for typed characters,
6992 because the Win32 system always passes Unicode characters.
6993 When empty, the same encoding is used as for the 'encoding' option.
6994 This is the normal value.
6995 Not all combinations for 'termencoding' and 'encoding' are valid. See
6996 |encoding-table|.
6997 The value for this option must be supported by internal conversions or
6998 iconv(). When this is not possible no conversion will be done and you
6999 will probably experience problems with non-ASCII characters.
7000 Example: You are working with the locale set to euc-jp (Japanese) and
7001 want to edit a UTF-8 file: >
7002 :let &termencoding = &encoding
7003 :set encoding=utf-8
7004< You need to do this when your system has no locale support for UTF-8.
7005
7006 *'terse'* *'noterse'*
7007'terse' boolean (default off)
7008 global
7009 When set: Add 's' flag to 'shortmess' option (this makes the message
7010 for a search that hits the start or end of the file not being
7011 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7012 shortens a lot of messages}
7013
7014 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7015'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7016 global
7017 {not in Vi}
7018 This option is obsolete. Use 'fileformats'.
7019 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7020 set to the default value for the current system. When 'textauto' is
7021 reset, 'fileformats' is made empty.
7022 NOTE: This option is set to the Vi default value when 'compatible' is
7023 set and to the Vim default value when 'compatible' is reset.
7024
7025 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7026'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7027 others: default off)
7028 local to buffer
7029 {not in Vi}
7030 This option is obsolete. Use 'fileformat'.
7031 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7032 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7033 "unix".
7034
7035 *'textwidth'* *'tw'*
7036'textwidth' 'tw' number (default 0)
7037 local to buffer
7038 {not in Vi}
7039 Maximum width of text that is being inserted. A longer line will be
7040 broken after white space to get this width. A zero value disables
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007041 this. 'textwidth' is set to 0 when the 'paste' option is set. When
7042 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007043 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007044 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007045 NOTE: This option is set to 0 when 'compatible' is set.
7046
7047 *'thesaurus'* *'tsr'*
7048'thesaurus' 'tsr' string (default "")
7049 global or local to buffer |global-local|
7050 {not in Vi}
7051 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007052 for thesaurus completion commands |i_CTRL-X_CTRL-T|. Each line in
Bram Moolenaar071d4272004-06-13 20:20:40 +00007053 the file should contain words with similar meaning, separated by
7054 non-keyword characters (white space is preferred). Maximum line
7055 length is 510 bytes.
7056 To obtain a file to be used here, check out the wordlist FAQ at
7057 http://www.hyphenologist.co.uk .
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007058 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007059 after a comma are ignored, otherwise spaces are included in the file
7060 name. See |option-backslash| about using backslashes.
7061 The use of |:set+=| and |:set-=| is preferred when adding or removing
7062 directories from the list. This avoids problems when a future version
7063 uses another default.
7064 Backticks cannot be used in this option for security reasons.
7065
7066 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7067'tildeop' 'top' boolean (default off)
7068 global
7069 {not in Vi}
7070 When on: The tilde command "~" behaves like an operator.
7071 NOTE: This option is reset when 'compatible' is set.
7072
7073 *'timeout'* *'to'* *'notimeout'* *'noto'*
7074'timeout' 'to' boolean (default on)
7075 global
7076 *'ttimeout'* *'nottimeout'*
7077'ttimeout' boolean (default off)
7078 global
7079 {not in Vi}
7080 These two options together determine the behavior when part of a
7081 mapped key sequence or keyboard code has been received:
7082
7083 'timeout' 'ttimeout' action ~
7084 off off do not time out
7085 on on or off time out on :mappings and key codes
7086 off on time out on key codes
7087
7088 If both options are off, Vim will wait until either the complete
7089 mapping or key sequence has been received, or it is clear that there
7090 is no mapping or key sequence for the received characters. For
7091 example: if you have mapped "vl" and Vim has received 'v', the next
7092 character is needed to see if the 'v' is followed by an 'l'.
7093 When one of the options is on, Vim will wait for about 1 second for
7094 the next character to arrive. After that the already received
7095 characters are interpreted as single characters. The waiting time can
7096 be changed with the 'timeoutlen' option.
7097 On slow terminals or very busy systems timing out may cause
7098 malfunctioning cursor keys. If both options are off, Vim waits
7099 forever after an entered <Esc> if there are key codes that start
7100 with <Esc>. You will have to type <Esc> twice. If you do not have
7101 problems with key codes, but would like to have :mapped key
7102 sequences not timing out in 1 second, set the 'ttimeout' option and
7103 reset the 'timeout' option.
7104
7105 NOTE: 'ttimeout' is reset when 'compatible' is set.
7106
7107 *'timeoutlen'* *'tm'*
7108'timeoutlen' 'tm' number (default 1000)
7109 global
7110 {not in all versions of Vi}
7111 *'ttimeoutlen'* *'ttm'*
7112'ttimeoutlen' 'ttm' number (default -1)
7113 global
7114 {not in Vi}
7115 The time in milliseconds that is waited for a key code or mapped key
7116 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7117 when part of a command has been typed.
7118 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7119 different timeout value for key codes is desired set 'ttimeoutlen' to
7120 a non-negative number.
7121
7122 ttimeoutlen mapping delay key code delay ~
7123 < 0 'timeoutlen' 'timeoutlen'
7124 >= 0 'timeoutlen' 'ttimeoutlen'
7125
7126 The timeout only happens when the 'timeout' and 'ttimeout' options
7127 tell so. A useful setting would be >
7128 :set timeout timeoutlen=3000 ttimeoutlen=100
7129< (time out on mapping after three seconds, time out on key codes after
7130 a tenth of a second).
7131
7132 *'title'* *'notitle'*
7133'title' boolean (default off, on when title can be restored)
7134 global
7135 {not in Vi}
7136 {not available when compiled without the |+title|
7137 feature}
7138 When on, the title of the window will be set to the value of
7139 'titlestring' (if it is not empty), or to:
7140 filename [+=-] (path) - VIM
7141 Where:
7142 filename the name of the file being edited
7143 - indicates the file cannot be modified, 'ma' off
7144 + indicates the file was modified
7145 = indicates the file is read-only
7146 =+ indicates the file is read-only and modified
7147 (path) is the path of the file being edited
7148 - VIM the server name |v:servername| or "VIM"
7149 Only works if the terminal supports setting window titles
7150 (currently Amiga console, Win32 console, all GUI versions and
7151 terminals with a non- empty 't_ts' option - these are Unix xterm and
7152 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7153 *X11*
7154 When Vim was compiled with HAVE_X11 defined, the original title will
7155 be restored if possible. The output of ":version" will include "+X11"
7156 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7157 works for the icon name |'icon'|.
7158 But: When Vim was started with the |-X| argument, restoring the title
7159 will not work (except in the GUI).
7160 If the title cannot be restored, it is set to the value of 'titleold'.
7161 You might want to restore the title outside of Vim then.
7162 When using an xterm from a remote machine you can use this command:
7163 rsh machine_name xterm -display $DISPLAY &
7164 then the WINDOWID environment variable should be inherited and the
7165 title of the window should change back to what it should be after
7166 exiting Vim.
7167
7168 *'titlelen'*
7169'titlelen' number (default 85)
7170 global
7171 {not in Vi}
7172 {not available when compiled without the |+title|
7173 feature}
7174 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007175 title. When the title is longer, only the end of the path name is
7176 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007177 Using a percentage makes this adapt to the width of the window. But
7178 it won't work perfectly, because the actual number of characters
7179 available also depends on the font used and other things in the title
7180 bar. When 'titlelen' is zero the full path is used. Otherwise,
7181 values from 1 to 30000 percent can be used.
7182 'titlelen' is also used for the 'titlestring' option.
7183
7184 *'titleold'*
7185'titleold' string (default "Thanks for flying Vim")
7186 global
7187 {not in Vi}
7188 {only available when compiled with the |+title|
7189 feature}
7190 This option will be used for the window title when exiting Vim if the
7191 original title cannot be restored. Only happens if 'title' is on or
7192 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007193 This option cannot be set from a |modeline| or in the |sandbox|, for
7194 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 *'titlestring'*
7196'titlestring' string (default "")
7197 global
7198 {not in Vi}
7199 {not available when compiled without the |+title|
7200 feature}
7201 When this option is not empty, it will be used for the title of the
7202 window. This happens only when the 'title' option is on.
7203 Only works if the terminal supports setting window titles (currently
7204 Amiga console, Win32 console, all GUI versions and terminals with a
7205 non-empty 't_ts' option).
7206 When Vim was compiled with HAVE_X11 defined, the original title will
7207 be restored if possible |X11|.
7208 When this option contains printf-style '%' items, they will be
7209 expanded according to the rules used for 'statusline'.
7210 Example: >
7211 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7212 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7213< The value of 'titlelen' is used to align items in the middle or right
7214 of the available space.
7215 Some people prefer to have the file name first: >
7216 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7217< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007218 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 separating space only when needed.
7220 NOTE: Use of special characters in 'titlestring' may cause the display
7221 to be garbled (e.g., when it contains a CR or NL character).
7222 {not available when compiled without the |+statusline| feature}
7223
7224 *'toolbar'* *'tb'*
7225'toolbar' 'tb' string (default "icons,tooltips")
7226 global
7227 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7228 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007229 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 possible values are:
7231 icons Toolbar buttons are shown with icons.
7232 text Toolbar buttons shown with text.
7233 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007234 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 tooltips Tooltips are active for toolbar buttons.
7236 Tooltips refer to the popup help text which appears after the mouse
7237 cursor is placed over a toolbar button for a brief moment.
7238
7239 If you want the toolbar to be shown with icons as well as text, do the
7240 following: >
7241 :set tb=icons,text
7242< Motif and Athena cannot display icons and text at the same time. They
7243 will show icons if both are requested.
7244
7245 If none of the strings specified in 'toolbar' are valid or if
7246 'toolbar' is empty, this option is ignored. If you want to disable
7247 the toolbar, you need to set the 'guioptions' option. For example: >
7248 :set guioptions-=T
7249< Also see |gui-toolbar|.
7250
7251 *'toolbariconsize'* *'tbis'*
7252'toolbariconsize' 'tbis' string (default "small")
7253 global
7254 {not in Vi}
7255 {only in the GTK+ 2 GUI}
7256 Controls the size of toolbar icons. The possible values are:
7257 tiny Use tiny toolbar icons.
7258 small Use small toolbar icons (default).
7259 medium Use medium-sized toolbar icons.
7260 large Use large toolbar icons.
7261 The exact dimensions in pixels of the various icon sizes depend on
7262 the current theme. Common dimensions are large=32x32, medium=24x24,
7263 small=20x20 and tiny=16x16.
7264
7265 If 'toolbariconsize' is empty, the global default size as determined
7266 by user preferences or the current theme is used.
7267
7268 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
7269'ttybuiltin' 'tbi' boolean (default on)
7270 global
7271 {not in Vi}
7272 When on, the builtin termcaps are searched before the external ones.
7273 When off the builtin termcaps are searched after the external ones.
7274 When this option is changed, you should set the 'term' option next for
7275 the change to take effect, for example: >
7276 :set notbi term=$TERM
7277< See also |termcap|.
7278 Rationale: The default for this option is "on", because the builtin
7279 termcap entries are generally better (many systems contain faulty
7280 xterm entries...).
7281
7282 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
7283'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
7284 sun-cmd, screen, rxvt, dtterm or
7285 iris-ansi; also on when running Vim in
7286 a DOS console)
7287 global
7288 {not in Vi}
7289 Indicates a fast terminal connection. More characters will be sent to
7290 the screen for redrawing, instead of using insert/delete line
7291 commands. Improves smoothness of redrawing when there are multiple
7292 windows and the terminal does not support a scrolling region.
7293 Also enables the extra writing of characters at the end of each screen
7294 line for lines that wrap. This helps when using copy/paste with the
7295 mouse in an xterm and other terminals.
7296
7297 *'ttymouse'* *'ttym'*
7298'ttymouse' 'ttym' string (default depends on 'term')
7299 global
7300 {not in Vi}
7301 {only in Unix and VMS, doesn't work in the GUI; not
7302 available when compiled without |+mouse|}
7303 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00007304 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007305 *xterm-mouse*
7306 xterm xterm-like mouse handling. The mouse generates
7307 "<Esc>[Mscr", where "scr" is three bytes:
7308 "s" = button state
7309 "c" = column plus 33
7310 "r" = row plus 33
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007311 This only works up to 223 columns! See "dec" for a
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007312 solution.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007313 xterm2 Works like "xterm", but with the xterm reporting the
7314 mouse position while the mouse is dragged. This works
7315 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00007316 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 work. See below for how Vim detects this
7318 automatically.
7319 *netterm-mouse*
7320 netterm NetTerm mouse handling. The mouse generates
7321 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
7322 for the row and column.
7323 *dec-mouse*
7324 dec DEC terminal mouse handling. The mouse generates a
7325 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00007326 This is also available for an Xterm, if it was
7327 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328 *jsbterm-mouse*
7329 jsbterm JSB term mouse handling.
7330 *pterm-mouse*
7331 pterm QNX pterm mouse handling.
7332
7333 The mouse handling must be enabled at compile time |+mouse_xterm|
7334 |+mouse_dec| |+mouse_netterm|.
7335 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
7336 recognized, if enabled at compile time. DEC terminal mouse codes
7337 are recognized if enabled at compile time, and 'ttymouse' is not
7338 "xterm" (because the xterm and dec mouse codes conflict).
7339 This option is automatically set to "xterm", when the 'term' option is
7340 set to a name that starts with "xterm", and 'ttymouse' is not "xterm"
7341 or "xterm2" already. The main use of this option is to set it to
7342 "xterm", when the terminal name doesn't start with "xterm", but it can
7343 handle xterm mouse codes.
7344 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaar446cb832008-06-24 21:56:24 +00007345 95 or higher. This only works when compiled with the |+termresponse|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 feature and if |t_RV| is set to the escape sequence to request the
7347 xterm version number. Otherwise "xterm2" must be set explicitly.
7348 If you do not want 'ttymouse' to be set to "xterm2" automatically, set
7349 t_RV to an empty string: >
7350 :set t_RV=
7351<
7352 *'ttyscroll'* *'tsl'*
7353'ttyscroll' 'tsl' number (default 999)
7354 global
7355 Maximum number of lines to scroll the screen. If there are more lines
7356 to scroll the window is redrawn. For terminals where scrolling is
7357 very slow and redrawing is not slow this can be set to a small number,
7358 e.g., 3, to speed up displaying.
7359
7360 *'ttytype'* *'tty'*
7361'ttytype' 'tty' string (default from $TERM)
7362 global
7363 Alias for 'term', see above.
7364
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007365 *'undodir'* *'udir'*
7366'undodir' 'udir' string (default ".")
7367 global
7368 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007369 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007370 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007371 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02007372 "." means using the directory of the file. The undo file name for
7373 "file.txt" is ".file.txt.un~".
7374 For other directories the file name is the full path of the edited
7375 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007376 When writing: The first directory that exists is used. "." always
7377 works, no directories after "." will be used for writing.
7378 When reading all entries are tried to find an undo file. The first
7379 undo file that exists is used. When it cannot be read an error is
7380 given, no further entry is used.
7381 See |undo-persistence|.
7382
7383 *'undofile'* *'udf'*
7384'undofile' 'udf' boolean (default off)
7385 local to buffer
7386 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007387 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007388 When on, Vim automatically saves undo history to an undo file when
7389 writing a buffer to a file, and restores undo history from the same
7390 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007391 The directory where the undo file is stored is specified by 'undodir'.
7392 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007393 The undo file is not read when 'undoreload' causes the buffer from
7394 before a reload to be saved for undo.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02007395 WARNING: this is a very new feature. Use at your own risk!
Bram Moolenaar55debbe2010-05-23 23:34:36 +02007396
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 *'undolevels'* *'ul'*
7398'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
7399 Win32 and OS/2)
7400 global
7401 {not in Vi}
7402 Maximum number of changes that can be undone. Since undo information
7403 is kept in memory, higher numbers will cause more memory to be used
7404 (nevertheless, a single change can use an unlimited amount of memory).
7405 Set to 0 for Vi compatibility: One level of undo and "u" undoes
7406 itself: >
7407 set ul=0
7408< But you can also get Vi compatibility by including the 'u' flag in
7409 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007410 Also see |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007411 Set to a negative number for no undo at all: >
7412 set ul=-1
7413< This helps when you run out of memory for a single change.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02007414 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007415
Bram Moolenaar59f931e2010-07-24 20:27:03 +02007416 *'undoreload'* *'ur'*
7417'undoreload' 'ur' number (default 10000)
7418 global
7419 {not in Vi}
7420 Save the whole buffer for undo when reloading it. This applies to the
7421 ":e!" command and reloading for when the buffer changed outside of
7422 Vim. |FileChangedShell|
7423 The save only happens when this options is negative or when the number
7424 of lines is smaller than the value of this option.
7425 Set this option to zero to disable undo for a reload.
7426
7427 When saving undo for a reload, any undo file is not read.
7428
7429 Note that this causes the whole buffer to be stored in memory. Set
7430 this option to a lower value if you run out of memory.
7431
Bram Moolenaar071d4272004-06-13 20:20:40 +00007432 *'updatecount'* *'uc'*
7433'updatecount' 'uc' number (default: 200)
7434 global
7435 {not in Vi}
7436 After typing this many characters the swap file will be written to
7437 disk. When zero, no swap file will be created at all (see chapter on
7438 recovery |crash-recovery|). 'updatecount' is set to zero by starting
7439 Vim with the "-n" option, see |startup|. When editing in readonly
7440 mode this option will be initialized to 10000.
7441 The swapfile can be disabled per buffer with |'swapfile'|.
7442 When 'updatecount' is set from zero to non-zero, swap files are
7443 created for all buffers that have 'swapfile' set. When 'updatecount'
7444 is set to zero, existing swap files are not deleted.
7445 Also see |'swapsync'|.
7446 This option has no meaning in buffers where |'buftype'| is "nofile"
7447 or "nowrite".
7448
7449 *'updatetime'* *'ut'*
7450'updatetime' 'ut' number (default 4000)
7451 global
7452 {not in Vi}
7453 If this many milliseconds nothing is typed the swap file will be
7454 written to disk (see |crash-recovery|). Also used for the
7455 |CursorHold| autocommand event.
7456
7457 *'verbose'* *'vbs'*
7458'verbose' 'vbs' number (default 0)
7459 global
7460 {not in Vi, although some versions have a boolean
7461 verbose option}
7462 When bigger than zero, Vim will give messages about what it is doing.
7463 Currently, these messages are given:
7464 >= 1 When the viminfo file is read or written.
7465 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007466 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 >= 8 Files for which a group of autocommands is executed.
7468 >= 9 Every executed autocommand.
7469 >= 12 Every executed function.
7470 >= 13 When an exception is thrown, caught, finished, or discarded.
7471 >= 14 Anything pending in a ":finally" clause.
7472 >= 15 Every executed Ex command (truncated at 200 characters).
7473
7474 This option can also be set with the "-V" argument. See |-V|.
7475 This option is also set by the |:verbose| command.
7476
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007477 When the 'verbosefile' option is set then the verbose messages are not
7478 displayed.
7479
7480 *'verbosefile'* *'vfile'*
7481'verbosefile' 'vfile' string (default empty)
7482 global
7483 {not in Vi}
7484 When not empty all messages are written in a file with this name.
7485 When the file exists messages are appended.
7486 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02007487 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00007488 Setting 'verbosefile' to a new value is like making it empty first.
7489 The difference with |:redir| is that verbose messages are not
7490 displayed when 'verbosefile' is set.
7491
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 *'viewdir'* *'vdir'*
7493'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
7494 "$VIM/vimfiles/view",
7495 for Unix: "~/.vim/view",
7496 for Macintosh: "$VIM:vimfiles:view"
7497 for VMS: "sys$login:vimfiles/view"
7498 for RiscOS: "Choices:vimfiles/view")
7499 global
7500 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007501 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 feature}
7503 Name of the directory where to store files for |:mkview|.
7504 This option cannot be set from a |modeline| or in the |sandbox|, for
7505 security reasons.
7506
7507 *'viewoptions'* *'vop'*
7508'viewoptions' 'vop' string (default: "folds,options,cursor")
7509 global
7510 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007511 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 feature}
7513 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007514 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 word save and restore ~
7516 cursor cursor position in file and in window
7517 folds manually created folds, opened/closed folds and local
7518 fold options
7519 options options and mappings local to a window or buffer (not
7520 global values for local options)
7521 slash backslashes in file names replaced with forward
7522 slashes
7523 unix with Unix end-of-line format (single <NL>), even when
7524 on Windows or DOS
7525
7526 "slash" and "unix" are useful on Windows when sharing view files
7527 with Unix. The Unix version of Vim cannot source dos format scripts,
7528 but the Windows version of Vim can source unix format scripts.
7529
7530 *'viminfo'* *'vi'* *E526* *E527* *E528*
7531'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01007532 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
7533 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
7534 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535 global
7536 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007537 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007538 feature}
7539 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007540 when exiting Vim (see |viminfo-file|). The string should be a comma
Bram Moolenaar071d4272004-06-13 20:20:40 +00007541 separated list of parameters, each consisting of a single character
7542 identifying the particular parameter, followed by a number or string
7543 which specifies the value of that parameter. If a particular
7544 character is left out, then the default value is used for that
7545 parameter. The following is a list of the identifying characters and
7546 the effect of their value.
7547 CHAR VALUE ~
7548 ! When included, save and restore global variables that start
7549 with an uppercase letter, and don't contain a lowercase
7550 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02007551 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01007552 read back correctly, you end up with an empty item.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007553 " Maximum number of lines saved for each register. Old name of
7554 the '<' item, with the disadvantage that you need to put a
7555 backslash before the ", otherwise it will be recognized as the
7556 start of a comment!
7557 % When included, save and restore the buffer list. If Vim is
7558 started with a file name argument, the buffer list is not
7559 restored. If Vim is started without a file name argument, the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007560 buffer list is restored from the viminfo file. Buffers
Bram Moolenaar071d4272004-06-13 20:20:40 +00007561 without a file name and buffers for help files are not written
7562 to the viminfo file.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00007563 When followed by a number, the number specifies the maximum
7564 number of buffers that are stored. Without a number all
7565 buffers are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007566 ' Maximum number of previously edited files for which the marks
7567 are remembered. This parameter must always be included when
7568 'viminfo' is non-empty.
7569 Including this item also means that the |jumplist| and the
7570 |changelist| are stored in the viminfo file.
7571 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007572 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 patterns are also saved. When not included, the value of
7574 'history' is used.
7575 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007576 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577 < Maximum number of lines saved for each register. If zero then
7578 registers are not saved. When not included, all lines are
7579 saved. '"' is the old name for this item.
7580 Also see the 's' item below: limit specified in Kbyte.
7581 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007582 saved. When not included, the value of 'history' is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007583 c When included, convert the text in the viminfo file from the
7584 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00007585 'encoding'. See |viminfo-encoding|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586 f Whether file marks need to be stored. If zero, file marks ('0
7587 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007588 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00007589 cursor position (when exiting or when doing ":wviminfo").
7590 h Disable the effect of 'hlsearch' when loading the viminfo
7591 file. When not included, it depends on whether ":nohlsearch"
7592 has been used since the last search command.
7593 n Name of the viminfo file. The name must immediately follow
7594 the 'n'. Must be the last one! If the "-i" argument was
7595 given when starting Vim, that file name overrides the one
7596 given here with 'viminfo'. Environment variables are expanded
7597 when opening the file, not when setting the option.
7598 r Removable media. The argument is a string (up to the next
7599 ','). This parameter can be given several times. Each
7600 specifies the start of a path for which no marks will be
7601 stored. This is to avoid removable media. For MS-DOS you
7602 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
7603 also use it for temp files, e.g., for Unix: "r/tmp". Case is
7604 ignored. Maximum length of each 'r' argument is 50
7605 characters.
7606 s Maximum size of an item in Kbyte. If zero then registers are
7607 not saved. Currently only applies to registers. The default
7608 "s10" will exclude registers with more than 10 Kbyte of text.
7609 Also see the '<' item above: line count limit.
7610
7611 Example: >
7612 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
7613<
7614 '50 Marks will be remembered for the last 50 files you
7615 edited.
7616 <1000 Contents of registers (up to 1000 lines each) will be
7617 remembered.
7618 s100 Registers with more than 100 Kbyte text are skipped.
7619 :0 Command-line history will not be saved.
7620 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
7621 no / Since '/' is not specified, the default will be used,
7622 that is, save all of the search history, and also the
7623 previous search and substitute patterns.
7624 no % The buffer list will not be saved nor read back.
7625 no h 'hlsearch' highlighting will be restored.
7626
7627 When setting 'viminfo' from an empty value you can use |:rviminfo| to
7628 load the contents of the file, this is not done automatically.
7629
7630 This option cannot be set from a |modeline| or in the |sandbox|, for
7631 security reasons.
7632
7633 *'virtualedit'* *'ve'*
7634'virtualedit' 've' string (default "")
7635 global
7636 {not in Vi}
7637 {not available when compiled without the
7638 |+virtualedit| feature}
7639 A comma separated list of these words:
7640 block Allow virtual editing in Visual block mode.
7641 insert Allow virtual editing in Insert mode.
7642 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007643 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007644
Bram Moolenaar071d4272004-06-13 20:20:40 +00007645 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007646 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00007647 of the line. Useful for selecting a rectangle in Visual mode and
7648 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007649 "onemore" is not the same, it will only allow moving the cursor just
7650 after the last character of the line. This makes some commands more
7651 consistent. Previously the cursor was always past the end of the line
7652 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007653 break some plugins or Vim scripts. For example because |l| can move
7654 the cursor after the last character. Use with care!
7655 Using the |$| command will move to the last character in the line, not
7656 past it. This may actually move the cursor to the left!
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00007657 It doesn't make sense to combine "all" with "onemore", but you will
7658 not get a warning for it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659
7660 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
7661'visualbell' 'vb' boolean (default off)
7662 global
7663 {not in Vi}
7664 Use visual bell instead of beeping. The terminal code to display the
7665 visual bell is given with 't_vb'. When no beep or flash is wanted,
7666 use ":set vb t_vb=".
7667 Note: When the GUI starts, 't_vb' is reset to its default value. You
7668 might want to set it again in your |gvimrc|.
7669 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
7670 for 20 msec. If you want to use a different time, use "<Esc>|40f",
7671 where 40 is the time in msec.
7672 Does not work on the Amiga, you always get a screen flash.
7673 Also see 'errorbells'.
7674
7675 *'warn'* *'nowarn'*
7676'warn' boolean (default on)
7677 global
7678 Give a warning message when a shell command is used while the buffer
7679 has been changed.
7680
7681 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
7682'weirdinvert' 'wiv' boolean (default off)
7683 global
7684 {not in Vi}
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00007685 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 It is provided for backwards compatibility with version 4.x.
7687 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
7688 vice versa. Has no effect when the GUI is running.
7689
7690 *'whichwrap'* *'ww'*
7691'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
7692 global
7693 {not in Vi}
7694 Allow specified keys that move the cursor left/right to move to the
7695 previous/next line when the cursor is on the first/last character in
7696 the line. Concatenate characters to allow this for these keys:
7697 char key mode ~
7698 b <BS> Normal and Visual
7699 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00007700 h "h" Normal and Visual (not recommended)
7701 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 < <Left> Normal and Visual
7703 > <Right> Normal and Visual
7704 ~ "~" Normal
7705 [ <Left> Insert and Replace
7706 ] <Right> Insert and Replace
7707 For example: >
7708 :set ww=<,>,[,]
7709< allows wrap only when cursor keys are used.
7710 When the movement keys are used in combination with a delete or change
7711 operator, the <EOL> also counts for a character. This makes "3h"
7712 different from "3dh" when the cursor crosses the end of a line. This
7713 is also true for "x" and "X", because they do the same as "dl" and
7714 "dh". If you use this, you may also want to use the mapping
7715 ":map <BS> X" to make backspace delete the character in front of the
7716 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00007717 When 'l' is included and it is used after an operator at the end of a
7718 line then it will not move to the next line. This makes "dl", "cl",
7719 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007720 NOTE: This option is set to the Vi default value when 'compatible' is
7721 set and to the Vim default value when 'compatible' is reset.
7722
7723 *'wildchar'* *'wc'*
7724'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
7725 global
7726 {not in Vi}
7727 Character you have to type to start wildcard expansion in the
7728 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007729 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007730 The character is not recognized when used inside a macro. See
7731 'wildcharm' for that.
7732 Although 'wc' is a number option, you can set it to a special key: >
7733 :set wc=<Esc>
7734< NOTE: This option is set to the Vi default value when 'compatible' is
7735 set and to the Vim default value when 'compatible' is reset.
7736
7737 *'wildcharm'* *'wcm'*
7738'wildcharm' 'wcm' number (default: none (0))
7739 global
7740 {not in Vi}
7741 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00007742 recognized when used inside a macro. You can find "spare" command-line
7743 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00007744 you'll never actually type 'wildcharm', just use it in mappings that
7745 automatically invoke completion mode, e.g.: >
7746 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00007747 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00007748< Then after typing :ss you can use CTRL-P & CTRL-N.
7749
7750 *'wildignore'* *'wig'*
7751'wildignore' 'wig' string (default "")
7752 global
7753 {not in Vi}
7754 {not available when compiled without the |+wildignore|
7755 feature}
7756 A list of file patterns. A file that matches with one of these
Bram Moolenaarbb5ddda2008-11-28 10:01:10 +00007757 patterns is ignored when completing file or directory names, and
7758 influences the result of |expand()|, |glob()| and |globpath()| unless
7759 a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007760 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
7761 Also see 'suffixes'.
7762 Example: >
7763 :set wildignore=*.o,*.obj
7764< The use of |:set+=| and |:set-=| is preferred when adding or removing
7765 a pattern from the list. This avoids problems when a future version
7766 uses another default.
7767
Bram Moolenaar94950a92010-12-02 16:01:29 +01007768
Bram Moolenaar81af9252010-12-10 20:35:50 +01007769 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01007770'wildignorecase' 'wic' boolean (default off)
7771 global
7772 {not in Vi}
7773 When set case is ignored when completing file names and directories.
7774 Has no effect on systems where file name case is generally ignored.
7775 Does not apply when the shell is used to expand wildcards, which
7776 happens when there are special characters.
7777
7778
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
7780'wildmenu' 'wmnu' boolean (default off)
7781 global
7782 {not in Vi}
7783 {not available if compiled without the |+wildmenu|
7784 feature}
7785 When 'wildmenu' is on, command-line completion operates in an enhanced
7786 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
7787 the possible matches are shown just above the command line, with the
7788 first match highlighted (overwriting the status line, if there is
7789 one). Keys that show the previous/next match, such as <Tab> or
7790 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
7791 When 'wildmode' is used, "wildmenu" mode is used where "full" is
7792 specified. "longest" and "list" do not start "wildmenu" mode.
7793 If there are more matches than can fit in the line, a ">" is shown on
7794 the right and/or a "<" is shown on the left. The status line scrolls
7795 as needed.
7796 The "wildmenu" mode is abandoned when a key is hit that is not used
7797 for selecting a completion.
7798 While the "wildmenu" is active the following keys have special
7799 meanings:
7800
7801 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
7802 <Down> - in filename/menu name completion: move into a
7803 subdirectory or submenu.
7804 <CR> - in menu completion, when the cursor is just after a
7805 dot: move into a submenu.
7806 <Up> - in filename/menu name completion: move up into
7807 parent directory or parent menu.
7808
7809 This makes the menus accessible from the console |console-menus|.
7810
7811 If you prefer the <Left> and <Right> keys to move the cursor instead
7812 of selecting a different match, use this: >
7813 :cnoremap <Left> <Space><BS><Left>
7814 :cnoremap <Right> <Space><BS><Right>
7815<
7816 The "WildMenu" highlighting is used for displaying the current match
7817 |hl-WildMenu|.
7818
7819 *'wildmode'* *'wim'*
7820'wildmode' 'wim' string (Vim default: "full")
7821 global
7822 {not in Vi}
7823 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007824 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00007825 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 first part specifies the behavior for the first use of 'wildchar',
7827 The second part for the second use, etc.
7828 These are the possible values for each part:
7829 "" Complete only the first match.
7830 "full" Complete the next full match. After the last match,
7831 the original string is used and then the first match
7832 again.
7833 "longest" Complete till longest common string. If this doesn't
7834 result in a longer string, use the next part.
7835 "longest:full" Like "longest", but also start 'wildmenu' if it is
7836 enabled.
7837 "list" When more than one match, list all matches.
7838 "list:full" When more than one match, list all matches and
7839 complete first match.
7840 "list:longest" When more than one match, list all matches and
7841 complete till longest common string.
7842 When there is only a single match, it is fully completed in all cases.
7843
7844 Examples: >
7845 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00007846< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 :set wildmode=longest,full
7848< Complete longest common string, then each full match >
7849 :set wildmode=list:full
7850< List all matches and complete each full match >
7851 :set wildmode=list,full
7852< List all matches without completing, then each full match >
7853 :set wildmode=longest,list
7854< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007855 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007856
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007857 *'wildoptions'* *'wop'*
7858'wildoptions' 'wop' string (default "")
7859 global
7860 {not in Vi}
7861 {not available when compiled without the |+wildignore|
7862 feature}
7863 A list of words that change how command line completion is done.
7864 Currently only one word is allowed:
7865 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007866 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007867 is displayed per line. Often used tag kinds are:
7868 d #define
7869 f function
7870 Also see |cmdline-completion|.
7871
Bram Moolenaar071d4272004-06-13 20:20:40 +00007872 *'winaltkeys'* *'wak'*
7873'winaltkeys' 'wak' string (default "menu")
7874 global
7875 {not in Vi}
7876 {only used in Win32, Motif, GTK and Photon GUI}
7877 Some GUI versions allow the access to menu entries by using the ALT
7878 key in combination with a character that appears underlined in the
7879 menu. This conflicts with the use of the ALT key for mappings and
7880 entering special characters. This option tells what to do:
7881 no Don't use ALT keys for menus. ALT key combinations can be
7882 mapped, but there is no automatic handling. This can then be
7883 done with the |:simalt| command.
7884 yes ALT key handling is done by the windowing system. ALT key
7885 combinations cannot be mapped.
7886 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007887 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00007888 keys can be mapped.
7889 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
7890 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007891 This option is not used for <F10>; on Win32 and with GTK <F10> will
7892 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007893
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007894 *'window'* *'wi'*
7895'window' 'wi' number (default screen height - 1)
7896 global
7897 Window height. Do not confuse this with the height of the Vim window,
7898 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00007899 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
7900 value is smaller than 'lines' minus one. The screen will scroll
7901 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00007902 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
7903 in a much smarter way, taking care of wrapping lines.
7904 When resizing the Vim window, the value is smaller than 1 or more than
7905 or equal to 'lines' it will be set to 'lines' minus 1.
7906 {Vi also uses the option to specify the number of displayed lines}
7907
Bram Moolenaar071d4272004-06-13 20:20:40 +00007908 *'winheight'* *'wh'* *E591*
7909'winheight' 'wh' number (default 1)
7910 global
7911 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007912 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007913 feature}
7914 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007915 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00007916 focus goes to a window that is smaller, its size is increased, at the
7917 cost of the height of other windows.
7918 Set 'winheight' to a small number for normal editing.
7919 Set it to 999 to make the current window fill most of the screen.
7920 Other windows will be only 'winminheight' high. This has the drawback
7921 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
7922 to create only two windows, set the option after startup is done,
7923 using the |VimEnter| event: >
7924 au VimEnter * set winheight=999
7925< Minimum value is 1.
7926 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 height of the current window.
7928 'winheight' applies to the current window. Use 'winminheight' to set
7929 the minimal height for other windows.
7930
7931 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
7932'winfixheight' 'wfh' boolean (default off)
7933 local to window
7934 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007935 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007936 feature}
7937 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007938 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
7939 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007940 The height may be changed anyway when running out of room.
7941
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007942 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
7943'winfixwidth' 'wfw' boolean (default off)
7944 local to window
7945 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007946 {not available when compiled without the |+windows|
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007947 feature}
7948 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00007949 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007950 The width may be changed anyway when running out of room.
7951
Bram Moolenaar071d4272004-06-13 20:20:40 +00007952 *'winminheight'* *'wmh'*
7953'winminheight' 'wmh' number (default 1)
7954 global
7955 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007956 {not available when compiled without the |+windows|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 feature}
7958 The minimal height of a window, when it's not the current window.
7959 This is a hard minimum, windows will never become smaller.
7960 When set to zero, windows may be "squashed" to zero lines (i.e. just a
7961 status bar) if necessary. They will return to at least one line when
7962 they become active (since the cursor has to have somewhere to go.)
7963 Use 'winheight' to set the minimal height of the current window.
7964 This option is only checked when making a window smaller. Don't use a
7965 large number, it will cause errors when opening more than a few
7966 windows. A value of 0 to 3 is reasonable.
7967
7968 *'winminwidth'* *'wmw'*
7969'winminwidth' 'wmw' number (default 1)
7970 global
7971 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007972 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 feature}
7974 The minimal width of a window, when it's not the current window.
7975 This is a hard minimum, windows will never become smaller.
7976 When set to zero, windows may be "squashed" to zero columns (i.e. just
7977 a vertical separator) if necessary. They will return to at least one
7978 line when they become active (since the cursor has to have somewhere
7979 to go.)
7980 Use 'winwidth' to set the minimal width of the current window.
7981 This option is only checked when making a window smaller. Don't use a
7982 large number, it will cause errors when opening more than a few
7983 windows. A value of 0 to 12 is reasonable.
7984
7985 *'winwidth'* *'wiw'* *E592*
7986'winwidth' 'wiw' number (default 20)
7987 global
7988 {not in Vi}
Bram Moolenaardb84e452010-08-15 13:50:43 +02007989 {not available when compiled without the |+vertsplit|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007990 feature}
7991 Minimal number of columns for the current window. This is not a hard
7992 minimum, Vim will use fewer columns if there is not enough room. If
7993 the current window is smaller, its size is increased, at the cost of
7994 the width of other windows. Set it to 999 to make the current window
7995 always fill the screen. Set it to a small number for normal editing.
7996 The width is not adjusted after one of the commands to change the
7997 width of the current window.
7998 'winwidth' applies to the current window. Use 'winminwidth' to set
7999 the minimal width for other windows.
8000
8001 *'wrap'* *'nowrap'*
8002'wrap' boolean (default on)
8003 local to window
8004 {not in Vi}
8005 This option changes how text is displayed. It doesn't change the text
8006 in the buffer, see 'textwidth' for that.
8007 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008008 displaying continues on the next line. When off lines will not wrap
8009 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008010 moved to a part that is not shown, the screen will scroll
8011 horizontally.
8012 The line will be broken in the middle of a word if necessary. See
8013 'linebreak' to get the break at a word boundary.
8014 To make scrolling horizontally a bit more useful, try this: >
8015 :set sidescroll=5
8016 :set listchars+=precedes:<,extends:>
8017< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008018 This option can't be set from a |modeline| when the 'diff' option is
8019 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020
8021 *'wrapmargin'* *'wm'*
8022'wrapmargin' 'wm' number (default 0)
8023 local to buffer
8024 Number of characters from the right window border where wrapping
8025 starts. When typing text beyond this limit, an <EOL> will be inserted
8026 and inserting continues on the next line.
8027 Options that add a margin, such as 'number' and 'foldcolumn', cause
8028 the text width to be further reduced. This is Vi compatible.
8029 When 'textwidth' is non-zero, this option is not used.
8030 See also 'formatoptions' and |ins-textwidth|. {Vi: works differently
8031 and less usefully}
8032
8033 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8034'wrapscan' 'ws' boolean (default on) *E384* *E385*
8035 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008036 Searches wrap around the end of the file. Also applies to |]s| and
8037 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008038
8039 *'write'* *'nowrite'*
8040'write' boolean (default on)
8041 global
8042 {not in Vi}
8043 Allows writing files. When not set, writing a file is not allowed.
8044 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008045 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008046 argument. Filtering text is still possible, even though this requires
8047 writing a temporary file.
8048
8049 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8050'writeany' 'wa' boolean (default off)
8051 global
8052 Allows writing to any file with no need for "!" override.
8053
8054 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8055'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8056 otherwise)
8057 global
8058 {not in Vi}
8059 Make a backup before overwriting a file. The backup is removed after
8060 the file was successfully written, unless the 'backup' option is
8061 also on. Reset this option if your file system is almost full. See
8062 |backup-table| for another explanation.
8063 When the 'backupskip' pattern matches, a backup is not made anyway.
8064 NOTE: This option is set to the default value when 'compatible' is
8065 set.
8066
8067 *'writedelay'* *'wd'*
8068'writedelay' 'wd' number (default 0)
8069 global
8070 {not in Vi}
8071 The number of microseconds to wait for each character sent to the
8072 screen. When non-zero, characters are sent to the terminal one by
8073 one. For MS-DOS pcterm this does not work. For debugging purposes.
8074
8075 vim:tw=78:ts=8:ft=help:norl: