blob: 42c7510cc31063c2f9c5e7f187826c987dad3d51 [file] [log] [blame]
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01001*options.txt* For Vim version 8.1. Last change: 2019 Nov 01
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
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
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200859 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200860 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200862 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200863 color from the terminal. If the returned RGB value is dark/light and
864 'background' is not dark/light, 'background' will be set and the
865 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200866 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100867 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When starting the GUI, the default value for 'background' will be
870 "light". When the value is not set in the .gvimrc, and Vim detects
871 that the background is actually quite dark, 'background' is set to
872 "dark". But this happens only AFTER the .gvimrc file has been read
873 (because the window needs to be opened to find the actual background
874 color). To get around this, force the GUI window to be opened by
875 putting a ":gui" command in the .gvimrc file, before where the value
876 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200877
878 For MS-DOS, Windows and OS/2 the default is "dark".
879 For other systems "dark" is used when 'term' is "linux",
880 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
881 background. Otherwise the default is "light".
882
Bram Moolenaarc572da52017-08-27 16:52:01 +0200883 The |:terminal| command and the |term_start()| function use the
884 'background' value to decide whether the terminal window will start
885 with a white or black background.
886
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 Normally this option would be set in the .vimrc file. Possibly
888 depending on the terminal name. Example: >
889 :if &term == "pcterm"
890 : set background=dark
891 :endif
892< When this option is set, the default settings for the highlight groups
893 will change. To use other settings, place ":highlight" commands AFTER
894 the setting of the 'background' option.
895 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
896 to select the colors for syntax highlighting. After changing this
897 option, you must load syntax.vim again to see the result. This can be
898 done with ":syntax on".
899
900 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200901'backspace' 'bs' string (default "", set to "indent,eol,start"
902 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
905 mode. This is a list of items, separated by commas. Each item allows
906 a way to backspace over something:
907 value effect ~
908 indent allow backspacing over autoindent
909 eol allow backspacing over line breaks (join lines)
910 start allow backspacing over the start of insert; CTRL-W and CTRL-U
911 stop once at the start of insert.
912
913 When the value is empty, Vi compatible backspacing is used.
914
915 For backwards compatibility with version 5.4 and earlier:
916 value effect ~
917 0 same as ":set backspace=" (Vi compatible)
918 1 same as ":set backspace=indent,eol"
919 2 same as ":set backspace=indent,eol,start"
920
921 See |:fixdel| if your <BS> or <Del> key does not do what you want.
922 NOTE: This option is set to "" when 'compatible' is set.
923
924 *'backup'* *'bk'* *'nobackup'* *'nobk'*
925'backup' 'bk' boolean (default off)
926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 Make a backup before overwriting a file. Leave it around after the
928 file has been successfully written. If you do not want to keep the
929 backup file, but you do want a backup while the file is being
930 written, reset this option and set the 'writebackup' option (this is
931 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000932 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 |backup-table| for more explanations.
934 When the 'backupskip' pattern matches, a backup is not made anyway.
935 When 'patchmode' is set, the backup may be renamed to become the
936 oldest version of a file.
937 NOTE: This option is reset when 'compatible' is set.
938
939 *'backupcopy'* *'bkc'*
940'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200941 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 When writing a file and a backup is made, this option tells how it's
943 done. This is a comma separated list of words.
944
945 The main values are:
946 "yes" make a copy of the file and overwrite the original one
947 "no" rename the file and write a new one
948 "auto" one of the previous, what works best
949
950 Extra values that can be combined with the ones above are:
951 "breaksymlink" always break symlinks when writing
952 "breakhardlink" always break hardlinks when writing
953
954 Making a copy and overwriting the original file:
955 - Takes extra time to copy the file.
956 + When the file has special attributes, is a (hard/symbolic) link or
957 has a resource fork, all this is preserved.
958 - When the file is a link the backup will have the name of the link,
959 not of the real file.
960
961 Renaming the file and writing a new one:
962 + It's fast.
963 - Sometimes not all attributes of the file can be copied to the new
964 file.
965 - When the file is a link the new file will not be a link.
966
967 The "auto" value is the middle way: When Vim sees that renaming file
968 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000969 the file is not a link) that is used. When problems are expected, a
970 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 The "breaksymlink" and "breakhardlink" values can be used in
973 combination with any of "yes", "no" and "auto". When included, they
974 force Vim to always break either symbolic or hard links by doing
975 exactly what the "no" option does, renaming the original file to
976 become the backup and writing a new file in its place. This can be
977 useful for example in source trees where all the files are symbolic or
978 hard links and any changes should stay in the local source tree, not
979 be propagated back to the original source.
980 *crontab*
981 One situation where "no" and "auto" will cause problems: A program
982 that opens a file, invokes Vim to edit that file, and then tests if
983 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000984 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 example.
986
987 When a copy is made, the original file is truncated and then filled
988 with the new text. This means that protection bits, owner and
989 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000990 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 group of the backup is set to the group of the original file. If this
992 fails, the protection bits for the group are made the same as for
993 others.
994
995 When the file is renamed this is the other way around: The backup has
996 the same attributes of the original file, and the newly written file
997 is owned by the current user. When the file was a (hard/symbolic)
998 link, the new file will not! That's why the "auto" value doesn't
999 rename when the file is a link. The owner and group of the newly
1000 written file will be set to the same ones as the original file, but
1001 the system may refuse to do this. In that case the "auto" value will
1002 again not rename the file.
1003
Bram Moolenaar036986f2017-03-16 17:41:02 +01001004 NOTE: This option is set to the Vi default value when 'compatible' is
1005 set and to the Vim default value when 'compatible' is reset.
1006
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 *'backupdir'* *'bdir'*
1008'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001009 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 for Unix: ".,~/tmp,~/")
1011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 List of directories for the backup file, separated with commas.
1013 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001014 where this is possible. The directory must exist, Vim will not
1015 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001016 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 impossible!). Writing may fail because of this.
1018 - A directory "." means to put the backup file in the same directory
1019 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001020 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 put the backup file relative to where the edited file is. The
1022 leading "." is replaced with the path name of the edited file.
1023 ("." inside a directory name has no special meaning).
1024 - Spaces after the comma are ignored, other spaces are considered part
1025 of the directory name. To have a space at the start of a directory
1026 name, precede it with a backslash.
1027 - To include a comma in a directory name precede it with a backslash.
1028 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001029 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001030 the backup file name will be built from the complete path to the
1031 file with all path separators changed to percent '%' signs. This
1032 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001033 On Win32, it is also possible to end with "\\". However, When a
1034 separating comma is following, you must use "//", since "\\" will
1035 include the comma in the file name. Therefore it is recommended to
1036 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 - Environment variables are expanded |:set_env|.
1038 - Careful with '\' characters, type one before a space, type two to
1039 get one in the option (see |option-backslash|), for example: >
1040 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1041< - For backwards compatibility with Vim version 3.0 a '>' at the start
1042 of the option is removed.
1043 See also 'backup' and 'writebackup' options.
1044 If you want to hide your backup files on Unix, consider this value: >
1045 :set backupdir=./.backup,~/.backup,.,/tmp
1046< You must create a ".backup" directory in each directory and in your
1047 home directory for this to work properly.
1048 The use of |:set+=| and |:set-=| is preferred when adding or removing
1049 directories from the list. This avoids problems when a future version
1050 uses another default.
1051 This option cannot be set from a |modeline| or in the |sandbox|, for
1052 security reasons.
1053
1054 *'backupext'* *'bex'* *E589*
1055'backupext' 'bex' string (default "~", for VMS: "_")
1056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 String which is appended to a file name to make the name of the
1058 backup file. The default is quite unusual, because this avoids
1059 accidentally overwriting existing files with a backup file. You might
1060 prefer using ".bak", but make sure that you don't have files with
1061 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001062 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001064 If you like to keep a lot of backups, you could use a BufWritePre
1065 autocommand to change 'backupext' just before writing the file to
1066 include a timestamp. >
1067 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1068< Use 'backupdir' to put the backup in a different directory.
1069
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001071'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1072 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1073 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 {not available when compiled without the |+wildignore|
1076 feature}
1077 A list of file patterns. When one of the patterns matches with the
1078 name of the file which is written, no backup file is created. Both
1079 the specified file name and the full path name of the file are used.
1080 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1081 Watch out for special characters, see |option-backslash|.
1082 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001083 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001084
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001085 WARNING: Not having a backup file means that when Vim fails to write
1086 your buffer correctly and then, for whatever reason, Vim exits, you
1087 lose both the original file and what you were writing. Only disable
1088 backups if you don't care about losing the file.
1089
Bram Moolenaar02467872007-05-06 13:22:01 +00001090 Note that environment variables are not expanded. If you want to use
1091 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001092 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001093
1094< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001095 backup would be made by renaming the original file crontab won't see
1096 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097
1098 *'balloondelay'* *'bdlay'*
1099'balloondelay' 'bdlay' number (default: 600)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 {only available when compiled with the |+balloon_eval|
1102 feature}
1103 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1104
1105 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1106'ballooneval' 'beval' boolean (default off)
1107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001109 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001110 Switch on the |balloon-eval| functionality for the GUI.
1111
1112 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1113 *'nobevalterm'*
1114'balloonevalterm' 'bevalterm' boolean (default off)
1115 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001116 {only available when compiled with the
1117 |+balloon_eval_term| feature}
1118 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 *'balloonexpr'* *'bexpr'*
1121'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001122 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123 {only available when compiled with the |+balloon_eval|
1124 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001125 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001126 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1127 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128
1129 v:beval_bufnr number of the buffer in which balloon is going to show
1130 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001131 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 v:beval_lnum line number
1133 v:beval_col column number (byte index)
1134 v:beval_text word under or after the mouse pointer
1135
Bram Moolenaar54775062019-07-31 21:07:14 +02001136 Instead of showing a balloon, which is limited to plain text, consider
1137 using a popup window, see |popup_beval_example|. A popup window can
1138 use highlighting and show a border.
1139
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140 The evaluation of the expression must not have side effects!
1141 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001142 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001143 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 \', column ' . v:beval_col .
1145 \ ' of file ' . bufname(v:beval_bufnr) .
1146 \ ' on word "' . v:beval_text . '"'
1147 endfunction
1148 set bexpr=MyBalloonExpr()
1149 set ballooneval
1150<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001151 Also see |balloon_show()|, it can be used if the content of the balloon
1152 is to be fetched asynchronously. In that case evaluating
1153 'balloonexpr' should result in an empty string. If you get a balloon
1154 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001155
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156 NOTE: The balloon is displayed only if the cursor is on a text
1157 character. If the result of evaluating 'balloonexpr' is not empty,
1158 Vim does not try to send a message to an external debugger (Netbeans
1159 or Sun Workshop).
1160
Bram Moolenaar30b65812012-07-12 22:01:11 +02001161 The expression will be evaluated in the |sandbox| when set from a
1162 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001163 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001164
1165 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001166 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001167
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001169 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001170< When they are supported "\n" characters will start a new line. If the
1171 expression evaluates to a |List| this is equal to using each List item
1172 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001173 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001174
Bram Moolenaar165bc692015-07-21 17:53:25 +02001175 *'belloff'* *'bo'*
1176'belloff' 'bo' string (default "")
1177 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001178 Specifies for which events the bell will not be rung. It is a comma
1179 separated list of items. For each item that is present, the bell
1180 will be silenced. This is most useful to specify specific events in
1181 insert mode to be silenced.
1182
1183 item meaning when present ~
1184 all All events.
1185 backspace When hitting <BS> or <Del> and deleting results in an
1186 error.
1187 cursor Fail to move around using the cursor keys or
1188 <PageUp>/<PageDown> in |Insert-mode|.
1189 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1190 |i_CTRL-X_CTRL-T|.
1191 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1192 |i_CTRL-E|.
1193 ctrlg Unknown Char after <C-G> in Insert mode.
1194 error Other Error occurred (e.g. try to join last line)
1195 (mostly used in |Normal-mode| or |Cmdline-mode|).
1196 esc hitting <Esc> in |Normal-mode|.
1197 ex In |Visual-mode|, hitting |Q| results in an error.
1198 hangul Error occurred when using hangul input.
1199 insertmode Pressing <Esc> in 'insertmode'.
1200 lang Calling the beep module for Lua/Mzscheme/TCL.
1201 mess No output available for |g<|.
1202 showmatch Error occurred for 'showmatch' function.
1203 operator Empty region error |cpo-E|.
1204 register Unknown register after <C-R> in |Insert-mode|.
1205 shell Bell from shell output |:!|.
1206 spell Error happened on spell suggest.
1207 wildmode More matches in |cmdline-completion| available
1208 (depends on the 'wildmode' setting).
1209
Bram Moolenaar036986f2017-03-16 17:41:02 +01001210 This is most useful to fine tune when in Insert mode the bell should
1211 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001212 indicate that an error occurred. It can be silenced by adding the
1213 "error" keyword.
1214
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1216'binary' 'bin' boolean (default off)
1217 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 This option should be set before editing a binary file. You can also
1219 use the |-b| Vim argument. When this option is switched on a few
1220 options will be changed (also when it already was on):
1221 'textwidth' will be set to 0
1222 'wrapmargin' will be set to 0
1223 'modeline' will be off
1224 'expandtab' will be off
1225 Also, 'fileformat' and 'fileformats' options will not be used, the
1226 file is read and written like 'fileformat' was "unix" (a single <NL>
1227 separates lines).
1228 The 'fileencoding' and 'fileencodings' options will not be used, the
1229 file is read without conversion.
1230 NOTE: When you start editing a(nother) file while the 'bin' option is
1231 on, settings from autocommands may change the settings again (e.g.,
1232 'textwidth'), causing trouble when editing. You might want to set
1233 'bin' again when the file has been loaded.
1234 The previous values of these options are remembered and restored when
1235 'bin' is switched from on to off. Each buffer has its own set of
1236 saved option values.
1237 To edit a file with 'binary' set you can use the |++bin| argument.
1238 This avoids you have to do ":set bin", which would have effect for all
1239 files you edit.
1240 When writing a file the <EOL> for the last line is only written if
1241 there was one in the original file (normally Vim appends an <EOL> to
1242 the last line if there is none; this would make the file longer). See
1243 the 'endofline' option.
1244
1245 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1246'bioskey' 'biosk' boolean (default on)
1247 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001248 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001249 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
1251 *'bomb'* *'nobomb'*
1252'bomb' boolean (default off)
1253 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 When writing a file and the following conditions are met, a BOM (Byte
1255 Order Mark) is prepended to the file:
1256 - this option is on
1257 - the 'binary' option is off
1258 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1259 endian variants.
1260 Some applications use the BOM to recognize the encoding of the file.
1261 Often used for UCS-2 files on MS-Windows. For other applications it
1262 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001263 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1265 check for the presence of the BOM is done and 'bomb' set accordingly.
1266 Unless 'binary' is set, it is removed from the first line, so that you
1267 don't see it when editing. When you don't change the options, the BOM
1268 will be restored when writing the file.
1269
1270 *'breakat'* *'brk'*
1271'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1272 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001273 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 feature}
1275 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001276 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1277 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001279 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280'breakindent' 'bri' boolean (default off)
1281 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001282 {not available when compiled without the |+linebreak|
1283 feature}
1284 Every wrapped line will continue visually indented (same amount of
1285 space as the beginning of that line), thus preserving horizontal blocks
1286 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001287 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288
1289 *'breakindentopt'* *'briopt'*
1290'breakindentopt' 'briopt' string (default empty)
1291 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 {not available when compiled without the |+linebreak|
1293 feature}
1294 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001295 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001296 min:{n} Minimum text width that will be kept after
1297 applying 'breakindent', even if the resulting
1298 text should normally be narrower. This prevents
1299 text indented almost to the right window border
1300 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001301 shift:{n} After applying 'breakindent', the wrapped line's
1302 beginning will be shifted by the given number of
1303 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001304 indentation (negative) or emphasizing the line
1305 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001306 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001307 additional indent.
1308 The default value for min is 20 and shift is 0.
1309
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001311'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001313 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001315 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001316 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 buffer Use the directory of the related buffer.
1318 current Use the current directory.
1319 {path} Use the specified directory
1320
1321 *'bufhidden'* *'bh'*
1322'bufhidden' 'bh' string (default: "")
1323 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 This option specifies what happens when a buffer is no longer
1325 displayed in a window:
1326 <empty> follow the global 'hidden' option
1327 hide hide the buffer (don't unload it), also when 'hidden'
1328 is not set
1329 unload unload the buffer, also when 'hidden' is set or using
1330 |:hide|
1331 delete delete the buffer from the buffer list, also when
1332 'hidden' is set or using |:hide|, like using
1333 |:bdelete|
1334 wipe wipe out the buffer from the buffer list, also when
1335 'hidden' is set or using |:hide|, like using
1336 |:bwipeout|
1337
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001338 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001339 are lost without a warning. Also, these values may break autocommands
1340 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 This option is used together with 'buftype' and 'swapfile' to specify
1342 special kinds of buffers. See |special-buffers|.
1343
1344 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1345'buflisted' 'bl' boolean (default: on)
1346 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 When this option is set, the buffer shows up in the buffer list. If
1348 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1349 This option is reset by Vim for buffers that are only used to remember
1350 a file name or marks. Vim sets it when starting to edit a buffer.
1351 But not when moving to a buffer with ":buffer".
1352
1353 *'buftype'* *'bt'* *E382*
1354'buftype' 'bt' string (default: "")
1355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 The value of this option specifies the type of a buffer:
1357 <empty> normal buffer
1358 nofile buffer which is not related to a file and will not be
1359 written
1360 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001361 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001362 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001364 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 help help buffer (you are not supposed to set this
1366 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001367 terminal buffer for a |terminal| (you are not supposed to set
1368 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001369 prompt buffer where only the last line can be edited, meant
1370 to be used by a plugin, see |prompt-buffer|
1371 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001372 popup buffer used in a popup window, see |popup|.
1373 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374
1375 This option is used together with 'bufhidden' and 'swapfile' to
1376 specify special kinds of buffers. See |special-buffers|.
1377
1378 Be careful with changing this option, it can have many side effects!
1379
Bram Moolenaar280f1262006-01-30 00:14:18 +00001380 A "quickfix" buffer is only used for the error list and the location
1381 list. This value is set by the |:cwindow| and |:lwindow| commands and
1382 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383
1384 "nofile" and "nowrite" buffers are similar:
1385 both: The buffer is not to be written to disk, ":w" doesn't
1386 work (":w filename" does work though).
1387 both: The buffer is never considered to be |'modified'|.
1388 There is no warning when the changes will be lost, for
1389 example when you quit Vim.
1390 both: A swap file is only created when using too much memory
1391 (when 'swapfile' has been reset there is never a swap
1392 file).
1393 nofile only: The buffer name is fixed, it is not handled like a
1394 file name. It is not modified in response to a |:cd|
1395 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001396 both: When using ":e bufname" and already editing "bufname"
1397 the buffer is made empty and autocommands are
1398 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001399 *E676*
1400 "acwrite" implies that the buffer name is not related to a file, like
1401 "nofile", but it will be written. Thus, in contrast to "nofile" and
1402 "nowrite", ":w" does work and a modified buffer can't be abandoned
1403 without saving. For writing there must be matching |BufWriteCmd|,
1404 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 *'casemap'* *'cmp'*
1407'casemap' 'cmp' string (default: "internal,keepascii")
1408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 Specifies details about changing the case of letters. It may contain
1410 these words, separated by a comma:
1411 internal Use internal case mapping functions, the current
1412 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001413 matters when 'encoding' is a Unicode encoding,
1414 "latin1" or "iso-8859-15". When "internal" is
1415 omitted, the towupper() and towlower() system library
1416 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1418 case mapping, the current locale is not effective.
1419 This probably only matters for Turkish.
1420
1421 *'cdpath'* *'cd'* *E344* *E346*
1422'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 {not available when compiled without the
1425 |+file_in_path| feature}
1426 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001427 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1428 searched for has a relative path, not an absolute part starting with
1429 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 The 'cdpath' option's value has the same form and semantics as
1431 |'path'|. Also see |file-searching|.
1432 The default value is taken from $CDPATH, with a "," prepended to look
1433 in the current directory first.
1434 If the default value taken from $CDPATH is not what you want, include
1435 a modified version of the following command in your vimrc file to
1436 override it: >
1437 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1438< This option cannot be set from a |modeline| or in the |sandbox|, for
1439 security reasons.
1440 (parts of 'cdpath' can be passed to the shell to expand file names).
1441
1442 *'cedit'*
1443'cedit' string (Vi default: "", Vim default: CTRL-F)
1444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 The key used in Command-line Mode to open the command-line window.
1446 The default is CTRL-F when 'compatible' is off.
1447 Only non-printable keys are allowed.
1448 The key can be specified as a single character, but it is difficult to
1449 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001450 :exe "set cedit=\<C-Y>"
1451 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452< |Nvi| also has this option, but it only uses the first character.
1453 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001454 NOTE: This option is set to the Vim default value when 'compatible'
1455 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1458'charconvert' 'ccv' string (default "")
1459 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001460 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 An expression that is used for character encoding conversion. It is
1462 evaluated when a file that is to be read or has been written has a
1463 different encoding from what is desired.
1464 'charconvert' is not used when the internal iconv() function is
1465 supported and is able to do the conversion. Using iconv() is
1466 preferred, because it is much faster.
1467 'charconvert' is not used when reading stdin |--|, because there is no
1468 file to convert from. You will have to save the text in a file first.
1469 The expression must return zero or an empty string for success,
1470 non-zero for failure.
1471 The possible encoding names encountered are in 'encoding'.
1472 Additionally, names given in 'fileencodings' and 'fileencoding' are
1473 used.
1474 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1475 is done internally by Vim, 'charconvert' is not used for this.
1476 'charconvert' is also used to convert the viminfo file, if the 'c'
1477 flag is present in 'viminfo'. Also used for Unicode conversion.
1478 Example: >
1479 set charconvert=CharConvert()
1480 fun CharConvert()
1481 system("recode "
1482 \ . v:charconvert_from . ".." . v:charconvert_to
1483 \ . " <" . v:fname_in . " >" v:fname_out)
1484 return v:shell_error
1485 endfun
1486< The related Vim variables are:
1487 v:charconvert_from name of the current encoding
1488 v:charconvert_to name of the desired encoding
1489 v:fname_in name of the input file
1490 v:fname_out name of the output file
1491 Note that v:fname_in and v:fname_out will never be the same.
1492 Note that v:charconvert_from and v:charconvert_to may be different
1493 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1494 Encryption is not done by Vim when using 'charconvert'. If you want
1495 to encrypt the file after conversion, 'charconvert' should take care
1496 of this.
1497 This option cannot be set from a |modeline| or in the |sandbox|, for
1498 security reasons.
1499
1500 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1501'cindent' 'cin' boolean (default off)
1502 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 {not available when compiled without the |+cindent|
1504 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001505 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 that trigger reindenting in insert mode and 'cinoptions' to set your
1507 preferred indent style.
1508 If 'indentexpr' is not empty, it overrules 'cindent'.
1509 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1510 the "=" operator indents using this algorithm rather than calling an
1511 external program.
1512 See |C-indenting|.
1513 When you don't like the way 'cindent' works, try the 'smartindent'
1514 option or 'indentexpr'.
1515 This option is not used when 'paste' is set.
1516 NOTE: This option is reset when 'compatible' is set.
1517
1518 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001519'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 {not available when compiled without the |+cindent|
1522 feature}
1523 A list of keys that, when typed in Insert mode, cause reindenting of
1524 the current line. Only used if 'cindent' is on and 'indentexpr' is
1525 empty.
1526 For the format of this option see |cinkeys-format|.
1527 See |C-indenting|.
1528
1529 *'cinoptions'* *'cino'*
1530'cinoptions' 'cino' string (default "")
1531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 {not available when compiled without the |+cindent|
1533 feature}
1534 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1535 program. See |cinoptions-values| for the values of this option, and
1536 |C-indenting| for info on C indenting in general.
1537
1538
1539 *'cinwords'* *'cinw'*
1540'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 {not available when compiled without both the
1543 |+cindent| and the |+smartindent| features}
1544 These keywords start an extra indent in the next line when
1545 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1546 an appropriate place (inside {}).
1547 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1548 matter, include the keyword both the uppercase and lowercase:
1549 "if,If,IF".
1550
1551 *'clipboard'* *'cb'*
1552'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1553 for X-windows, "" otherwise)
1554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 {only in GUI versions or when the |+xterm_clipboard|
1556 feature is included}
1557 This option is a list of comma separated names.
1558 These names are recognized:
1559
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001560 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 unnamed When included, Vim will use the clipboard register '*'
1562 for all yank, delete, change and put operations which
1563 would normally go to the unnamed register. When a
1564 register is explicitly specified, it will always be
1565 used regardless of whether "unnamed" is in 'clipboard'
1566 or not. The clipboard register can always be
1567 explicitly accessed using the "* notation. Also see
1568 |gui-clipboard|.
1569
Bram Moolenaar30b65812012-07-12 22:01:11 +02001570 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001571 unnamedplus A variant of the "unnamed" flag which uses the
1572 clipboard register '+' (|quoteplus|) instead of
1573 register '*' for all yank, delete, change and put
1574 operations which would normally go to the unnamed
1575 register. When "unnamed" is also included to the
1576 option, yank operations (but not delete, change or
1577 put) will additionally copy the text into register
1578 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001579 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001580 Availability can be checked with: >
1581 if has('unnamedplus')
1582<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001583 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 autoselect Works like the 'a' flag in 'guioptions': If present,
1585 then whenever Visual mode is started, or the Visual
1586 area extended, Vim tries to become the owner of the
1587 windowing system's global selection or put the
1588 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001589 register "*. See |'go-a'| and |quotestar| for details.
1590 When the GUI is active, the 'a' flag in 'guioptions'
1591 is used, when the GUI is not active, this "autoselect"
1592 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 Also applies to the modeless selection.
1594
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001595 *clipboard-autoselectplus*
1596 autoselectplus Like "autoselect" but using the + register instead of
1597 the * register. Compare to the 'P' flag in
1598 'guioptions'.
1599
1600 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 autoselectml Like "autoselect", but for the modeless selection
1602 only. Compare to the 'A' flag in 'guioptions'.
1603
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001604 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001605 html When the clipboard contains HTML, use this when
1606 pasting. When putting text on the clipboard, mark it
1607 as HTML. This works to copy rendered HTML from
1608 Firefox, paste it as raw HTML in Vim, select the HTML
1609 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001610 You probably want to add this only temporarily,
1611 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001612 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 exclude:{pattern}
1616 Defines a pattern that is matched against the name of
1617 the terminal 'term'. If there is a match, no
1618 connection will be made to the X server. This is
1619 useful in this situation:
1620 - Running Vim in a console.
1621 - $DISPLAY is set to start applications on another
1622 display.
1623 - You do not want to connect to the X server in the
1624 console, but do want this in a terminal emulator.
1625 To never connect to the X server use: >
1626 exclude:.*
1627< This has the same effect as using the |-X| argument.
1628 Note that when there is no connection to the X server
1629 the window title won't be restored and the clipboard
1630 cannot be accessed.
1631 The value of 'magic' is ignored, {pattern} is
1632 interpreted as if 'magic' was on.
1633 The rest of the option value will be used for
1634 {pattern}, this must be the last entry.
1635
1636 *'cmdheight'* *'ch'*
1637'cmdheight' 'ch' number (default 1)
1638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 Number of screen lines to use for the command-line. Helps avoiding
1640 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001641 The value of this option is stored with the tab page, so that each tab
1642 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643
1644 *'cmdwinheight'* *'cwh'*
1645'cmdwinheight' 'cwh' number (default 7)
1646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 Number of screen lines to use for the command-line window. |cmdwin|
1648
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001649 *'colorcolumn'* *'cc'*
1650'colorcolumn' 'cc' string (default "")
1651 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001652 {not available when compiled without the |+syntax|
1653 feature}
1654 'colorcolumn' is a comma separated list of screen columns that are
1655 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1656 text. Will make screen redrawing slower.
1657 The screen column can be an absolute number, or a number preceded with
1658 '+' or '-', which is added to or subtracted from 'textwidth'. >
1659
1660 :set cc=+1 " highlight column after 'textwidth'
1661 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1662 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1663<
1664 When 'textwidth' is zero then the items with '-' and '+' are not used.
1665 A maximum of 256 columns are highlighted.
1666
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 *'columns'* *'co'* *E594*
1668'columns' 'co' number (default 80 or terminal width)
1669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001671 initialization and does not have to be set by hand. Also see
1672 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 When Vim is running in the GUI or in a resizable window, setting this
1674 option will cause the window size to be changed. When you only want
1675 to use the size for the GUI, put the command in your |gvimrc| file.
1676 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001677 number of columns of the display, the display may be messed up. For
1678 the GUI it is always possible and Vim limits the number of columns to
1679 what fits on the screen. You can use this command to get the widest
1680 window possible: >
1681 :set columns=9999
1682< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683
1684 *'comments'* *'com'* *E524* *E525*
1685'comments' 'com' string (default
1686 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1687 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 A comma separated list of strings that can start a comment line. See
1689 |format-comments|. See |option-backslash| about using backslashes to
1690 insert a space.
1691
1692 *'commentstring'* *'cms'* *E537*
1693'commentstring' 'cms' string (default "/*%s*/")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 This option has the effect of making Vim either more Vi-compatible, or
1706 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709 other options are also changed as a side effect.
1710 NOTE: Setting or resetting this option can have a lot of unexpected
1711 effects: Mappings are interpreted in another way, undo behaves
1712 differently, etc. If you set this option in your vimrc file, you
1713 should probably put it at the very start.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 By default this option is on and the Vi defaults are used for the
1716 options. This default was chosen for those people who want to use Vim
1717 just like Vi, and don't even (want to) know about the 'compatible'
1718 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 this option is switched off, and all options that have not been
1721 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001722 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001723 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 happen for the system-wide vimrc or gvimrc file, nor for a file given
1725 with the |-u| argument). Also see |compatible-default| and
1726 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 You can also set this option with the "-C" argument, and reset it with
1728 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 When this option is set, numerous other options are set to make Vim as
1732 Vi-compatible as possible. When this option is unset, various options
1733 are set to make Vim more useful. The table below lists all the
1734 options affected.
1735 The {?} column indicates when the options are affected:
1736 + Means that the option is set to the value given in {set value} when
1737 'compatible' is set.
1738 & Means that the option is set to the value given in {set value} when
1739 'compatible' is set AND is set to its Vim default value when
1740 'compatible' is unset.
1741 - Means the option is NOT changed when setting 'compatible' but IS
1742 set to its Vim default when 'compatible' is unset.
1743 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
Bram Moolenaar036986f2017-03-16 17:41:02 +01001745 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
1747 'allowrevins' + off no CTRL-_ command
1748 'antialias' + off don't use antialiased fonts
1749 'arabic' + off reset arabic-related options
1750 'arabicshape' + on correct character shapes
1751 'backspace' + "" normal backspace
1752 'backup' + off no backup file
1753 'backupcopy' & Unix: "yes" backup file is a copy
1754 else: "auto" copy or rename backup file
1755 'balloonexpr' + "" text to show in evaluation balloon
1756 'breakindent' + off don't indent when wrapping lines
1757 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1758 'cindent' + off no C code indentation
1759 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1760 'copyindent' + off don't copy indent structure
1761 'cpoptions' & (all flags) Vi-compatible flags
1762 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001763 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001764 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001765 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopeverbose' + off see |cscopeverbose|
1767 'delcombine' + off unicode: delete whole char combination
1768 'digraph' + off no digraphs
1769 'esckeys' & off no <Esc>-keys in Insert mode
1770 'expandtab' + off tabs not expanded to spaces
1771 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'formatexpr' + "" use 'formatprg' for auto-formatting
1774 'formatoptions' & "vt" Vi compatible formatting
1775 'gdefault' + off no default 'g' flag for ":s"
1776 'history' & 0 no commandline history
1777 'hkmap' + off no Hebrew keyboard mapping
1778 'hkmapp' + off no phonetic Hebrew keyboard mapping
1779 'hlsearch' + off no highlighting of search matches
1780 'incsearch' + off no incremental searching
1781 'indentexpr' + "" no indenting by expression
1782 'insertmode' + off do not start in Insert mode
1783 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'joinspaces' + on insert 2 spaces after period
1786 'modeline' & off no modelines
1787 'more' & off no pauses in listings
1788 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1789 'numberwidth' & 8 min number of columns for line number
1790 'preserveindent'+ off don't preserve current indent structure
1791 when changing it
1792 'revins' + off no reverse insert
1793 'ruler' + off no ruler
1794 'scrolljump' + 1 no jump scroll
1795 'scrolloff' + 0 no scroll offset
1796 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1797 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001798 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'showcmd' & off command characters not shown
1800 'showmode' & off current mode not shown
1801 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1802 'smartcase' + off no automatic ignore case switch
1803 'smartindent' + off no smart indentation
1804 'smarttab' + off no smart tab size
1805 'softtabstop' + 0 tabs are always 'tabstop' positions
1806 'startofline' + on goto startofline with some commands
1807 'tagcase' & "followic" 'ignorecase' when searching tags file
1808 'tagrelative' & off tag file names are not relative
1809 'termguicolors' + off don't use highlight-(guifg|guibg)
1810 'textauto' & off no automatic textmode detection
1811 'textwidth' + 0 no automatic line wrap
1812 'tildeop' + off tilde is not an operator
1813 'ttimeout' + off no terminal timeout
1814 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'virtualedit' + "" cursor can only be placed on characters
1817 'whichwrap' & "" left-right movements don't wrap
1818 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822 *'complete'* *'cpt'* *E535*
1823'complete' 'cpt' string (default: ".,w,b,u,t,i")
1824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This option specifies how keyword completion |ins-completion| works
1826 when CTRL-P or CTRL-N are used. It is also used for whole-line
1827 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1828 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001829 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 w scan buffers from other windows
1831 b scan other loaded buffers that are in the buffer list
1832 u scan the unloaded buffers that are in the buffer list
1833 U scan the buffers that are not in the buffer list
1834 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001835 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 k{dict} scan the file {dict}. Several "k" flags can be given,
1837 patterns are valid too. For example: >
1838 :set cpt=k/usr/dict/*,k~/spanish
1839< s scan the files given with the 'thesaurus' option
1840 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1841 are valid too.
1842 i scan current and included files
1843 d scan current and included files for defined name or macro
1844 |i_CTRL-X_CTRL-D|
1845 ] tag completion
1846 t same as "]"
1847
1848 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1849 not executed, this may lead to unexpected completions from some files
1850 (gzipped files for example). Unloaded buffers are not scanned for
1851 whole-line completion.
1852
1853 The default is ".,w,b,u,t,i", which means to scan:
1854 1. the current buffer
1855 2. buffers in other windows
1856 3. other loaded buffers
1857 4. unloaded buffers
1858 5. tags
1859 6. included files
1860
1861 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001862 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1863 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001865 *'completefunc'* *'cfu'*
1866'completefunc' 'cfu' string (default: empty)
1867 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001868 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001869 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001870 This option specifies a function to be used for Insert mode completion
1871 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001872 See |complete-functions| for an explanation of how the function is
1873 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001874 This option cannot be set from a |modeline| or in the |sandbox|, for
1875 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001876
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001877 *'completeslash'* *'csl'*
1878'completeslash' 'csl' string (default: "")
1879 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001880 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001881 When this option is set it overrules 'shellslash' for completion:
1882 - When this option is set to "slash", a forward slash is used for path
1883 completion in insert mode. This is useful when editing HTML tag, or
1884 Makefile with 'noshellslash' on Windows.
1885 - When this option is set to "backslash", backslash is used. This is
1886 useful when editing a batch file with 'shellslash' set on Windows.
1887 - When this option is empty, same character is used as for
1888 'shellslash'.
1889 For Insert mode completion the buffer-local value is used. For
1890 command line completion the global value is used.
1891
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001895 A comma separated list of options for Insert mode completion
1896 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001897
1898 menu Use a popup menu to show the possible completions. The
1899 menu is only shown when there is more than one match and
1900 sufficient colors are available. |ins-completion-menu|
1901
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001902 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001903 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 match, e.g., what file it comes from.
1905
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001906 longest Only insert the longest common text of the matches. If
1907 the menu is displayed you can use CTRL-L to add more
1908 characters. Whether case is ignored depends on the kind
1909 of completion. For buffer text the 'ignorecase' option is
1910 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001911
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001912 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001913 completion in the preview window. Only works in
1914 combination with "menu" or "menuone".
1915
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001916 popup Show extra information about the currently selected
1917 completion in a popup window. Only works in combination
1918 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001919 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001920 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001921
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001922 popuphidden
1923 Just like "popup" but initially hide the popup. Use a
1924 |CompleteChanged| autocommand to fetch the info and call
1925 |popup_show()| once the popup has been filled.
1926 See the example at |complete-popuphidden|.
1927 {only works when compiled with the |+textprop| feature}
1928
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001929 noinsert Do not insert any text for a match until the user selects
1930 a match from the menu. Only works in combination with
1931 "menu" or "menuone". No effect if "longest" is present.
1932
1933 noselect Do not select a match in the menu, force the user to
1934 select one from the menu. Only works in combination with
1935 "menu" or "menuone".
1936
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001937
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001938 *'completepopup'* *'cpp'*
1939'completepopup' 'cpp' string (default empty)
1940 global
1941 {not available when compiled without the |+textprop|
1942 or |+quickfix| feature}
1943 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001944 properties of the info popup when it is created. You can also use
1945 |popup_findinfo()| and then set properties for an existing info popup
1946 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001947
1948
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001949 *'concealcursor'* *'cocu'*
1950'concealcursor' 'cocu' string (default: "")
1951 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952 {not available when compiled without the |+conceal|
1953 feature}
1954 Sets the modes in which text in the cursor line can also be concealed.
1955 When the current mode is listed then concealing happens just like in
1956 other lines.
1957 n Normal mode
1958 v Visual mode
1959 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001960 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001961
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001962 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001963 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 are moving around text is concealed, but when starting to insert text
1965 or selecting a Visual area the concealed text is displayed, so that
1966 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001967 Keep in mind that the cursor position is not always where it's
1968 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001969
1970
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001971 *'conceallevel'* *'cole'*
1972'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001974 {not available when compiled without the |+conceal|
1975 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001976 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1977 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001979 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001981 1 Each block of concealed text is replaced with one
1982 character. If the syntax item does not have a custom
1983 replacement character defined (see |:syn-cchar|) the
1984 character defined in 'listchars' is used (default is a
1985 space).
1986 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 2 Concealed text is completely hidden unless it has a
1988 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001989 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001990 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001991
Bram Moolenaara7781e02010-07-19 20:13:22 +02001992 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001993 edit and copy the text. This can be changed with the 'concealcursor'
1994 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001995
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1997'confirm' 'cf' boolean (default off)
1998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 When 'confirm' is on, certain operations that would normally
2000 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2001 instead raise a |dialog| asking if you wish to save the current
2002 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2003 If 'confirm' is off you can still activate confirmation for one
2004 command only (this is most useful in mappings) with the |:confirm|
2005 command.
2006 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2007
2008 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2009'conskey' 'consk' boolean (default off)
2010 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002011 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012
2013 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2014'copyindent' 'ci' boolean (default off)
2015 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 Copy the structure of the existing lines indent when autoindenting a
2017 new line. Normally the new indent is reconstructed by a series of
2018 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2019 in which case only spaces are used). Enabling this option makes the
2020 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002021 existing line. 'expandtab' has no effect on these characters, a Tab
2022 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002024 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 Also see 'preserveindent'.
2026
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002027 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028'cpoptions' 'cpo' string (Vim default: "aABceFs",
2029 Vi default: all flags)
2030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002032 this indicates Vi-compatible behavior. This is used for things where
2033 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 'cpoptions' stands for "compatible-options".
2035 Commas can be added for readability.
2036 To avoid problems with flags that are added in the future, use the
2037 "+=" and "-=" feature of ":set" |add-option-flags|.
2038 NOTE: This option is set to the Vi default value when 'compatible' is
2039 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040 NOTE: This option is set to the POSIX default value at startup when
2041 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002042 variable exists |posix|. This means Vim tries to behave like the
2043 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
2045 contains behavior ~
2046 *cpo-a*
2047 a When included, a ":read" command with a file name
2048 argument will set the alternate file name for the
2049 current window.
2050 *cpo-A*
2051 A When included, a ":write" command with a file name
2052 argument will set the alternate file name for the
2053 current window.
2054 *cpo-b*
2055 b "\|" in a ":map" command is recognized as the end of
2056 the map command. The '\' is included in the mapping,
2057 the text after the '|' is interpreted as the next
2058 command. Use a CTRL-V instead of a backslash to
2059 include the '|' in the mapping. Applies to all
2060 mapping, abbreviation, menu and autocmd commands.
2061 See also |map_bar|.
2062 *cpo-B*
2063 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002064 abbreviations, user commands and the "to" part of the
2065 menu commands. Remove this flag to be able to use a
2066 backslash like a CTRL-V. For example, the command
2067 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 'B' included: "\^[" (^[ is a real <Esc>)
2069 'B' excluded: "<Esc>" (5 characters)
2070 ('<' excluded in both cases)
2071 *cpo-c*
2072 c Searching continues at the end of any match at the
2073 cursor position, but not further than the start of the
2074 next line. When not present searching continues
2075 one character from the cursor position. With 'c'
2076 "abababababab" only gets three matches when repeating
2077 "/abab", without 'c' there are five matches.
2078 *cpo-C*
2079 C Do not concatenate sourced lines that start with a
2080 backslash. See |line-continuation|.
2081 *cpo-d*
2082 d Using "./" in the 'tags' option doesn't mean to use
2083 the tags file relative to the current file, but the
2084 tags file in the current directory.
2085 *cpo-D*
2086 D Can't use CTRL-K to enter a digraph after Normal mode
2087 commands with a character argument, like |r|, |f| and
2088 |t|.
2089 *cpo-e*
2090 e When executing a register with ":@r", always add a
2091 <CR> to the last line, also when the register is not
2092 linewise. If this flag is not present, the register
2093 is not linewise and the last line does not end in a
2094 <CR>, then the last line is put on the command-line
2095 and can be edited before hitting <CR>.
2096 *cpo-E*
2097 E It is an error when using "y", "d", "c", "g~", "gu" or
2098 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002099 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 This makes "y0" fail in the first column.
2101 *cpo-f*
2102 f When included, a ":read" command with a file name
2103 argument will set the file name for the current buffer,
2104 if the current buffer doesn't have a file name yet.
2105 *cpo-F*
2106 F When included, a ":write" command with a file name
2107 argument will set the file name for the current
2108 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002109 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 *cpo-g*
2111 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002112 *cpo-H*
2113 H When using "I" on a line with only blanks, insert
2114 before the last blank. Without this flag insert after
2115 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 *cpo-i*
2117 i When included, interrupting the reading of a file will
2118 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002119 *cpo-I*
2120 I When moving the cursor up or down just after inserting
2121 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-j*
2123 j When joining lines, only add two spaces after a '.',
2124 not after '!' or '?'. Also see 'joinspaces'.
2125 *cpo-J*
2126 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002127 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 white space.
2129 *cpo-k*
2130 k Disable the recognition of raw key codes in
2131 mappings, abbreviations, and the "to" part of menu
2132 commands. For example, if <Key> sends ^[OA (where ^[
2133 is <Esc>), the command ":map X ^[OA" results in X
2134 being mapped to:
2135 'k' included: "^[OA" (3 characters)
2136 'k' excluded: "<Key>" (one key code)
2137 Also see the '<' flag below.
2138 *cpo-K*
2139 K Don't wait for a key code to complete when it is
2140 halfway a mapping. This breaks mapping <F1><F1> when
2141 only part of the second <F1> has been read. It
2142 enables cancelling the mapping by typing <F1><Esc>.
2143 *cpo-l*
2144 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002145 literally, only "\]", "\^", "\-" and "\\" are special.
2146 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2148 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002149 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 *cpo-L*
2151 L When the 'list' option is set, 'wrapmargin',
2152 'textwidth', 'softtabstop' and Virtual Replace mode
2153 (see |gR|) count a <Tab> as two characters, instead of
2154 the normal behavior of a <Tab>.
2155 *cpo-m*
2156 m When included, a showmatch will always wait half a
2157 second. When not included, a showmatch will wait half
2158 a second or until a character is typed. |'showmatch'|
2159 *cpo-M*
2160 M When excluded, "%" matching will take backslashes into
2161 account. Thus in "( \( )" and "\( ( \)" the outer
2162 parenthesis match. When included "%" ignores
2163 backslashes, which is Vi compatible.
2164 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002165 n When included, the column used for 'number' and
2166 'relativenumber' will also be used for text of wrapped
2167 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 *cpo-o*
2169 o Line offset to search command is not remembered for
2170 next search.
2171 *cpo-O*
2172 O Don't complain if a file is being overwritten, even
2173 when it didn't exist when editing it. This is a
2174 protection against a file unexpectedly created by
2175 someone else. Vi didn't complain about this.
2176 *cpo-p*
2177 p Vi compatible Lisp indenting. When not present, a
2178 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002179 *cpo-P*
2180 P When included, a ":write" command that appends to a
2181 file will set the file name for the current buffer, if
2182 the current buffer doesn't have a file name yet and
2183 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002184 *cpo-q*
2185 q When joining multiple lines leave the cursor at the
2186 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *cpo-r*
2188 r Redo ("." command) uses "/" to repeat a search
2189 command, instead of the actually used search string.
2190 *cpo-R*
2191 R Remove marks from filtered lines. Without this flag
2192 marks are kept like |:keepmarks| was used.
2193 *cpo-s*
2194 s Set buffer options when entering the buffer for the
2195 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002196 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 set when the buffer is created.
2198 *cpo-S*
2199 S Set buffer options always when entering a buffer
2200 (except 'readonly', 'fileformat', 'filetype' and
2201 'syntax'). This is the (most) Vi compatible setting.
2202 The options are set to the values in the current
2203 buffer. When you change an option and go to another
2204 buffer, the value is copied. Effectively makes the
2205 buffer options global to all buffers.
2206
2207 's' 'S' copy buffer options
2208 no no when buffer created
2209 yes no when buffer first entered (default)
2210 X yes each time when buffer entered (vi comp.)
2211 *cpo-t*
2212 t Search pattern for the tag command is remembered for
2213 "n" command. Otherwise Vim only puts the pattern in
2214 the history for search pattern, but doesn't change the
2215 last used search pattern.
2216 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002217 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *cpo-v*
2219 v Backspaced characters remain visible on the screen in
2220 Insert mode. Without this flag the characters are
2221 erased from the screen right away. With this flag the
2222 screen newly typed text overwrites backspaced
2223 characters.
2224 *cpo-w*
2225 w When using "cw" on a blank character, only change one
2226 character and not all blanks until the start of the
2227 next word.
2228 *cpo-W*
2229 W Don't overwrite a readonly file. When omitted, ":w!"
2230 overwrites a readonly file, if possible.
2231 *cpo-x*
2232 x <Esc> on the command-line executes the command-line.
2233 The default in Vim is to abandon the command-line,
2234 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002235 *cpo-X*
2236 X When using a count with "R" the replaced text is
2237 deleted only once. Also when repeating "R" with "."
2238 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002240 y A yank command can be redone with ".". Think twice if
2241 you really want to use this, it may break some
2242 plugins, since most people expect "." to only repeat a
2243 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002244 *cpo-Z*
2245 Z When using "w!" while the 'readonly' option is set,
2246 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 *cpo-!*
2248 ! When redoing a filter command, use the last used
2249 external command, whatever it was. Otherwise the last
2250 used -filter- command is used.
2251 *cpo-$*
2252 $ When making a change to one line, don't redisplay the
2253 line, but put a '$' at the end of the changed text.
2254 The changed text will be overwritten when you type the
2255 new text. The line is redisplayed if you type any
2256 command that moves the cursor from the insertion
2257 point.
2258 *cpo-%*
2259 % Vi-compatible matching is done for the "%" command.
2260 Does not recognize "#if", "#endif", etc.
2261 Does not recognize "/*" and "*/".
2262 Parens inside single and double quotes are also
2263 counted, causing a string that contains a paren to
2264 disturb the matching. For example, in a line like
2265 "if (strcmp("foo(", s))" the first paren does not
2266 match the last one. When this flag is not included,
2267 parens inside single and double quotes are treated
2268 specially. When matching a paren outside of quotes,
2269 everything inside quotes is ignored. When matching a
2270 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002271 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002272 This flag is also used for other features, such as
2273 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002274 *cpo--*
2275 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002276 it would go above the first line or below the last
2277 line. Without it the cursor moves to the first or
2278 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002279 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002280 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002281 *cpo-+*
2282 + When included, a ":write file" command will reset the
2283 'modified' flag of the buffer, even though the buffer
2284 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002285 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 * Use ":*" in the same way as ":@". When not included,
2287 ":*" is an alias for ":'<,'>", select the Visual area.
2288 *cpo-<*
2289 < Disable the recognition of special key codes in |<>|
2290 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002291 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 ":map X <Tab>" results in X being mapped to:
2293 '<' included: "<Tab>" (5 characters)
2294 '<' excluded: "^I" (^I is a real <Tab>)
2295 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296 *cpo->*
2297 > When appending to a register, put a line break before
2298 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002299 *cpo-;*
2300 ; When using |,| or |;| to repeat the last |t| search
2301 and the cursor is right in front of the searched
2302 character, the cursor won't move. When not included,
2303 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002304 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305
2306 POSIX flags. These are not included in the Vi default value, except
2307 when $VIM_POSIX was set on startup. |posix|
2308
2309 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002310 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002311 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002312 *cpo-&*
2313 & When ":preserve" was used keep the swap file when
2314 exiting normally while this buffer is still loaded.
2315 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002316 *cpo-\*
2317 \ Backslash in a [] range in a search pattern is taken
2318 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002319 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2320 '\' excluded: "/[ \-]" finds <Space> and '-'
2321 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002322 *cpo-/*
2323 / When "%" is used as the replacement string in a |:s|
2324 command, use the previous replacement string. |:s%|
2325 *cpo-{*
2326 { The |{| and |}| commands also stop at a "{" character
2327 at the start of a line.
2328 *cpo-.*
2329 . The ":chdir" and ":cd" commands fail if the current
2330 buffer is modified, unless ! is used. Vim doesn't
2331 need this, since it remembers the full path of an
2332 opened file.
2333 *cpo-bar*
2334 | The value of the $LINES and $COLUMNS environment
2335 variables overrule the terminal size values obtained
2336 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002337
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002339 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002340'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002341 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002342 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002343 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002344 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002345 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002346 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002347 blowfish Blowfish method. Medium strong encryption but it has
2348 an implementation flaw. Requires Vim 7.3 or later,
2349 files can NOT be read by Vim 7.2 and older. This adds
2350 a "seed" to the file, every time you write the file
2351 the encrypted bytes will be different.
2352 *blowfish2*
2353 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002354 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002355 and older. This adds a "seed" to the file, every time
2356 you write the file the encrypted bytes will be
2357 different. The whole undo file is encrypted, not just
2358 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002359
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002360 You should use "blowfish2", also to re-encrypt older files.
2361
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002362 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002363 to the detected method of the file being read. Thus if you write it
2364 without changing 'cryptmethod' the same method will be used.
2365 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002366 explicitly write it, you don't get a warning unless there are other
2367 modifications. Also see |:X|.
2368
2369 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002370 the value "blowfish2". When setting the local value to an empty
2371 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373 When a new encryption method is added in a later version of Vim, and
2374 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002375 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002376
2377
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 *'cscopepathcomp'* *'cspc'*
2379'cscopepathcomp' 'cspc' number (default 0)
2380 global
2381 {not available when compiled without the |+cscope|
2382 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 Determines how many components of the path to show in a list of tags.
2384 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002385 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386
2387 *'cscopeprg'* *'csprg'*
2388'cscopeprg' 'csprg' string (default "cscope")
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 Specifies the command to execute cscope. See |cscopeprg|.
2393 This option cannot be set from a |modeline| or in the |sandbox|, for
2394 security reasons.
2395
2396 *'cscopequickfix'* *'csqf'*
2397'cscopequickfix' 'csqf' string (default "")
2398 global
2399 {not available when compiled without the |+cscope|
2400 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 Specifies whether to use quickfix window to show cscope results.
2402 See |cscopequickfix|.
2403
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002404 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002405'cscoperelative' 'csre' boolean (default off)
2406 global
2407 {not available when compiled without the |+cscope|
2408 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002409 In the absence of a prefix (-P) for cscope. setting this option enables
2410 to use the basename of cscope.out path as the prefix.
2411 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002412 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002413
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2415'cscopetag' 'cst' boolean (default off)
2416 global
2417 {not available when compiled without the |+cscope|
2418 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 Use cscope for tag commands. See |cscope-options|.
2420 NOTE: This option is reset when 'compatible' is set.
2421
2422 *'cscopetagorder'* *'csto'*
2423'cscopetagorder' 'csto' number (default 0)
2424 global
2425 {not available when compiled without the |+cscope|
2426 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 Determines the order in which ":cstag" performs a search. See
2428 |cscopetagorder|.
2429 NOTE: This option is set to 0 when 'compatible' is set.
2430
2431 *'cscopeverbose'* *'csverb'*
2432 *'nocscopeverbose'* *'nocsverb'*
2433'cscopeverbose' 'csverb' boolean (default off)
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 Give messages when adding a cscope database. See |cscopeverbose|.
2438 NOTE: This option is reset when 'compatible' is set.
2439
Bram Moolenaar860cae12010-06-05 23:22:07 +02002440 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2441'cursorbind' 'crb' boolean (default off)
2442 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002443 When this option is set, as the cursor in the current
2444 window moves other cursorbound windows (windows that also have
2445 this option set) move their cursors to the corresponding line and
2446 column. This option is useful for viewing the
2447 differences between two versions of a file (see 'diff'); in diff mode,
2448 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002449 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002450
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002451
2452 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2453'cursorcolumn' 'cuc' boolean (default off)
2454 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002455 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002456 feature}
2457 Highlight the screen column of the cursor with CursorColumn
2458 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2459 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002460 If you only want the highlighting in the current window you can use
2461 these autocommands: >
2462 au WinLeave * set nocursorline nocursorcolumn
2463 au WinEnter * set cursorline cursorcolumn
2464<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002465
2466 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2467'cursorline' 'cul' boolean (default off)
2468 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002469 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002471 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2472 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002473 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002474 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475
2476
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002477 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002478'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002479 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002480 {not available when compiled without the |+syntax|
2481 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002482 Comma separated list of settings for how 'cursorline' is displayed.
2483 Valid values:
2484 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002486 "screenline" Highlight only the screen line of the cursor with
2487 CursorLine |hl-CursorLine|.
2488 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002489 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002490
2491 Special value:
2492 "both" Alias for the values "line,number".
2493
2494 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002495
2496
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 *'debug'*
2498'debug' string (default "")
2499 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002500 These values can be used:
2501 msg Error messages that would otherwise be omitted will be given
2502 anyway.
2503 throw Error messages that would otherwise be omitted will be given
2504 anyway and also throw an exception and set |v:errmsg|.
2505 beep A message will be given when otherwise only a beep would be
2506 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002507 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002508 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2509 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510
2511 *'define'* *'def'*
2512'define' 'def' string (default "^\s*#\s*define")
2513 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002514 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 pattern, just like for the "/" command. This option is used for the
2516 commands like "[i" and "[d" |include-search|. The 'isident' option is
2517 used to recognize the defined name after the match:
2518 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2519 See |option-backslash| about inserting backslashes to include a space
2520 or backslash.
2521 The default value is for C programs. For C++ this value would be
2522 useful, to include const type declarations: >
2523 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002524< You can also use "\ze" just before the name and continue the pattern
2525 to check what is following. E.g. for Javascript, if a function is
2526 defined with "func_name = function(args)": >
2527 ^\s*\ze\i\+\s*=\s*function(
2528< If the function is defined with "func_name : function() {...": >
2529 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002531 To avoid that use `:let` with a single quote string: >
2532 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002533<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534
2535 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2536'delcombine' 'deco' boolean (default off)
2537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 If editing Unicode and this option is set, backspace and Normal mode
2539 "x" delete each combining character on its own. When it is off (the
2540 default) the character along with its combining characters are
2541 deleted.
2542 Note: When 'delcombine' is set "xx" may work different from "2x"!
2543
2544 This is useful for Arabic, Hebrew and many other languages where one
2545 may have combining characters overtop of base characters, and want
2546 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002547 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548
2549 *'dictionary'* *'dict'*
2550'dictionary' 'dict' string (default "")
2551 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 List of file names, separated by commas, that are used to lookup words
2553 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2554 contain a list of words. This can be one word per line, or several
2555 words per line, separated by non-keyword characters (white space is
2556 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002557
2558 When this option is empty or an entry "spell" is present, and spell
2559 checking is enabled, words in the word lists for the currently active
2560 'spelllang' are used. See |spell|.
2561
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 after a comma are ignored, otherwise spaces are included in the file
2564 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002565 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 Where to find a list of words?
2567 - On FreeBSD, there is the file "/usr/share/dict/words".
2568 - In the Simtel archive, look in the "msdos/linguist" directory.
2569 - In "miscfiles" of the GNU collection.
2570 The use of |:set+=| and |:set-=| is preferred when adding or removing
2571 directories from the list. This avoids problems when a future version
2572 uses another default.
2573 Backticks cannot be used in this option for security reasons.
2574
2575 *'diff'* *'nodiff'*
2576'diff' boolean (default off)
2577 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 {not available when compiled without the |+diff|
2579 feature}
2580 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002581 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582
2583 *'dex'* *'diffexpr'*
2584'diffexpr' 'dex' string (default "")
2585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 {not available when compiled without the |+diff|
2587 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002588 Expression which is evaluated to obtain a diff file (either ed-style
2589 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 This option cannot be set from a |modeline| or in the |sandbox|, for
2591 security reasons.
2592
2593 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002594'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 {not available when compiled without the |+diff|
2597 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002598 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 All are optional. Items must be separated by a comma.
2600
2601 filler Show filler lines, to keep the text
2602 synchronized with a window that has inserted
2603 lines at the same position. Mostly useful
2604 when windows are side-by-side and 'scrollbind'
2605 is set.
2606
2607 context:{n} Use a context of {n} lines between a change
2608 and a fold that contains unchanged lines.
2609 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002610 When using zero the context is actually one,
2611 since folds require a line in between, also
2612 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 See |fold-diff|.
2614
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002615 iblank Ignore changes where lines are all blank. Adds
2616 the "-B" flag to the "diff" command if
2617 'diffexpr' is empty. Check the documentation
2618 of the "diff" command for what this does
2619 exactly.
2620 NOTE: the diff windows will get out of sync,
2621 because no differences between blank lines are
2622 taken into account.
2623
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 icase Ignore changes in case of text. "a" and "A"
2625 are considered the same. Adds the "-i" flag
2626 to the "diff" command if 'diffexpr' is empty.
2627
2628 iwhite Ignore changes in amount of white space. Adds
2629 the "-b" flag to the "diff" command if
2630 'diffexpr' is empty. Check the documentation
2631 of the "diff" command for what this does
2632 exactly. It should ignore adding trailing
2633 white space, but not leading white space.
2634
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002635 iwhiteall Ignore all white space changes. Adds
2636 the "-w" flag to the "diff" command if
2637 'diffexpr' is empty. Check the documentation
2638 of the "diff" command for what this does
2639 exactly.
2640
2641 iwhiteeol Ignore white space changes at end of line.
2642 Adds the "-Z" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly.
2646
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002647 horizontal Start diff mode with horizontal splits (unless
2648 explicitly specified otherwise).
2649
2650 vertical Start diff mode with vertical splits (unless
2651 explicitly specified otherwise).
2652
Bram Moolenaarc8234772019-11-10 21:00:27 +01002653 closeoff When a window is closed where 'diff' is set
2654 and there is only one window remaining in the
2655 same tab page with 'diff' set, execute
2656 `:diffoff` in that window. This undoes a
2657 `:diffsplit` command.
2658
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002659 hiddenoff Do not use diff mode for a buffer when it
2660 becomes hidden.
2661
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002662 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2663 starting diff mode. Without this 2 is used.
2664
Bram Moolenaare828b762018-09-10 17:51:58 +02002665 internal Use the internal diff library. This is
2666 ignored when 'diffexpr' is set. *E960*
2667 When running out of memory when writing a
2668 buffer this item will be ignored for diffs
2669 involving that buffer. Set the 'verbose'
2670 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671
Bram Moolenaare828b762018-09-10 17:51:58 +02002672 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002673 Use the indent heuristic for the internal
2674 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002675
2676 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002677 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002678 algorithms are:
2679 myers the default algorithm
2680 minimal spend extra time to generate the
2681 smallest possible diff
2682 patience patience diff algorithm
2683 histogram histogram diff algorithm
2684
2685 Examples: >
2686 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002687 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002688 :set diffopt=internal,filler,foldcolumn:3
2689 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002690<
2691 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2692'digraph' 'dg' boolean (default off)
2693 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002694 {not available when compiled without the |+digraphs|
2695 feature}
2696 Enable the entering of digraphs in Insert mode with {char1} <BS>
2697 {char2}. See |digraphs|.
2698 NOTE: This option is reset when 'compatible' is set.
2699
2700 *'directory'* *'dir'*
2701'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002702 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002703 for Unix: ".,~/tmp,/var/tmp,/tmp")
2704 global
2705 List of directory names for the swap file, separated with commas.
2706 - The swap file will be created in the first directory where this is
2707 possible.
2708 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002709 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002710 - A directory "." means to put the swap file in the same directory as
2711 the edited file. On Unix, a dot is prepended to the file name, so
2712 it doesn't show in a directory listing. On MS-Windows the "hidden"
2713 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002714 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 put the swap file relative to where the edited file is. The leading
2716 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002717 - For Unix and Win32, if a directory ends in two path separators "//",
2718 the swap file name will be built from the complete path to the file
2719 with all path separators substituted to percent '%' signs. This will
2720 ensure file name uniqueness in the preserve directory.
2721 On Win32, it is also possible to end with "\\". However, When a
2722 separating comma is following, you must use "//", since "\\" will
2723 include the comma in the file name. Therefore it is recommended to
2724 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002725 - Spaces after the comma are ignored, other spaces are considered part
2726 of the directory name. To have a space at the start of a directory
2727 name, precede it with a backslash.
2728 - To include a comma in a directory name precede it with a backslash.
2729 - A directory name may end in an ':' or '/'.
2730 - Environment variables are expanded |:set_env|.
2731 - Careful with '\' characters, type one before a space, type two to
2732 get one in the option (see |option-backslash|), for example: >
2733 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2734< - For backwards compatibility with Vim version 3.0 a '>' at the start
2735 of the option is removed.
2736 Using "." first in the list is recommended. This means that editing
2737 the same file twice will result in a warning. Using "/tmp" on Unix is
2738 discouraged: When the system crashes you lose the swap file.
2739 "/var/tmp" is often not cleared when rebooting, thus is a better
2740 choice than "/tmp". But it can contain a lot of files, your swap
2741 files get lost in the crowd. That is why a "tmp" directory in your
2742 home directory is tried first.
2743 The use of |:set+=| and |:set-=| is preferred when adding or removing
2744 directories from the list. This avoids problems when a future version
2745 uses another default.
2746 This option cannot be set from a |modeline| or in the |sandbox|, for
2747 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748
2749 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002750'display' 'dy' string (default "", set to "truncate" in
2751 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002752 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 Change the way text is displayed. This is comma separated list of
2754 flags:
2755 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002756 in a window will be displayed. "@@@" is put in the
2757 last columns of the last screen line to indicate the
2758 rest of the line is not displayed.
2759 truncate Like "lastline", but "@@@" is displayed in the first
2760 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 uhex Show unprintable characters hexadecimal as <xx>
2762 instead of using ^C and ~C.
2763
Bram Moolenaard0796902016-09-16 20:02:31 +02002764 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002765 doesn't fit is replaced with "@" lines.
2766
Bram Moolenaar071d4272004-06-13 20:20:40 +00002767 *'eadirection'* *'ead'*
2768'eadirection' 'ead' string (default "both")
2769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 Tells when the 'equalalways' option applies:
2771 ver vertically, width of windows is not affected
2772 hor horizontally, height of windows is not affected
2773 both width and height of windows is affected
2774
2775 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2776'edcompatible' 'ed' boolean (default off)
2777 global
2778 Makes the 'g' and 'c' flags of the ":substitute" command to be
2779 toggled each time the flag is given. See |complex-change|. See
2780 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002781 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782
Bram Moolenaar03413f42016-04-12 21:07:15 +02002783 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002784'emoji' 'emo' boolean (default: on)
2785 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002786 When on all Unicode emoji characters are considered to be full width.
2787
2788
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 *'encoding'* *'enc'* *E543*
2790'encoding' 'enc' string (default: "latin1" or value from $LANG)
2791 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002792 Sets the character encoding used inside Vim. It applies to text in
2793 the buffers, registers, Strings in expressions, text stored in the
2794 viminfo file, etc. It sets the kind of characters which Vim can work
2795 with. See |encoding-names| for the possible values.
2796
2797 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002798 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002799 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002800 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801
Bram Moolenaar865242e2010-07-14 21:12:05 +02002802 This option cannot be set from a |modeline|. It would most likely
2803 corrupt the text.
2804
Bram Moolenaar3df01732017-02-17 22:47:16 +01002805 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2806 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002807 'encoding', "utf-8" is the natural choice for the environment and
2808 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002809 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002810 versions, and to avoid changing the encoding of newly created files
2811 without your knowledge (in case 'fileencodings' is empty).
2812
2813 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002814 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 iconv() or as specified with 'charconvert'.
2816
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002817 If you need to know whether 'encoding' is a multi-byte encoding, you
2818 can use: >
2819 if has("multi_byte_encoding")
2820<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002821 Normally 'encoding' will be equal to your current locale. This will
2822 be the default if Vim recognizes your environment settings. If
2823 'encoding' is not set to the current locale, 'termencoding' must be
2824 set to convert typed and displayed text. See |encoding-table|.
2825
2826 When you set this option, it fires the |EncodingChanged| autocommand
2827 event so that you can set up fonts if necessary.
2828
2829 When the option is set, the value is converted to lowercase. Thus
2830 you can set it with uppercase values too. Underscores are translated
2831 to '-' signs.
2832 When the encoding is recognized, it is changed to the standard name.
2833 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2834 "iso-8859-2" and "utf8" becomes "utf-8".
2835
2836 Note: "latin1" is also used when the encoding could not be detected.
2837 This only works when editing files in the same encoding! When the
2838 actual character set is not latin1, make sure 'fileencoding' and
2839 'fileencodings' are empty. When conversion is needed, switch to using
2840 utf-8.
2841
2842 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2843 You don't notice this while editing, but it does matter for the
2844 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2845 setting 'encoding' to one of these values instead of utf-8 only has
2846 effect for encoding used for files when 'fileencoding' is empty.
2847
Bram Moolenaar661b1822005-07-28 22:36:45 +00002848 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2849 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850
2851 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2852'endofline' 'eol' boolean (default on)
2853 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002854 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002855 is on, or 'fixeol' option is off, no <EOL> will be written for the
2856 last line in the file. This option is automatically set or reset when
2857 starting to edit a new file, depending on whether file has an <EOL>
2858 for the last line in the file. Normally you don't have to set or
2859 reset this option.
2860 When 'binary' is off and 'fixeol' is on the value is not used when
2861 writing the file. When 'binary' is on or 'fixeol' is off it is used
2862 to remember the presence of a <EOL> for the last line in the file, so
2863 that when you write the file the situation from the original file can
2864 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865
2866 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2867'equalalways' 'ea' boolean (default on)
2868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002870 splitting or closing a window. This also happens the moment the
2871 option is switched on. When off, splitting a window will reduce the
2872 size of the current window and leave the other windows the same. When
2873 closing a window the extra lines are given to the window next to it
2874 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002875 When mixing vertically and horizontally split windows, a minimal size
2876 is computed and some windows may be larger if there is room. The
2877 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002878 Changing the height and width of a window can be avoided by setting
2879 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002880 If a window size is specified when creating a new window sizes are
2881 currently not equalized (it's complicated, but may be implemented in
2882 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002883
2884 *'equalprg'* *'ep'*
2885'equalprg' 'ep' string (default "")
2886 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002887 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002888 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002889 or 'indentexpr'. When Vim was compiled without internal formatting,
2890 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002891 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002892 about including spaces and backslashes.
2893 This option cannot be set from a |modeline| or in the |sandbox|, for
2894 security reasons.
2895
2896 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2897'errorbells' 'eb' boolean (default off)
2898 global
2899 Ring the bell (beep or screen flash) for error messages. This only
2900 makes a difference for error messages, the bell will be used always
2901 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002902 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002903 screen flash or do nothing. See 'belloff' to finetune when to ring the
2904 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905
2906 *'errorfile'* *'ef'*
2907'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2908 others: "errors.err")
2909 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002910 {not available when compiled without the |+quickfix|
2911 feature}
2912 Name of the errorfile for the QuickFix mode (see |:cf|).
2913 When the "-q" command-line argument is used, 'errorfile' is set to the
2914 following argument. See |-q|.
2915 NOT used for the ":make" command. See 'makeef' for that.
2916 Environment variables are expanded |:set_env|.
2917 See |option-backslash| about including spaces and backslashes.
2918 This option cannot be set from a |modeline| or in the |sandbox|, for
2919 security reasons.
2920
2921 *'errorformat'* *'efm'*
2922'errorformat' 'efm' string (default is very long)
2923 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002924 {not available when compiled without the |+quickfix|
2925 feature}
2926 Scanf-like description of the format for the lines in the error file
2927 (see |errorformat|).
2928
2929 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2930'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2931 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002932 Function keys that start with an <Esc> are recognized in Insert
2933 mode. When this option is off, the cursor and function keys cannot be
2934 used in Insert mode if they start with an <Esc>. The advantage of
2935 this is that the single <Esc> is recognized immediately, instead of
2936 after one second. Instead of resetting this option, you might want to
2937 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2938 when 'esckeys' is off, you can still map anything, but the cursor keys
2939 won't work by default.
2940 NOTE: This option is set to the Vi default value when 'compatible' is
2941 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002942 NOTE: when this option is off then the |modifyOtherKeys| functionality
2943 is disabled while in Insert mode to avoid ending Insert mode with any
2944 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945
2946 *'eventignore'* *'ei'*
2947'eventignore' 'ei' string (default "")
2948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002950 When set to "all" or when "all" is one of the items, all autocommand
2951 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002952 Otherwise this is a comma separated list of event names. Example: >
2953 :set ei=WinEnter,WinLeave
2954<
2955 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2956'expandtab' 'et' boolean (default off)
2957 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002958 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002959 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2961 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002962 This option is reset when the 'paste' option is set and restored when
2963 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002964 NOTE: This option is reset when 'compatible' is set.
2965
2966 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2967'exrc' 'ex' boolean (default off)
2968 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002970 directory.
2971
2972 Setting this option is a potential security leak. E.g., consider
2973 unpacking a package or fetching files from github, a .vimrc in there
2974 might be a trojan horse. BETTER NOT SET THIS OPTION!
2975 Instead, define an autocommand in your .vimrc to set options for a
2976 matching directory.
2977
2978 If you do switch this option on you should also consider setting the
2979 'secure' option (see |initialization|).
2980 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002981 This option cannot be set from a |modeline| or in the |sandbox|, for
2982 security reasons.
2983
2984 *'fileencoding'* *'fenc'* *E213*
2985'fileencoding' 'fenc' string (default: "")
2986 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002987 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002988
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002990 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 When 'fileencoding' is empty, the same value as 'encoding' will be
2992 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002993 No error will be given when the value is set, only when it is used,
2994 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002995 Conversion will also be done when 'encoding' and 'fileencoding' are
2996 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2997 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002998 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002999 'encoding' is "utf-8" or another Unicode encoding, conversion
3000 is most likely done in a way that the reverse conversion
3001 results in the same text. When 'encoding' is not "utf-8" some
3002 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003003
Bram Moolenaar071d4272004-06-13 20:20:40 +00003004 See 'encoding' for the possible values. Additionally, values may be
3005 specified that can be handled by the converter, see
3006 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003007
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 When reading a file 'fileencoding' will be set from 'fileencodings'.
3009 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003010 'fileencoding', use the |++enc| argument. One exception: when
3011 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003012 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003013
Bram Moolenaar071d4272004-06-13 20:20:40 +00003014 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3015 When the option is set, the value is converted to lowercase. Thus
3016 you can set it with uppercase values too. '_' characters are
3017 replaced with '-'. If a name is recognized from the list for
3018 'encoding', it is replaced by the standard name. For example
3019 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003020
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 When this option is set, after starting to edit a file, the 'modified'
3022 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003023
3024 Keep in mind that changing 'fenc' from a modeline happens
3025 AFTER the text has been read, thus it applies to when the file will be
3026 written. If you do set 'fenc' in a modeline, you might want to set
3027 'nomodified' to avoid not being able to ":q".
3028
Bram Moolenaar071d4272004-06-13 20:20:40 +00003029 This option can not be changed when 'modifiable' is off.
3030
3031 *'fe'*
3032 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003033 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003034 old short name was 'fe', which is no longer used.
3035
3036 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003037'fileencodings' 'fencs' string (default: "ucs-bom",
3038 "ucs-bom,utf-8,default,latin1" when
3039 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003040 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 This is a list of character encodings considered when starting to edit
3042 an existing file. When a file is read, Vim tries to use the first
3043 mentioned character encoding. If an error is detected, the next one
3044 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003045 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003046 an empty string, which means the value of 'encoding' is used.
3047 WARNING: Conversion can cause loss of information! When
3048 'encoding' is "utf-8" (or one of the other Unicode variants)
3049 conversion is most likely done in a way that the reverse
3050 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003051 "utf-8" some non-ASCII characters may be lost! You can use
3052 the |++bad| argument to specify what is done with characters
3053 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003054 For an empty file or a file with only ASCII characters most encodings
3055 will work and the first entry of 'fileencodings' will be used (except
3056 "ucs-bom", which requires the BOM to be present). If you prefer
3057 another encoding use an BufReadPost autocommand event to test if your
3058 preferred encoding is to be used. Example: >
3059 au BufReadPost * if search('\S', 'w') == 0 |
3060 \ set fenc=iso-2022-jp | endif
3061< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3062 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003063 When the |++enc| argument is used then the value of 'fileencodings' is
3064 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003065 Note that 'fileencodings' is not used for a new file, the global value
3066 of 'fileencoding' is used instead. You can set it with: >
3067 :setglobal fenc=iso-8859-2
3068< This means that a non-existing file may get a different encoding than
3069 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 The special value "ucs-bom" can be used to check for a Unicode BOM
3071 (Byte Order Mark) at the start of the file. It must not be preceded
3072 by "utf-8" or another Unicode encoding for this to work properly.
3073 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3074 because Vim cannot detect an error, thus the encoding is always
3075 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003076 The special value "default" can be used for the encoding from the
3077 environment. This is the default value for 'encoding'. It is useful
3078 when 'encoding' is set to "utf-8" and your environment uses a
3079 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003080 When 'encoding' is "utf-8" and a file contains an illegal byte
3081 sequence it won't be recognized as UTF-8. You can use the |8g8|
3082 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 WRONG VALUES: WHAT'S WRONG:
3084 latin1,utf-8 "latin1" will always be used
3085 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3086 file
3087 cp1250,latin1 "cp1250" will always be used
3088 If 'fileencodings' is empty, 'fileencoding' is not modified.
3089 See 'fileencoding' for the possible values.
3090 Setting this option does not have an effect until the next time a file
3091 is read.
3092
3093 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003094'fileformat' 'ff' string (MS-Windows default: "dos",
3095 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003096 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 This gives the <EOL> of the current buffer, which is used for
3098 reading/writing the buffer from/to a file:
3099 dos <CR> <NL>
3100 unix <NL>
3101 mac <CR>
3102 When "dos" is used, CTRL-Z at the end of a file is ignored.
3103 See |file-formats| and |file-read|.
3104 For the character encoding of the file see 'fileencoding'.
3105 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003106 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 This option is set automatically when starting to edit a file and
3108 'fileformats' is not empty and 'binary' is off.
3109 When this option is set, after starting to edit a file, the 'modified'
3110 option is set, because the file would be different when written.
3111 This option can not be changed when 'modifiable' is off.
3112 For backwards compatibility: When this option is set to "dos",
3113 'textmode' is set, otherwise 'textmode' is reset.
3114
3115 *'fileformats'* *'ffs'*
3116'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003117 Vim+Vi MS-Windows: "dos,unix",
3118 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003119 Vi Cygwin: "unix,dos",
3120 Vi others: "")
3121 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003122 This gives the end-of-line (<EOL>) formats that will be tried when
3123 starting to edit a new buffer and when reading a file into an existing
3124 buffer:
3125 - When empty, the format defined with 'fileformat' will be used
3126 always. It is not set automatically.
3127 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003128 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 'fileformats' name will be used when a file is read into an existing
3130 buffer, no matter what 'fileformat' for that buffer is set to.
3131 - When more than one name is present, separated by commas, automatic
3132 <EOL> detection will be done when reading a file. When starting to
3133 edit a file, a check is done for the <EOL>:
3134 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3135 'fileformat' is set to "dos".
3136 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003137 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003139 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3140 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003141 This means that "mac" is only chosen when:
3142 "unix" is not present or no <NL> is found in the file, and
3143 "dos" is not present or no <CR><NL> is found in the file.
3144 Except: if "unix" was chosen, but there is a <CR> before
3145 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003146 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003147 4. If 'fileformat' is still not set, the first name from
3148 'fileformats' is used.
3149 When reading a file into an existing buffer, the same is done, but
3150 this happens like 'fileformat' has been set appropriately for that
3151 file only, the option is not changed.
3152 When 'binary' is set, the value of 'fileformats' is not used.
3153
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003154 When Vim starts up with an empty buffer the first item is used. You
3155 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003156
Bram Moolenaar071d4272004-06-13 20:20:40 +00003157 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3158 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3159 done:
3160 - When 'fileformats' is empty, there is no automatic detection. Dos
3161 format will be used.
3162 - When 'fileformats' is set to one or more names, automatic detection
3163 is done. This is based on the first <NL> in the file: If there is a
3164 <CR> in front of it, Dos format is used, otherwise Unix format is
3165 used.
3166 Also see |file-formats|.
3167 For backwards compatibility: When this option is set to an empty
3168 string or one format (no comma is included), 'textauto' is reset,
3169 otherwise 'textauto' is set.
3170 NOTE: This option is set to the Vi default value when 'compatible' is
3171 set and to the Vim default value when 'compatible' is reset.
3172
Bram Moolenaarbf884932013-04-05 22:26:15 +02003173 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3174'fileignorecase' 'fic' boolean (default on for systems where case in file
3175 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003176 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003177 When set case is ignored when using file names and directories.
3178 See 'wildignorecase' for only ignoring case when doing completion.
3179
Bram Moolenaar071d4272004-06-13 20:20:40 +00003180 *'filetype'* *'ft'*
3181'filetype' 'ft' string (default: "")
3182 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003183 When this option is set, the FileType autocommand event is triggered.
3184 All autocommands that match with the value of this option will be
3185 executed. Thus the value of 'filetype' is used in place of the file
3186 name.
3187 Otherwise this option does not always reflect the current file type.
3188 This option is normally set when the file type is detected. To enable
3189 this use the ":filetype on" command. |:filetype|
3190 Setting this option to a different value is most useful in a modeline,
3191 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003192 Example, for in an IDL file:
3193 /* vim: set filetype=idl : */ ~
3194 |FileType| |filetypes|
3195 When a dot appears in the value then this separates two filetype
3196 names. Example:
3197 /* vim: set filetype=c.doxygen : */ ~
3198 This will use the "c" filetype first, then the "doxygen" filetype.
3199 This works both for filetype plugins and for syntax files. More than
3200 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 This option is not copied to another buffer, independent of the 's' or
3202 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003203 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204
3205 *'fillchars'* *'fcs'*
3206'fillchars' 'fcs' string (default "vert:|,fold:-")
3207 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003208 {not available when compiled without the |+folding|
3209 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003210 Characters to fill the statuslines and vertical separators.
3211 It is a comma separated list of items:
3212
3213 item default Used for ~
3214 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003215 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003216 vert:c '|' vertical separators |:vsplit|
3217 fold:c '-' filling 'foldtext'
3218 diff:c '-' deleted lines of the 'diff' option
3219
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003220 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003221 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 otherwise.
3223
3224 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003225 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003226< This is similar to the default, except that these characters will also
3227 be used when there is highlighting.
3228
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003229 for "stl" and "stlnc" only single-byte values are supported.
3230
Bram Moolenaar071d4272004-06-13 20:20:40 +00003231 The highlighting used for these items:
3232 item highlight group ~
3233 stl:c StatusLine |hl-StatusLine|
3234 stlnc:c StatusLineNC |hl-StatusLineNC|
3235 vert:c VertSplit |hl-VertSplit|
3236 fold:c Folded |hl-Folded|
3237 diff:c DiffDelete |hl-DiffDelete|
3238
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003239 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3240'fixendofline' 'fixeol' boolean (default on)
3241 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003242 When writing a file and this option is on, <EOL> at the end of file
3243 will be restored if missing. Turn this option off if you want to
3244 preserve the situation from the original file.
3245 When the 'binary' option is set the value of this option doesn't
3246 matter.
3247 See the 'endofline' option.
3248
Bram Moolenaar071d4272004-06-13 20:20:40 +00003249 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3250'fkmap' 'fk' boolean (default off) *E198*
3251 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003252 {only available when compiled with the |+rightleft|
3253 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003254 This option was for using Farsi, which has been removed. See
3255 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256
3257 *'foldclose'* *'fcl'*
3258'foldclose' 'fcl' string (default "")
3259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 {not available when compiled without the |+folding|
3261 feature}
3262 When set to "all", a fold is closed when the cursor isn't in it and
3263 its level is higher than 'foldlevel'. Useful if you want folds to
3264 automatically close when moving out of them.
3265
3266 *'foldcolumn'* *'fdc'*
3267'foldcolumn' 'fdc' number (default 0)
3268 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003269 {not available when compiled without the |+folding|
3270 feature}
3271 When non-zero, a column with the specified width is shown at the side
3272 of the window which indicates open and closed folds. The maximum
3273 value is 12.
3274 See |folding|.
3275
3276 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3277'foldenable' 'fen' boolean (default on)
3278 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 {not available when compiled without the |+folding|
3280 feature}
3281 When off, all folds are open. This option can be used to quickly
3282 switch between showing all text unfolded and viewing the text with
3283 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003284 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 'foldenable' is off.
3286 This option is set by commands that create a new fold or close a fold.
3287 See |folding|.
3288
3289 *'foldexpr'* *'fde'*
3290'foldexpr' 'fde' string (default: "0")
3291 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003292 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003293 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003294 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003295 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003296
Bram Moolenaar30b65812012-07-12 22:01:11 +02003297 The expression will be evaluated in the |sandbox| if set from a
3298 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003299 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003300 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003301
3302 It is not allowed to change text or jump to another window while
3303 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304
3305 *'foldignore'* *'fdi'*
3306'foldignore' 'fdi' string (default: "#")
3307 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003308 {not available when compiled without the |+folding|
3309 feature}
3310 Used only when 'foldmethod' is "indent". Lines starting with
3311 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003312 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003313 The default "#" works well for C programs. See |fold-indent|.
3314
3315 *'foldlevel'* *'fdl'*
3316'foldlevel' 'fdl' number (default: 0)
3317 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003318 {not available when compiled without the |+folding|
3319 feature}
3320 Sets the fold level: Folds with a higher level will be closed.
3321 Setting this option to zero will close all folds. Higher numbers will
3322 close fewer folds.
3323 This option is set by commands like |zm|, |zM| and |zR|.
3324 See |fold-foldlevel|.
3325
3326 *'foldlevelstart'* *'fdls'*
3327'foldlevelstart' 'fdls' number (default: -1)
3328 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003329 {not available when compiled without the |+folding|
3330 feature}
3331 Sets 'foldlevel' when starting to edit another buffer in a window.
3332 Useful to always start editing with all folds closed (value zero),
3333 some folds closed (one) or no folds closed (99).
3334 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003335 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003336 ignores this option and closes all folds.
3337 It is also done before BufReadPre autocommands, to allow an autocmd to
3338 overrule the 'foldlevel' value for specific files.
3339 When the value is negative, it is not used.
3340
3341 *'foldmarker'* *'fmr'* *E536*
3342'foldmarker' 'fmr' string (default: "{{{,}}}")
3343 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003344 {not available when compiled without the |+folding|
3345 feature}
3346 The start and end marker used when 'foldmethod' is "marker". There
3347 must be one comma, which separates the start and end marker. The
3348 marker is a literal string (a regular expression would be too slow).
3349 See |fold-marker|.
3350
3351 *'foldmethod'* *'fdm'*
3352'foldmethod' 'fdm' string (default: "manual")
3353 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 {not available when compiled without the |+folding|
3355 feature}
3356 The kind of folding used for the current window. Possible values:
3357 |fold-manual| manual Folds are created manually.
3358 |fold-indent| indent Lines with equal indent form a fold.
3359 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3360 |fold-marker| marker Markers are used to specify folds.
3361 |fold-syntax| syntax Syntax highlighting items specify folds.
3362 |fold-diff| diff Fold text that is not changed.
3363
3364 *'foldminlines'* *'fml'*
3365'foldminlines' 'fml' number (default: 1)
3366 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 {not available when compiled without the |+folding|
3368 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003369 Sets the number of screen lines above which a fold can be displayed
3370 closed. Also for manually closed folds. With the default value of
3371 one a fold can only be closed if it takes up two or more screen lines.
3372 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003373 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003374 "zc" to close a fold, which is displayed open because it's smaller
3375 than 'foldminlines', a following "zc" may close a containing fold.
3376
3377 *'foldnestmax'* *'fdn'*
3378'foldnestmax' 'fdn' number (default: 20)
3379 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003380 {not available when compiled without the |+folding|
3381 feature}
3382 Sets the maximum nesting of folds for the "indent" and "syntax"
3383 methods. This avoids that too many folds will be created. Using more
3384 than 20 doesn't work, because the internal limit is 20.
3385
3386 *'foldopen'* *'fdo'*
3387'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3388 search,tag,undo")
3389 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 {not available when compiled without the |+folding|
3391 feature}
3392 Specifies for which type of commands folds will be opened, if the
3393 command moves the cursor into a closed fold. It is a comma separated
3394 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003395 NOTE: When the command is part of a mapping this option is not used.
3396 Add the |zv| command to the mapping to get the same effect.
3397 (rationale: the mapping may want to control opening folds itself)
3398
Bram Moolenaar071d4272004-06-13 20:20:40 +00003399 item commands ~
3400 all any
3401 block "(", "{", "[[", "[{", etc.
3402 hor horizontal movements: "l", "w", "fx", etc.
3403 insert any command in Insert mode
3404 jump far jumps: "G", "gg", etc.
3405 mark jumping to a mark: "'m", CTRL-O, etc.
3406 percent "%"
3407 quickfix ":cn", ":crew", ":make", etc.
3408 search search for a pattern: "/", "n", "*", "gd", etc.
3409 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003410 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003411 tag jumping to a tag: ":ta", CTRL-T, etc.
3412 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 When a movement command is used for an operator (e.g., "dl" or "y%")
3414 this option is not used. This means the operator will include the
3415 whole closed fold.
3416 Note that vertical movements are not here, because it would make it
3417 very difficult to move onto a closed fold.
3418 In insert mode the folds containing the cursor will always be open
3419 when text is inserted.
3420 To close folds you can re-apply 'foldlevel' with the |zx| command or
3421 set the 'foldclose' option to "all".
3422
3423 *'foldtext'* *'fdt'*
3424'foldtext' 'fdt' string (default: "foldtext()")
3425 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003426 {not available when compiled without the |+folding|
3427 feature}
3428 An expression which is used to specify the text displayed for a closed
3429 fold. See |fold-foldtext|.
3430
Bram Moolenaar30b65812012-07-12 22:01:11 +02003431 The expression will be evaluated in the |sandbox| if set from a
3432 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003433 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003434
3435 It is not allowed to change text or jump to another window while
3436 evaluating 'foldtext' |textlock|.
3437
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003438 *'formatexpr'* *'fex'*
3439'formatexpr' 'fex' string (default "")
3440 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003441 {not available when compiled without the |+eval|
3442 feature}
3443 Expression which is evaluated to format a range of lines for the |gq|
3444 operator or automatic formatting (see 'formatoptions'). When this
3445 option is empty 'formatprg' is used.
3446
3447 The |v:lnum| variable holds the first line to be formatted.
3448 The |v:count| variable holds the number of lines to be formatted.
3449 The |v:char| variable holds the character that is going to be
3450 inserted if the expression is being evaluated due to
3451 automatic formatting. This can be empty. Don't insert
3452 it yet!
3453
3454 Example: >
3455 :set formatexpr=mylang#Format()
3456< This will invoke the mylang#Format() function in the
3457 autoload/mylang.vim file in 'runtimepath'. |autoload|
3458
3459 The expression is also evaluated when 'textwidth' is set and adding
3460 text beyond that limit. This happens under the same conditions as
3461 when internal formatting is used. Make sure the cursor is kept in the
3462 same spot relative to the text then! The |mode()| function will
3463 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003464
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003465 When the expression evaluates to non-zero Vim will fall back to using
3466 the internal format mechanism.
3467
3468 The expression will be evaluated in the |sandbox| when set from a
3469 modeline, see |sandbox-option|. That stops the option from working,
3470 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003471 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003472 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003473
Bram Moolenaar86b68352004-12-27 21:59:20 +00003474 *'formatlistpat'* *'flp'*
3475'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3476 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003477 A pattern that is used to recognize a list header. This is used for
3478 the "n" flag in 'formatoptions'.
3479 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003480 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003481 while still checking more characters. There must be a character
3482 following the pattern, when it matches the whole line it is handled
3483 like there is no match.
3484 The default recognizes a number, followed by an optional punctuation
3485 character and white space.
3486
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003487 *'formatoptions'* *'fo'*
3488'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3489 local to buffer
3490 This is a sequence of letters which describes how automatic
3491 formatting is to be done. See |fo-table|. When the 'paste' option is
3492 on, no formatting is done (like 'formatoptions' is empty). Commas can
3493 be inserted for readability.
3494 To avoid problems with flags that are added in the future, use the
3495 "+=" and "-=" feature of ":set" |add-option-flags|.
3496 NOTE: This option is set to the Vi default value when 'compatible' is
3497 set and to the Vim default value when 'compatible' is reset.
3498
Bram Moolenaar071d4272004-06-13 20:20:40 +00003499 *'formatprg'* *'fp'*
3500'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003501 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003502 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003503 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003505 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003506 If the 'formatexpr' option is not empty it will be used instead.
3507 Otherwise, if 'formatprg' option is an empty string, the internal
3508 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003509 Environment variables are expanded |:set_env|. See |option-backslash|
3510 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003511 This option cannot be set from a |modeline| or in the |sandbox|, for
3512 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003513
Bram Moolenaard94464e2015-11-02 15:28:18 +01003514 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003515'fsync' 'fs' boolean (default on)
3516 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003517 When on, the library function fsync() will be called after writing a
3518 file. This will flush a file to disk, ensuring that it is safely
3519 written even on filesystems which do metadata-only journaling. This
3520 will force the harddrive to spin up on Linux systems running in laptop
3521 mode, so it may be undesirable in some situations. Be warned that
3522 turning this off increases the chances of data loss after a crash. On
3523 systems without an fsync() implementation, this variable is always
3524 off.
3525 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003526 'fsync' also applies to |writefile()|, unless a flag is used to
3527 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003528 This option cannot be set from a |modeline| or in the |sandbox|, for
3529 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003530
Bram Moolenaar071d4272004-06-13 20:20:40 +00003531 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3532'gdefault' 'gd' boolean (default off)
3533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003534 When on, the ":substitute" flag 'g' is default on. This means that
3535 all matches in a line are substituted instead of one. When a 'g' flag
3536 is given to a ":substitute" command, this will toggle the substitution
3537 of all or one match. See |complex-change|.
3538
3539 command 'gdefault' on 'gdefault' off ~
3540 :s/// subst. all subst. one
3541 :s///g subst. one subst. all
3542 :s///gg subst. all subst. one
3543
3544 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003545 DEPRECATED: Setting this option may break plugins that are not aware
3546 of this option. Also, many users get confused that adding the /g flag
3547 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003548
3549 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003550'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 Format to recognize for the ":grep" command output.
3553 This is a scanf-like string that uses the same format as the
3554 'errorformat' option: see |errorformat|.
3555
3556 *'grepprg'* *'gp'*
3557'grepprg' 'gp' string (default "grep -n ",
3558 Unix: "grep -n $* /dev/null",
3559 Win32: "findstr /n" or "grep -n",
3560 VMS: "SEARCH/NUMBERS ")
3561 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003562 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003563 and '#' characters, which are expanded like when used in a command-
3564 line. The placeholder "$*" is allowed to specify where the arguments
3565 will be included. Environment variables are expanded |:set_env|. See
3566 |option-backslash| about including spaces and backslashes.
3567 When your "grep" accepts the "-H" argument, use this to make ":grep"
3568 also work well with a single file: >
3569 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003570< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003571 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3572 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003573 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 apply equally to 'grepprg'.
3575 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3576 otherwise it's "grep -n".
3577 This option cannot be set from a |modeline| or in the |sandbox|, for
3578 security reasons.
3579
3580 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3581'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3582 ve:ver35-Cursor,
3583 o:hor50-Cursor,
3584 i-ci:ver25-Cursor/lCursor,
3585 r-cr:hor20-Cursor/lCursor,
3586 sm:block-Cursor
3587 -blinkwait175-blinkoff150-blinkon175",
3588 for MS-DOS and Win32 console:
3589 "n-v-c:block,o:hor50,i-ci:hor15,
3590 r-cr:hor30,sm:block")
3591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592 {only available when compiled with GUI enabled, and
3593 for MS-DOS and Win32 console}
3594 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003595 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003596 the height of the cursor can be changed. This can be done by
3597 specifying a block cursor, or a percentage for a vertical or
3598 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003599 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3600 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003601
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003602 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003603 mode-list and an argument-list:
3604 mode-list:argument-list,mode-list:argument-list,..
3605 The mode-list is a dash separated list of these modes:
3606 n Normal mode
3607 v Visual mode
3608 ve Visual mode with 'selection' "exclusive" (same as 'v',
3609 if not specified)
3610 o Operator-pending mode
3611 i Insert mode
3612 r Replace mode
3613 c Command-line Normal (append) mode
3614 ci Command-line Insert mode
3615 cr Command-line Replace mode
3616 sm showmatch in Insert mode
3617 a all modes
3618 The argument-list is a dash separated list of these arguments:
3619 hor{N} horizontal bar, {N} percent of the character height
3620 ver{N} vertical bar, {N} percent of the character width
3621 block block cursor, fills the whole character
3622 [only one of the above three should be present]
3623 blinkwait{N} *cursor-blinking*
3624 blinkon{N}
3625 blinkoff{N}
3626 blink times for cursor: blinkwait is the delay before
3627 the cursor starts blinking, blinkon is the time that
3628 the cursor is shown and blinkoff is the time that the
3629 cursor is not shown. The times are in msec. When one
3630 of the numbers is zero, there is no blinking. The
3631 default is: "blinkwait700-blinkon400-blinkoff250".
3632 These numbers are used for a missing entry. This
3633 means that blinking is enabled by default. To switch
3634 blinking off you can use "blinkon0". The cursor only
3635 blinks when Vim is waiting for input, not while
3636 executing a command.
3637 To make the cursor blink in an xterm, see
3638 |xterm-blink|.
3639 {group-name}
3640 a highlight group name, that sets the color and font
3641 for the cursor
3642 {group-name}/{group-name}
3643 Two highlight group names, the first is used when
3644 no language mappings are used, the other when they
3645 are. |language-mapping|
3646
3647 Examples of parts:
3648 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3649 block cursor with colors from the "nCursor"
3650 highlight group
3651 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3652 In Insert and Command-line Insert mode, use a
3653 30% vertical bar cursor with colors from the
3654 "iCursor" highlight group. Blink a bit
3655 faster.
3656
3657 The 'a' mode is different. It will set the given argument-list for
3658 all modes. It does not reset anything to defaults. This can be used
3659 to do a common setting for all modes. For example, to switch off
3660 blinking: "a:blinkon0"
3661
3662 Examples of cursor highlighting: >
3663 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3664 :highlight Cursor gui=NONE guifg=bg guibg=fg
3665<
3666 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003667 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003668'guifont' 'gfn' string (default "")
3669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 {only available when compiled with GUI enabled}
3671 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003672 In its simplest form the value is just one font name.
3673 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003674
3675 *'guifontset'* *'gfs'*
3676 *E250* *E252* *E234* *E597* *E598*
3677'guifontset' 'gfs' string (default "")
3678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003679 {only available when compiled with GUI enabled and
3680 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003681 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003682 When not empty, specifies two (or more) fonts to be used. The first
3683 one for normal English, the second one for your special language. See
3684 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003685
Bram Moolenaar071d4272004-06-13 20:20:40 +00003686 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3687'guifontwide' 'gfw' string (default "")
3688 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 {only available when compiled with GUI enabled}
3690 When not empty, specifies a comma-separated list of fonts to be used
3691 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003692 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003693
Bram Moolenaar071d4272004-06-13 20:20:40 +00003694 *'guiheadroom'* *'ghr'*
3695'guiheadroom' 'ghr' number (default 50)
3696 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003697 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 The number of pixels subtracted from the screen height when fitting
3699 the GUI window on the screen. Set this before the GUI is started,
3700 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003701 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 lines will be left for window decorations and other items on the
3703 screen. Set it to a negative value to allow windows taller than the
3704 screen.
3705
3706 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003707'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3708 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003709 "aegimrLtT" (GTK, Motif and Athena),
3710 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003711 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003713 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003714 sequence of letters which describes what components and options of the
3715 GUI should be used.
3716 To avoid problems with flags that are added in the future, use the
3717 "+=" and "-=" feature of ":set" |add-option-flags|.
3718
Bram Moolenaar13568252018-03-16 20:46:58 +01003719 Valid characters are as follows:
3720 *'go-!'*
3721 '!' External commands are executed in a terminal window. Without
3722 this flag the MS-Windows GUI will open a console window to
3723 execute the command. The Unix GUI will simulate a dumb
3724 terminal to list the command output.
3725 The terminal window will be positioned at the bottom, and grow
3726 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003727 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003728 'a' Autoselect: If present, then whenever VISUAL mode is started,
3729 or the Visual area extended, Vim tries to become the owner of
3730 the windowing system's global selection. This means that the
3731 Visually highlighted text is available for pasting into other
3732 applications as well as into Vim itself. When the Visual mode
3733 ends, possibly due to an operation on the text, or when an
3734 application wants to paste the selection, the highlighted text
3735 is automatically yanked into the "* selection register.
3736 Thus the selection is still available for pasting into other
3737 applications after the VISUAL mode has ended.
3738 If not present, then Vim won't become the owner of the
3739 windowing system's global selection unless explicitly told to
3740 by a yank or delete operation for the "* register.
3741 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003742 *'go-P'*
3743 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003744 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003745 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003746 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 applies to the modeless selection.
3748
3749 'guioptions' autoselect Visual autoselect modeless ~
3750 "" - -
3751 "a" yes yes
3752 "A" - yes
3753 "aA" yes yes
3754
Bram Moolenaar02467872007-05-06 13:22:01 +00003755 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003756 'c' Use console dialogs instead of popup dialogs for simple
3757 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003758 *'go-d'*
3759 'd' Use dark theme variant if available. Currently only works for
3760 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003761 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003762 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003763 'guitablabel' can be used to change the text in the labels.
3764 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003765 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003766 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003767 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003768 'f' Foreground: Don't use fork() to detach the GUI from the shell
3769 where it was started. Use this for programs that wait for the
3770 editor to finish (e.g., an e-mail program). Alternatively you
3771 can use "gvim -f" or ":gui -f" to start the GUI in the
3772 foreground. |gui-fork|
3773 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003774 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003775 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3777 corner of the window. It's black&white on non-GTK, because of
3778 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003779 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003781 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003782 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003784 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003786 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003787 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003788 'g' Grey menu items: Make menu items that are not active grey. If
3789 'g' is not included inactive menu items are not shown at all.
3790 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003791 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 't' Include tearoff menu items. Currently only works for Win32,
3793 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003794 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003795 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003796 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003797 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003799 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003800 'R' Right-hand scrollbar is present when there is a vertically
3801 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003802 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003804 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003805 'L' Left-hand scrollbar is present when there is a vertically
3806 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003807 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003808 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3809 the longest visible line, or on the cursor line if the 'h'
3810 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003811 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003812 'h' Limit horizontal scrollbar size to the length of the cursor
3813 line. Reduces computations. |gui-horiz-scroll|
3814
3815 And yes, you may even have scrollbars on the left AND the right if
3816 you really want to :-). See |gui-scrollbars| for more information.
3817
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003818 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003819 'v' Use a vertical button layout for dialogs. When not included,
3820 a horizontal layout is preferred, but when it doesn't fit a
3821 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003822 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003823 'p' Use Pointer callbacks for X11 GUI. This is required for some
3824 window managers. If the cursor is not blinking or hollow at
3825 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003826 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003827 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003828 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003829 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003830 *'go-k'*
3831 'k' Keep the GUI window size when adding/removing a scrollbar, or
3832 toolbar, tabline, etc. Instead, the behavior is similar to
3833 when the window is maximized and will adjust 'lines' and
3834 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003835 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003836 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003837
Bram Moolenaar071d4272004-06-13 20:20:40 +00003838 *'guipty'* *'noguipty'*
3839'guipty' boolean (default on)
3840 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003841 {only available when compiled with GUI enabled}
3842 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3843 I/O to/from shell commands. See |gui-pty|.
3844
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003845 *'guitablabel'* *'gtl'*
3846'guitablabel' 'gtl' string (default empty)
3847 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003848 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003849 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003850 pages line. When empty and when the result is empty Vim will use a
3851 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003852
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003853 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003854 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003855 The expression will be evaluated in the |sandbox| when set from a
3856 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003857 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003858
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003859 Only used when the GUI tab pages line is displayed. 'e' must be
3860 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3861 used.
3862
Bram Moolenaar57657d82006-04-21 22:12:41 +00003863 *'guitabtooltip'* *'gtt'*
3864'guitabtooltip' 'gtt' string (default empty)
3865 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003866 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003867 When nonempty describes the text to use in a tooltip for the GUI tab
3868 pages line. When empty Vim will use a default tooltip.
3869 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003870 You can include a line break. Simplest method is to use |:let|: >
3871 :let &guitabtooltip = "line one\nline two"
3872<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003873
Bram Moolenaar071d4272004-06-13 20:20:40 +00003874 *'helpfile'* *'hf'*
3875'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3876 (others) "$VIMRUNTIME/doc/help.txt")
3877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 Name of the main help file. All distributed help files should be
3879 placed together in one directory. Additionally, all "doc" directories
3880 in 'runtimepath' will be used.
3881 Environment variables are expanded |:set_env|. For example:
3882 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003883 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003884 spaces and backslashes.
3885 This option cannot be set from a |modeline| or in the |sandbox|, for
3886 security reasons.
3887
3888 *'helpheight'* *'hh'*
3889'helpheight' 'hh' number (default 20)
3890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003891 Minimal initial height of the help window when it is opened with the
3892 ":help" command. The initial height of the help window is half of the
3893 current window, or (when the 'ea' option is on) the same as other
3894 windows. When the height is less than 'helpheight', the height is
3895 set to 'helpheight'. Set to zero to disable.
3896
3897 *'helplang'* *'hlg'*
3898'helplang' 'hlg' string (default: messages language or empty)
3899 global
3900 {only available when compiled with the |+multi_lang|
3901 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003902 Comma separated list of languages. Vim will use the first language
3903 for which the desired help can be found. The English help will always
3904 be used as a last resort. You can add "en" to prefer English over
3905 another language, but that will only find tags that exist in that
3906 language and not in the English help.
3907 Example: >
3908 :set helplang=de,it
3909< This will first search German, then Italian and finally English help
3910 files.
3911 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3912 try to find the tag in the current language before using this option.
3913 See |help-translated|.
3914
3915 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3916'hidden' 'hid' boolean (default off)
3917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003918 When off a buffer is unloaded when it is |abandon|ed. When on a
3919 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3920 displayed in another window, it does not become hidden, of course.
3921 The commands that move through the buffer list sometimes make a buffer
3922 hidden although the 'hidden' option is off: When the buffer is
3923 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003924 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003925 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003926 This option is set for one command with ":hide {command}" |:hide|.
3927 WARNING: It's easy to forget that you have changes in hidden buffers.
3928 Think twice when using ":q!" or ":qa!".
3929
3930 *'highlight'* *'hl'*
3931'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003932 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3933 d:Directory,e:ErrorMsg,i:IncSearch,
3934 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003935 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003936 N:CursorLineNr,r:Question,s:StatusLine,
3937 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003938 v:Visual,V:VisualNOS,w:WarningMsg,
3939 W:WildMenu,f:Folded,F:FoldColumn,
3940 A:DiffAdd,C:DiffChange,D:DiffDelete,
3941 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003942 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003943 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003944 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3945 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003946 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003947 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 This option can be used to set highlighting mode for various
3950 occasions. It is a comma separated list of character pairs. The
3951 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003952 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003953 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003954 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3955 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003956 characters from 'showbreak'
3957 |hl-Directory| d directories in CTRL-D listing and other special
3958 things in listings
3959 |hl-ErrorMsg| e error messages
3960 h (obsolete, ignored)
3961 |hl-IncSearch| i 'incsearch' highlighting
3962 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3963 |hl-MoreMsg| m |more-prompt|
3964 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003965 |hl-LineNr| n line number for ":number" and ":#" commands, and
3966 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003967 |hl-LineNrAbove| a line number above the cursor for when the
3968 'relativenumber' option is set.
3969 |hl-LineNrBelow| b line number below the cursor for when the
3970 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003971 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3972 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003973 |hl-Question| r |hit-enter| prompt and yes/no questions
3974 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003975 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3977 |hl-VertSplit| c column used to separate vertically split windows
3978 |hl-Visual| v Visual mode
3979 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3980 Selection" Only X11 Gui's |gui-x11| and
3981 |xterm-clipboard|.
3982 |hl-WarningMsg| w warning messages
3983 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3984 |hl-Folded| f line used for closed folds
3985 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003986 |hl-DiffAdd| A added line in diff mode
3987 |hl-DiffChange| C changed line in diff mode
3988 |hl-DiffDelete| D deleted line in diff mode
3989 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003990 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003991 |hl-Conceal| - the placeholders used for concealed characters
3992 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003993 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003994 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003995 |hl-SpellRare| R rare word |spell|
3996 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003997 |hl-Pmenu| + popup menu normal line
3998 |hl-PmenuSel| = popup menu selected line
3999 |hl-PmenuSbar| x popup menu scrollbar
4000 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004001
4002 The display modes are:
4003 r reverse (termcap entry "mr" and "me")
4004 i italic (termcap entry "ZH" and "ZR")
4005 b bold (termcap entry "md" and "me")
4006 s standout (termcap entry "so" and "se")
4007 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004008 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004009 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 n no highlighting
4011 - no highlighting
4012 : use a highlight group
4013 The default is used for occasions that are not included.
4014 If you want to change what the display modes do, see |dos-colors|
4015 for an example.
4016 When using the ':' display mode, this must be followed by the name of
4017 a highlight group. A highlight group can be used to define any type
4018 of highlighting, including using color. See |:highlight| on how to
4019 define one. The default uses a different group for each occasion.
4020 See |highlight-default| for the default highlight groups.
4021
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004023'history' 'hi' number (Vim default: 50, Vi default: 0,
4024 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004027 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004029 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004030 NOTE: This option is set to the Vi default value when 'compatible' is
4031 set and to the Vim default value when 'compatible' is reset.
4032
4033 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4034'hkmap' 'hk' boolean (default off)
4035 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004036 {only available when compiled with the |+rightleft|
4037 feature}
4038 When on, the keyboard is mapped for the Hebrew character set.
4039 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4040 toggle this option. See |rileft.txt|.
4041 NOTE: This option is reset when 'compatible' is set.
4042
4043 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4044'hkmapp' 'hkp' boolean (default off)
4045 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004046 {only available when compiled with the |+rightleft|
4047 feature}
4048 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4049 This is useful if you have a non-Hebrew keyboard.
4050 See |rileft.txt|.
4051 NOTE: This option is reset when 'compatible' is set.
4052
Bram Moolenaar036986f2017-03-16 17:41:02 +01004053 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4054'hlsearch' 'hls' boolean (default off)
4055 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004056 {not available when compiled without the
4057 |+extra_search| feature}
4058 When there is a previous search pattern, highlight all its matches.
4059 The type of highlighting used can be set with the 'l' occasion in the
4060 'highlight' option. This uses the "Search" highlight group by
4061 default. Note that only the matching text is highlighted, any offsets
4062 are not applied.
4063 See also: 'incsearch' and |:match|.
4064 When you get bored looking at the highlighted matches, you can turn it
4065 off with |:nohlsearch|. This does not change the option value, as
4066 soon as you use a search command, the highlighting comes back.
4067 'redrawtime' specifies the maximum time spent on finding matches.
4068 When the search pattern can match an end-of-line, Vim will try to
4069 highlight all of the matched text. However, this depends on where the
4070 search starts. This will be the first line in the window or the first
4071 line below a closed fold. A match in a previous line which is not
4072 drawn may not continue in a newly drawn line.
4073 You can specify whether the highlight status is restored on startup
4074 with the 'h' flag in 'viminfo' |viminfo-h|.
4075 NOTE: This option is reset when 'compatible' is set.
4076
Bram Moolenaar071d4272004-06-13 20:20:40 +00004077 *'icon'* *'noicon'*
4078'icon' boolean (default off, on when title can be restored)
4079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 {not available when compiled without the |+title|
4081 feature}
4082 When on, the icon text of the window will be set to the value of
4083 'iconstring' (if it is not empty), or to the name of the file
4084 currently being edited. Only the last part of the name is used.
4085 Overridden by the 'iconstring' option.
4086 Only works if the terminal supports setting window icons (currently
4087 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4088 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4089 builtin termcap).
4090 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004091 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004092 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004093 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004094
4095 *'iconstring'*
4096'iconstring' string (default "")
4097 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004098 {not available when compiled without the |+title|
4099 feature}
4100 When this option is not empty, it will be used for the icon text of
4101 the window. This happens only when the 'icon' option is on.
4102 Only works if the terminal supports setting window icon text
4103 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4104 Does not work for MS Windows.
4105 When Vim was compiled with HAVE_X11 defined, the original icon will be
4106 restored if possible |X11|.
4107 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004108 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004109 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004110 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004111 {not available when compiled without the |+statusline| feature}
4112
4113 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4114'ignorecase' 'ic' boolean (default off)
4115 global
4116 Ignore case in search patterns. Also used when searching in the tags
4117 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004118 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004119 Can be overruled by using "\c" or "\C" in the pattern, see
4120 |/ignorecase|.
4121
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004122 *'imactivatefunc'* *'imaf'*
4123'imactivatefunc' 'imaf' string (default "")
4124 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004125 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004126 activate or deactivate the Input Method.
4127 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004128 The expression will be evaluated in the |sandbox| when set from a
4129 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004130
4131 Example: >
4132 function ImActivateFunc(active)
4133 if a:active
4134 ... do something
4135 else
4136 ... do something
4137 endif
4138 " return value is not used
4139 endfunction
4140 set imactivatefunc=ImActivateFunc
4141<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004142 *'imactivatekey'* *'imak'*
4143'imactivatekey' 'imak' string (default "")
4144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004145 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004146 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004147 Specifies the key that your Input Method in X-Windows uses for
4148 activation. When this is specified correctly, vim can fully control
4149 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4150 You can't use this option to change the activation key, the option
4151 tells Vim what the key is.
4152 Format:
4153 [MODIFIER_FLAG-]KEY_STRING
4154
4155 These characters can be used for MODIFIER_FLAG (case is ignored):
4156 S Shift key
4157 L Lock key
4158 C Control key
4159 1 Mod1 key
4160 2 Mod2 key
4161 3 Mod3 key
4162 4 Mod4 key
4163 5 Mod5 key
4164 Combinations are allowed, for example "S-C-space" or "SC-space" are
4165 both shift+ctrl+space.
4166 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4167
4168 Example: >
4169 :set imactivatekey=S-space
4170< "S-space" means shift+space. This is the activation key for kinput2 +
4171 canna (Japanese), and ami (Korean).
4172
4173 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4174'imcmdline' 'imc' boolean (default off)
4175 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004176 When set the Input Method is always on when starting to edit a command
4177 line, unless entering a search pattern (see 'imsearch' for that).
4178 Setting this option is useful when your input method allows entering
4179 English characters directly, e.g., when it's used to type accented
4180 characters with dead keys.
4181
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004182 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004183'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4184 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004185 When set the Input Method is never used. This is useful to disable
4186 the IM when it doesn't work properly.
4187 Currently this option is on by default for SGI/IRIX machines. This
4188 may change in later releases.
4189
4190 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004191'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004192 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 Specifies whether :lmap or an Input Method (IM) is to be used in
4194 Insert mode. Valid values:
4195 0 :lmap is off and IM is off
4196 1 :lmap is ON and IM is off
4197 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 To always reset the option to zero when leaving Insert mode with <Esc>
4199 this can be used: >
4200 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4201< This makes :lmap and IM turn off automatically when leaving Insert
4202 mode.
4203 Note that this option changes when using CTRL-^ in Insert mode
4204 |i_CTRL-^|.
4205 The value is set to 1 when setting 'keymap' to a valid keymap name.
4206 It is also used for the argument of commands like "r" and "f".
4207 The value 0 may not work correctly with Athena and Motif with some XIM
4208 methods. Use 'imdisable' to disable XIM then.
4209
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004210 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004211 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004212 |+multi_byte_ime| or |global-ime|.
4213
Bram Moolenaar071d4272004-06-13 20:20:40 +00004214 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004215'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004216 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 Specifies whether :lmap or an Input Method (IM) is to be used when
4218 entering a search pattern. Valid values:
4219 -1 the value of 'iminsert' is used, makes it look like
4220 'iminsert' is also used when typing a search pattern
4221 0 :lmap is off and IM is off
4222 1 :lmap is ON and IM is off
4223 2 :lmap is off and IM is ON
4224 Note that this option changes when using CTRL-^ in Command-line mode
4225 |c_CTRL-^|.
4226 The value is set to 1 when it is not -1 and setting the 'keymap'
4227 option to a valid keymap name.
4228 The value 0 may not work correctly with Athena and Motif with some XIM
4229 methods. Use 'imdisable' to disable XIM then.
4230
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004231 *'imstatusfunc'* *'imsf'*
4232'imstatusfunc' 'imsf' string (default "")
4233 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004234 This option specifies a function that is called to obtain the status
4235 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004236 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004237
4238 Example: >
4239 function ImStatusFunc()
4240 let is_active = ...do something
4241 return is_active ? 1 : 0
4242 endfunction
4243 set imstatusfunc=ImStatusFunc
4244<
4245 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004246 The expression will be evaluated in the |sandbox| when set from a
4247 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004248
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004249 *'imstyle'* *'imst'*
4250'imstyle' 'imst' number (default 1)
4251 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004252 {only available when compiled with |+xim| and
4253 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004254 This option specifies the input style of Input Method:
4255 0 use on-the-spot style
4256 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004257 See: |xim-input-style|
4258
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004259 For a long time on-the-spot style had been used in the GTK version of
4260 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004261 |single-repeat|, etc. Therefore over-the-spot style becomes the
4262 default now. This should work fine for most people, however if you
4263 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004264 The expression will be evaluated in the |sandbox| when set from a
4265 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004266
Bram Moolenaar071d4272004-06-13 20:20:40 +00004267 *'include'* *'inc'*
4268'include' 'inc' string (default "^\s*#\s*include")
4269 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004270 {not available when compiled without the
4271 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004272 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 pattern, just like for the "/" command (See |pattern|). The default
4274 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004275 "]I", "[d", etc.
4276 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004277 comes after the matched pattern. But if "\zs" appears in the pattern
4278 then the text matched from "\zs" to the end, or until "\ze" if it
4279 appears, is used as the file name. Use this to include characters
4280 that are not in 'isfname', such as a space. You can then use
4281 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004282 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004283
4284 *'includeexpr'* *'inex'*
4285'includeexpr' 'inex' string (default "")
4286 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004288 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004289 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004290 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 :set includeexpr=substitute(v:fname,'\\.','/','g')
4292< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004293
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004295 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004296 Also used for |<cfile>|.
4297
Bram Moolenaar30b65812012-07-12 22:01:11 +02004298 The expression will be evaluated in the |sandbox| when set from a
4299 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004300 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004301
4302 It is not allowed to change text or jump to another window while
4303 evaluating 'includeexpr' |textlock|.
4304
Bram Moolenaar071d4272004-06-13 20:20:40 +00004305 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004306'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4307 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004310 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004311 While typing a search command, show where the pattern, as it was typed
4312 so far, matches. The matched string is highlighted. If the pattern
4313 is invalid or not found, nothing is shown. The screen will be updated
4314 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004315 Also applies to the pattern in commands: >
4316 :global
4317 :lvimgrep
4318 :lvimgrepadd
4319 :smagic
4320 :snomagic
4321 :sort
4322 :substitute
4323 :vglobal
4324 :vimgrep
4325 :vimgrepadd
4326< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004327 original position when no match is found and when pressing <Esc>. You
4328 still need to finish the search command with <Enter> to move the
4329 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004330 You can use the CTRL-G and CTRL-T keys to move to the next and
4331 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004332 When compiled with the |+reltime| feature Vim only searches for about
4333 half a second. With a complicated pattern and/or a lot of text the
4334 match may not be found. This is to avoid that Vim hangs while you
4335 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004336 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004337 When 'hlsearch' is on, all matched strings are highlighted too while
4338 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004339 If you don't want to turn 'hlsearch' on, but want to highlight all
4340 matches while searching, you can turn on and off 'hlsearch' with
4341 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004342 augroup vimrc-incsearch-highlight
4343 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004344 autocmd CmdlineEnter /,\? :set hlsearch
4345 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004346 augroup END
4347<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004348 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004349 to the command line. If 'ignorecase' and 'smartcase' are set and the
4350 command line has no uppercase characters, the added character is
4351 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004352 CTRL-R CTRL-W can be used to add the word at the end of the current
4353 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004354 NOTE: This option is reset when 'compatible' is set.
4355
4356 *'indentexpr'* *'inde'*
4357'indentexpr' 'inde' string (default "")
4358 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004359 {not available when compiled without the |+cindent|
4360 or |+eval| features}
4361 Expression which is evaluated to obtain the proper indent for a line.
4362 It is used when a new line is created, for the |=| operator and
4363 in Insert mode as specified with the 'indentkeys' option.
4364 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004365 'smartindent' indenting. When 'lisp' is set, this option is
4366 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 When 'paste' is set this option is not used for indenting.
4368 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004369 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004370 when the expression is evaluated (but it may be moved around).
4371 The expression must return the number of spaces worth of indent. It
4372 can return "-1" to keep the current indent (this means 'autoindent' is
4373 used for the indent).
4374 Functions useful for computing the indent are |indent()|, |cindent()|
4375 and |lispindent()|.
4376 The evaluation of the expression must not have side effects! It must
4377 not change the text, jump to another window, etc. Afterwards the
4378 cursor position is always restored, thus the cursor may be moved.
4379 Normally this option would be set to call a function: >
4380 :set indentexpr=GetMyIndent()
4381< Error messages will be suppressed, unless the 'debug' option contains
4382 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004383 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004384 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
Bram Moolenaar30b65812012-07-12 22:01:11 +02004386 The expression will be evaluated in the |sandbox| when set from a
4387 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004388 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004389
4390 It is not allowed to change text or jump to another window while
4391 evaluating 'indentexpr' |textlock|.
4392
4393
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004395'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 {not available when compiled without the |+cindent|
4398 feature}
4399 A list of keys that, when typed in Insert mode, cause reindenting of
4400 the current line. Only happens if 'indentexpr' isn't empty.
4401 The format is identical to 'cinkeys', see |indentkeys-format|.
4402 See |C-indenting| and |indent-expression|.
4403
4404 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4405'infercase' 'inf' boolean (default off)
4406 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004407 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004408 'ignorecase' is also on, the case of the match is adjusted depending
4409 on the typed text. If the typed text contains a lowercase letter
4410 where the match has an upper case letter, the completed part is made
4411 lowercase. If the typed text has no lowercase letters and the match
4412 has a lowercase letter where the typed text has an uppercase letter,
4413 and there is a letter before it, the completed part is made uppercase.
4414 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415
4416 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4417'insertmode' 'im' boolean (default off)
4418 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004419 Makes Vim work in a way that Insert mode is the default mode. Useful
4420 if you want to use Vim as a modeless editor. Used for |evim|.
4421 These Insert mode commands will be useful:
4422 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004423 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 this is a mapping, it is executed as if 'insertmode' was off.
4425 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004426 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004427 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4428 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004429
4430 These items change when 'insertmode' is set:
4431 - when starting to edit of a file, Vim goes to Insert mode.
4432 - <Esc> in Insert mode is a no-op and beeps.
4433 - <Esc> in Normal mode makes Vim go to Insert mode.
4434 - CTRL-L in Insert mode is a command, it is not inserted.
4435 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4436 However, when <Esc> is used inside a mapping, it behaves like
4437 'insertmode' was not set. This was done to be able to use the same
4438 mappings with 'insertmode' set or not set.
4439 When executing commands with |:normal| 'insertmode' is not used.
4440
4441 NOTE: This option is reset when 'compatible' is set.
4442
4443 *'isfname'* *'isf'*
4444'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4445 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4446 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4447 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4448 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4449 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4450 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004451 The characters specified by this option are included in file names and
4452 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004453 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004454 Multi-byte characters 256 and above are always included, only the
4455 characters up to 255 are specified with this option.
4456 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004457 Think twice before adding white space to this option. Although a
4458 space may appear inside a file name, the effect will be that Vim
4459 doesn't know where a file name starts or ends when doing completion.
4460 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004461
4462 Note that on systems using a backslash as path separator, Vim tries to
4463 do its best to make it work as you would expect. That is a bit
4464 tricky, since Vi originally used the backslash to escape special
4465 characters. Vim will not remove a backslash in front of a normal file
4466 name character on these systems, but it will on Unix and alikes. The
4467 '&' and '^' are not included by default, because these are special for
4468 cmd.exe.
4469
4470 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004471 Each part can be a single character number or a range. A range is two
4472 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004473 decimal number between 0 and 255 or the ASCII character itself (does
4474 not work for digits). Example:
4475 "_,-,128-140,#-43" (include '_' and '-' and the range
4476 128 to 140 and '#' to 43)
4477 If a part starts with '^', the following character number or range
4478 will be excluded from the option. The option is interpreted from left
4479 to right. Put the excluded character after the range where it is
4480 included. To include '^' itself use it as the last character of the
4481 option or the end of a range. Example:
4482 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4483 If the character is '@', all characters where isalpha() returns TRUE
4484 are included. Normally these are the characters a to z and A to Z,
4485 plus accented characters. To include '@' itself use "@-@". Examples:
4486 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004487 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 "a-z,A-Z,@-@" All letters plus the '@' character.
4489 A comma can be included by using it where a character number is
4490 expected. Example:
4491 "48-57,,,_" Digits, comma and underscore.
4492 A comma can be excluded by prepending a '^'. Example:
4493 " -~,^,,9" All characters from space to '~', excluding
4494 comma, plus <Tab>.
4495 See |option-backslash| about including spaces and backslashes.
4496
4497 *'isident'* *'isi'*
4498'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4499 "@,48-57,_,128-167,224-235"
4500 otherwise: "@,48-57,_,192-255")
4501 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004502 The characters given by this option are included in identifiers.
4503 Identifiers are used in recognizing environment variables and after a
4504 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004505 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004506 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004507 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004508 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004509 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4510
4511 *'iskeyword'* *'isk'*
4512'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4513 "@,48-57,_,128-167,224-235"
4514 otherwise: "@,48-57,_,192-255"
4515 Vi default: "@,48-57,_")
4516 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004518 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004519 'isfname' for a description of the format of this option. For '@'
4520 characters above 255 check the "word" character class.
4521 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004522 For a help file it is set to all non-blank printable characters except
4523 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4524 command).
4525 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004526 This option also influences syntax highlighting, unless the syntax
4527 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004528 NOTE: This option is set to the Vi default value when 'compatible' is
4529 set and to the Vim default value when 'compatible' is reset.
4530
4531 *'isprint'* *'isp'*
4532'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4533 "@,~-255"; otherwise: "@,161-255")
4534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 The characters given by this option are displayed directly on the
4536 screen. It is also used for "\p" in a |pattern|. The characters from
4537 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4538 even when they are not included in 'isprint' or excluded. See
4539 'isfname' for a description of the format of this option.
4540
4541 Non-printable characters are displayed with two characters:
4542 0 - 31 "^@" - "^_"
4543 32 - 126 always single characters
4544 127 "^?"
4545 128 - 159 "~@" - "~_"
4546 160 - 254 "| " - "|~"
4547 255 "~?"
4548 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4549 displayed as <xx>, with the hexadecimal value of the byte.
4550 When 'display' contains "uhex" all unprintable characters are
4551 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004552 The SpecialKey highlighting will be used for unprintable characters.
4553 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004554
4555 Multi-byte characters 256 and above are always included, only the
4556 characters up to 255 are specified with this option. When a character
4557 is printable but it is not available in the current font, a
4558 replacement character will be shown.
4559 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4560 There is no option to specify these characters.
4561
4562 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4563'joinspaces' 'js' boolean (default on)
4564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004565 Insert two spaces after a '.', '?' and '!' with a join command.
4566 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4567 Otherwise only one space is inserted.
4568 NOTE: This option is set when 'compatible' is set.
4569
4570 *'key'*
4571'key' string (default "")
4572 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004573 {only available when compiled with the |+cryptv|
4574 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004575 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004576 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004577 Careful: Do not set the key value by hand, someone might see the typed
4578 key. Use the |:X| command. But you can make 'key' empty: >
4579 :set key=
4580< It is not possible to get the value of this option with ":set key" or
4581 "echo &key". This is to avoid showing it to someone who shouldn't
4582 know. It also means you cannot see it yourself once you have set it,
4583 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004584 You can use "&key" in an expression to detect whether encryption is
4585 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004586
4587 *'keymap'* *'kmp'* *E544*
4588'keymap' 'kmp' string (default "")
4589 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004590 {only available when compiled with the |+keymap|
4591 feature}
4592 Name of a keyboard mapping. See |mbyte-keymap|.
4593 Setting this option to a valid keymap name has the side effect of
4594 setting 'iminsert' to one, so that the keymap becomes effective.
4595 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004596 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597
4598 *'keymodel'* *'km'*
4599'keymodel' 'km' string (default "")
4600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 List of comma separated words, which enable special things that keys
4602 can do. These values can be used:
4603 startsel Using a shifted special key starts selection (either
4604 Select mode or Visual mode, depending on "key" being
4605 present in 'selectmode').
4606 stopsel Using a not-shifted special key stops selection.
4607 Special keys in this context are the cursor keys, <End>, <Home>,
4608 <PageUp> and <PageDown>.
4609 The 'keymodel' option is set by the |:behave| command.
4610
4611 *'keywordprg'* *'kp'*
4612'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004613 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004614 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 Program to use for the |K| command. Environment variables are
4616 expanded |:set_env|. ":help" may be used to access the Vim internal
4617 help. (Note that previously setting the global option to the empty
4618 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004619 When the first character is ":", the command is invoked as a Vim
4620 Ex command prefixed with [count].
4621 When "man", "man -s" or an Ex command is used, Vim will automatically
4622 translate a count for the "K" command and pass it as the first
4623 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 See |option-backslash| about including spaces and backslashes.
4625 Example: >
4626 :set keywordprg=man\ -s
4627< This option cannot be set from a |modeline| or in the |sandbox|, for
4628 security reasons.
4629
4630 *'langmap'* *'lmap'* *E357* *E358*
4631'langmap' 'lmap' string (default "")
4632 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633 {only available when compiled with the |+langmap|
4634 feature}
4635 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004636 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004637 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004638 care of translating these special characters to the original meaning
4639 of the key. This means you don't have to change the keyboard mode to
4640 be able to execute Normal mode commands.
4641 This is the opposite of the 'keymap' option, where characters are
4642 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004643 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004644 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004645 This option cannot be set from a |modeline| or in the |sandbox|, for
4646 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004647
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004648 Example (for Greek, in UTF-8): *greek* >
4649 :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 +00004650< Example (exchanges meaning of z and y for commands): >
4651 :set langmap=zy,yz,ZY,YZ
4652<
4653 The 'langmap' option is a list of parts, separated with commas. Each
4654 part can be in one of two forms:
4655 1. A list of pairs. Each pair is a "from" character immediately
4656 followed by the "to" character. Examples: "aA", "aAbBcC".
4657 2. A list of "from" characters, a semi-colon and a list of "to"
4658 characters. Example: "abc;ABC"
4659 Example: "aA,fgh;FGH,cCdDeE"
4660 Special characters need to be preceded with a backslash. These are
4661 ";", ',' and backslash itself.
4662
4663 This will allow you to activate vim actions without having to switch
4664 back and forth between the languages. Your language characters will
4665 be understood as normal vim English characters (according to the
4666 langmap mappings) in the following cases:
4667 o Normal/Visual mode (commands, buffer/register names, user mappings)
4668 o Insert/Replace Mode: Register names after CTRL-R
4669 o Insert/Replace Mode: Mappings
4670 Characters entered in Command-line mode will NOT be affected by
4671 this option. Note that this option can be changed at any time
4672 allowing to switch between mappings for different languages/encodings.
4673 Use a mapping to avoid having to type it each time!
4674
4675 *'langmenu'* *'lm'*
4676'langmenu' 'lm' string (default "")
4677 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004678 {only available when compiled with the |+menu| and
4679 |+multi_lang| features}
4680 Language to use for menu translation. Tells which file is loaded
4681 from the "lang" directory in 'runtimepath': >
4682 "lang/menu_" . &langmenu . ".vim"
4683< (without the spaces). For example, to always use the Dutch menus, no
4684 matter what $LANG is set to: >
4685 :set langmenu=nl_NL.ISO_8859-1
4686< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004687 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004688 If your $LANG is set to a non-English language but you do want to use
4689 the English menus: >
4690 :set langmenu=none
4691< This option must be set before loading menus, switching on filetype
4692 detection or syntax highlighting. Once the menus are defined setting
4693 this option has no effect. But you could do this: >
4694 :source $VIMRUNTIME/delmenu.vim
4695 :set langmenu=de_DE.ISO_8859-1
4696 :source $VIMRUNTIME/menu.vim
4697< Warning: This deletes all menus that you defined yourself!
4698
Bram Moolenaard94464e2015-11-02 15:28:18 +01004699 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004700'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004701 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004702 {only available when compiled with the |+langmap|
4703 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004704 This is just like 'langremap' but with the value inverted. It only
4705 exists for backwards compatibility. When setting 'langremap' then
4706 'langnoremap' is set to the inverted value, and the other way around.
4707
4708 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4709'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4710 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004711 {only available when compiled with the |+langmap|
4712 feature}
4713 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004714 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004715 'langmap' disables some of your mappings, try resetting this option.
4716 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004717 that works for you to avoid mappings to break.
4718
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 *'laststatus'* *'ls'*
4720'laststatus' 'ls' number (default 1)
4721 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 The value of this option influences when the last window will have a
4723 status line:
4724 0: never
4725 1: only if there are at least two windows
4726 2: always
4727 The screen looks nicer with a status line if you have several
4728 windows, but it takes another screen line. |status-line|
4729
4730 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4731'lazyredraw' 'lz' boolean (default off)
4732 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004733 When this option is set, the screen will not be redrawn while
4734 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004735 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 update use |:redraw|.
4737
4738 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4739'linebreak' 'lbr' boolean (default off)
4740 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004741 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004742 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004743 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004744 than at the last character that fits on the screen. Unlike
4745 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004746 it only affects the way the file is displayed, not its contents.
4747 If 'breakindent' is set, line is visually indented. Then, the value
4748 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004749 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004750 Note that <Tab> characters after an <EOL> are mostly not displayed
4751 with the right amount of white space.
4752
4753 *'lines'* *E593*
4754'lines' number (default 24 or terminal height)
4755 global
4756 Number of lines of the Vim window.
4757 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004758 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 When Vim is running in the GUI or in a resizable window, setting this
4760 option will cause the window size to be changed. When you only want
4761 to use the size for the GUI, put the command in your |gvimrc| file.
4762 Vim limits the number of lines to what fits on the screen. You can
4763 use this command to get the tallest window possible: >
4764 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004765< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004766 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767 When you set this option and Vim is unable to change the physical
4768 number of lines of the display, the display may be messed up.
4769
4770 *'linespace'* *'lsp'*
4771'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004773 {only in the GUI}
4774 Number of pixel lines inserted between characters. Useful if the font
4775 uses the full character cell height, making lines touch each other.
4776 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004777 With some fonts there can be too much room between lines (to have
4778 space for ascents and descents). Then it makes sense to set
4779 'linespace' to a negative value. This may cause display problems
4780 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004781
4782 *'lisp'* *'nolisp'*
4783'lisp' boolean (default off)
4784 local to buffer
4785 {not available when compiled without the |+lispindent|
4786 feature}
4787 Lisp mode: When <Enter> is typed in insert mode set the indent for
4788 the next line to Lisp standards (well, sort of). Also happens with
4789 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4790 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4791 better. Also see 'lispwords'.
4792 The '-' character is included in keyword characters. Redefines the
4793 "=" operator to use this same indentation algorithm rather than
4794 calling an external program if 'equalprg' is empty.
4795 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004796
4797 *'lispwords'* *'lw'*
4798'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004799 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004800 {not available when compiled without the |+lispindent|
4801 feature}
4802 Comma separated list of words that influence the Lisp indenting.
4803 |'lisp'|
4804
4805 *'list'* *'nolist'*
4806'list' boolean (default off)
4807 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004808 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4809 line. Useful to see the difference between tabs and spaces and for
4810 trailing blanks. Further changed by the 'listchars' option.
4811
4812 The cursor is displayed at the start of the space a Tab character
4813 occupies, not at the end as usual in Normal mode. To get this cursor
4814 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004815 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004816<
4817 Note that list mode will also affect formatting (set with 'textwidth'
4818 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004819 changing the way tabs are displayed.
4820
4821 *'listchars'* *'lcs'*
4822'listchars' 'lcs' string (default "eol:$")
4823 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004824 Strings to use in 'list' mode and for the |:list| command. It is a
4825 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004826 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004827 eol:c Character to show at the end of each line. When
4828 omitted, there is no extra character at the end of the
4829 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004830 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004831 tab:xy[z] Two or three characters to be used to show a tab.
4832 The third character is optional.
4833
4834 tab:xy The 'x' is always used, then 'y' as many times as will
4835 fit. Thus "tab:>-" displays:
4836 >
4837 >-
4838 >--
4839 etc.
4840
4841 tab:xyz The 'z' is always used, then 'x' is prepended, and
4842 then 'y' is used as many times as will fit. Thus
4843 "tab:<->" displays:
4844 >
4845 <>
4846 <->
4847 <-->
4848 etc.
4849
4850 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004851 *lcs-space*
4852 space:c Character to show for a space. When omitted, spaces
4853 are left blank.
4854 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004855 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004856 trailing spaces are blank. Overrides the "space"
4857 setting for trailing spaces.
4858 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 extends:c Character to show in the last column, when 'wrap' is
4860 off and the line continues beyond the right of the
4861 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004862 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004863 precedes:c Character to show in the first visible column of the
4864 physical line, when there is text preceding the
4865 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004866 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004867 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004868 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004869 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004870 nbsp:c Character to show for a non-breakable space character
4871 (0xA0 (160 decimal) and U+202F). Left blank when
4872 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004873
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004874 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004876 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004877
4878 Examples: >
4879 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004880 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004881 :set lcs=extends:>,precedes:<
4882< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004883 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004884 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004885
4886 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4887'loadplugins' 'lpl' boolean (default on)
4888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004889 When on the plugin scripts are loaded when starting up |load-plugins|.
4890 This option can be reset in your |vimrc| file to disable the loading
4891 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004892 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4893 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004894
Bram Moolenaard94464e2015-11-02 15:28:18 +01004895 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004896'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004897 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004898 {only available when compiled with the |+lua/dyn|
4899 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004900 Specifies the name of the Lua shared library. The default is
4901 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004902 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004903 This option cannot be set from a |modeline| or in the |sandbox|, for
4904 security reasons.
4905
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004906 *'macatsui'* *'nomacatsui'*
4907'macatsui' boolean (default on)
4908 global
4909 {only available in Mac GUI version}
4910 This is a workaround for when drawing doesn't work properly. When set
4911 and compiled with multi-byte support ATSUI text drawing is used. When
4912 not set ATSUI text drawing is not used. Switch this option off when
4913 you experience drawing problems. In a future version the problems may
4914 be solved and this option becomes obsolete. Therefore use this method
4915 to unset it: >
4916 if exists('&macatsui')
4917 set nomacatsui
4918 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004919< Another option to check if you have drawing problems is
4920 'termencoding'.
4921
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 *'magic'* *'nomagic'*
4923'magic' boolean (default on)
4924 global
4925 Changes the special characters that can be used in search patterns.
4926 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004927 WARNING: Switching this option off most likely breaks plugins! That
4928 is because many patterns assume it's on and will fail when it's off.
4929 Only switch it off when working with old Vi scripts. In any other
4930 situation write patterns that work when 'magic' is on. Include "\M"
4931 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004932
4933 *'makeef'* *'mef'*
4934'makeef' 'mef' string (default: "")
4935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 {not available when compiled without the |+quickfix|
4937 feature}
4938 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4939 and the |:grep| command.
4940 When it is empty, an internally generated temp file will be used.
4941 When "##" is included, it is replaced by a number to make the name
4942 unique. This makes sure that the ":make" command doesn't overwrite an
4943 existing file.
4944 NOT used for the ":cf" command. See 'errorfile' for that.
4945 Environment variables are expanded |:set_env|.
4946 See |option-backslash| about including spaces and backslashes.
4947 This option cannot be set from a |modeline| or in the |sandbox|, for
4948 security reasons.
4949
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004950 *'makeencoding'* *'menc'*
4951'makeencoding' 'menc' string (default "")
4952 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004953 Encoding used for reading the output of external commands. When empty,
4954 encoding is not converted.
4955 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4956 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4957 and `:laddfile`.
4958
4959 This would be mostly useful when you use MS-Windows and set 'encoding'
4960 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4961 'makeencoding' to "char" has the same effect as setting to the system
4962 locale encoding. Example: >
4963 :set encoding=utf-8
4964 :set makeencoding=char " system locale is used
4965<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004966 *'makeprg'* *'mp'*
4967'makeprg' 'mp' string (default "make", VMS: "MMS")
4968 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004969 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004970 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4971 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004972 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004973 Environment variables are expanded |:set_env|. See |option-backslash|
4974 about including spaces and backslashes.
4975 Note that a '|' must be escaped twice: once for ":set" and once for
4976 the interpretation of a command. When you use a filter called
4977 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004978 :set makeprg=gmake\ \\\|\ myfilter
4979< The placeholder "$*" can be given (even multiple times) to specify
4980 where the arguments will be included, for example: >
4981 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4982< This option cannot be set from a |modeline| or in the |sandbox|, for
4983 security reasons.
4984
4985 *'matchpairs'* *'mps'*
4986'matchpairs' 'mps' string (default "(:),{:},[:]")
4987 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004988 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004989 other.
4990 Only character pairs are allowed that are different, thus you cannot
4991 jump between two double quotes.
4992 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004993 The pairs must be separated by a comma. Example for including '<' and
4994 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004995 :set mps+=<:>
4996
4997< A more exotic example, to jump between the '=' and ';' in an
4998 assignment, useful for languages like C and Java: >
4999 :au FileType c,cpp,java set mps+==:;
5000
5001< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005002 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003
5004 *'matchtime'* *'mat'*
5005'matchtime' 'mat' number (default 5)
5006 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005007 Tenths of a second to show the matching paren, when 'showmatch' is
5008 set. Note that this is not in milliseconds, like other options that
5009 set a time. This is to be compatible with Nvi.
5010
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005011 *'maxcombine'* *'mco'*
5012'maxcombine' 'mco' number (default 2)
5013 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005014 The maximum number of combining characters supported for displaying.
5015 Only used when 'encoding' is "utf-8".
5016 The default is OK for most languages. Hebrew may require 4.
5017 Maximum value is 6.
5018 Even when this option is set to 2 you can still edit text with more
5019 combining characters, you just can't see them. Use |g8| or |ga|.
5020 See |mbyte-combining|.
5021
Bram Moolenaar071d4272004-06-13 20:20:40 +00005022 *'maxfuncdepth'* *'mfd'*
5023'maxfuncdepth' 'mfd' number (default 100)
5024 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005025 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005026 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005027 Maximum depth of function calls for user functions. This normally
5028 catches endless recursion. When using a recursive function with
5029 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5030 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005031 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005032 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005033 See also |:function|.
5034
5035 *'maxmapdepth'* *'mmd'* *E223*
5036'maxmapdepth' 'mmd' number (default 1000)
5037 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038 Maximum number of times a mapping is done without resulting in a
5039 character to be used. This normally catches endless mappings, like
5040 ":map x y" with ":map y x". It still does not catch ":map g wg",
5041 because the 'w' is used before the next mapping is done. See also
5042 |key-mapping|.
5043
5044 *'maxmem'* *'mm'*
5045'maxmem' 'mm' number (default between 256 to 5120 (system
5046 dependent) or half the amount of memory
5047 available)
5048 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005049 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5050 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005051 other memory to be freed.
5052 The maximum usable value is about 2000000. Use this to work without a
5053 limit.
5054 The value is ignored when 'swapfile' is off.
5055 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005056
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005057 *'maxmempattern'* *'mmp'*
5058'maxmempattern' 'mmp' number (default 1000)
5059 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005060 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005061 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005062 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005063 When Vim runs into the limit it gives an error message and mostly
5064 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005065 Running into the limit often means that the pattern is very
5066 inefficient or too complex. This may already happen with the pattern
5067 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005068 Might also happen on redraw, when syntax rules try to match a complex
5069 text structure.
5070 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5071 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005072
Bram Moolenaar071d4272004-06-13 20:20:40 +00005073 *'maxmemtot'* *'mmt'*
5074'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5075 dependent) or half the amount of memory
5076 available)
5077 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005078 Maximum amount of memory in Kbyte to use for all buffers together.
5079 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005080 without a limit.
5081 On 64 bit machines higher values might work. But hey, do you really
5082 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005083 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005084 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005085 Buffers with 'swapfile' off still count to the total amount of memory
5086 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005087 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005088
5089 *'menuitems'* *'mis'*
5090'menuitems' 'mis' number (default 25)
5091 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005092 {not available when compiled without the |+menu|
5093 feature}
5094 Maximum number of items to use in a menu. Used for menus that are
5095 generated from a list of items, e.g., the Buffers menu. Changing this
5096 option has no direct effect, the menu must be refreshed first.
5097
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005098 *'mkspellmem'* *'msm'*
5099'mkspellmem' 'msm' string (default "460000,2000,500")
5100 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005101 {not available when compiled without the |+syntax|
5102 feature}
5103 Parameters for |:mkspell|. This tunes when to start compressing the
5104 word tree. Compression can be slow when there are many words, but
5105 it's needed to avoid running out of memory. The amount of memory used
5106 per word depends very much on how similar the words are, that's why
5107 this tuning is complicated.
5108
5109 There are three numbers, separated by commas:
5110 {start},{inc},{added}
5111
5112 For most languages the uncompressed word tree fits in memory. {start}
5113 gives the amount of memory in Kbyte that can be used before any
5114 compression is done. It should be a bit smaller than the amount of
5115 memory that is available to Vim.
5116
5117 When going over the {start} limit the {inc} number specifies the
5118 amount of memory in Kbyte that can be allocated before another
5119 compression is done. A low number means compression is done after
5120 less words are added, which is slow. A high number means more memory
5121 will be allocated.
5122
5123 After doing compression, {added} times 1024 words can be added before
5124 the {inc} limit is ignored and compression is done when any extra
5125 amount of memory is needed. A low number means there is a smaller
5126 chance of hitting the {inc} limit, less memory is used but it's
5127 slower.
5128
5129 The languages for which these numbers are important are Italian and
5130 Hungarian. The default works for when you have about 512 Mbyte. If
5131 you have 1 Gbyte you could use: >
5132 :set mkspellmem=900000,3000,800
5133< If you have less than 512 Mbyte |:mkspell| may fail for some
5134 languages, no matter what you set 'mkspellmem' to.
5135
Bram Moolenaar07607392019-05-26 19:20:43 +02005136 This option cannot be set from a |modeline| or in the |sandbox|.
5137
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005139'modeline' 'ml' boolean (Vim default: on (off for root),
5140 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005142 If 'modeline' is on 'modelines' gives the number of lines that is
5143 checked for set commands. If 'modeline' is off or 'modelines' is zero
5144 no lines are checked. See |modeline|.
5145
5146 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5147'modelineexpr' 'mle' boolean (default: off)
5148 global
5149 When on allow some options that are an expression to be set in the
5150 modeline. Check the option for whether it is affected by
5151 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005152 This option cannot be set from a |modeline| or in the |sandbox|, for
5153 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005154
Bram Moolenaar071d4272004-06-13 20:20:40 +00005155 *'modelines'* *'mls'*
5156'modelines' 'mls' number (default 5)
5157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005158 If 'modeline' is on 'modelines' gives the number of lines that is
5159 checked for set commands. If 'modeline' is off or 'modelines' is zero
5160 no lines are checked. See |modeline|.
5161 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5162 set and to the Vim default value when 'compatible' is reset.
5163
5164 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005165 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166'modifiable' 'ma' boolean (default on)
5167 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005168 When off the buffer contents cannot be changed. The 'fileformat' and
5169 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005170 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005171
5172 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5173'modified' 'mod' boolean (default off)
5174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005175 When on, the buffer is considered to be modified. This option is set
5176 when:
5177 1. A change was made to the text since it was last written. Using the
5178 |undo| command to go back to the original text will reset the
5179 option. But undoing changes that were made before writing the
5180 buffer will set the option again, since the text is different from
5181 when it was written.
5182 2. 'fileformat' or 'fileencoding' is different from its original
5183 value. The original value is set when the buffer is read or
5184 written. A ":set nomodified" command also resets the original
5185 values to the current values and the 'modified' option will be
5186 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005187 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005188 This option is not set when a change is made to the buffer as the
5189 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5190 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5191 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5193 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005194 Note that the text may actually be the same, e.g. 'modified' is set
5195 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196
5197 *'more'* *'nomore'*
5198'more' boolean (Vim default: on, Vi default: off)
5199 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 When on, listings pause when the whole screen is filled. You will get
5201 the |more-prompt|. When this option is off there are no pauses, the
5202 listing continues until finished.
5203 NOTE: This option is set to the Vi default value when 'compatible' is
5204 set and to the Vim default value when 'compatible' is reset.
5205
5206 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005207'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005208 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 global
Bram Moolenaar5b418992019-10-27 18:50:25 +01005210 Enable the use of the mouse. Works for most terminals (xterm, MS-DOS,
5211 Win32 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux
5212 console with gpm). For using the mouse in the GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005214 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005215 v Visual mode
5216 i Insert mode
5217 c Command-line mode
5218 h all previous modes when editing a help file
5219 a all previous modes
5220 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005221 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005222 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005223< If your terminal can't overrule the mouse events going to the
5224 application, use: >
5225 :set mouse=nvi
5226< The you can press ":", select text for the system, and press Esc to go
5227 back to Vim using the mouse events.
5228 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5229 "xterm".
5230
5231 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005232 modeless selection. This doesn't move the text cursor.
5233
5234 See |mouse-using|. Also see |'clipboard'|.
5235
5236 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005237 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005238 the mouse buttons can still be used by keeping the shift key pressed.
5239 Also see the 'clipboard' option.
5240
5241 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5242'mousefocus' 'mousef' boolean (default off)
5243 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005244 {only works in the GUI}
5245 The window that the mouse pointer is on is automatically activated.
5246 When changing the window layout or window focus in another way, the
5247 mouse pointer is moved to the window with keyboard focus. Off is the
5248 default because it makes using the pull down menus a little goofy, as
5249 a pointer transit may activate a window unintentionally.
5250
5251 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5252'mousehide' 'mh' boolean (default on)
5253 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005254 {only works in the GUI}
5255 When on, the mouse pointer is hidden when characters are typed.
5256 The mouse pointer is restored when the mouse is moved.
5257
5258 *'mousemodel'* *'mousem'*
5259'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 Sets the model to use for the mouse. The name mostly specifies what
5262 the right mouse button is used for:
5263 extend Right mouse button extends a selection. This works
5264 like in an xterm.
5265 popup Right mouse button pops up a menu. The shifted left
5266 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005267 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005268 popup_setpos Like "popup", but the cursor will be moved to the
5269 position where the mouse was clicked, and thus the
5270 selected operation will act upon the clicked object.
5271 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005272 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 course, that right clicking outside a selection will
5274 end Visual mode.
5275 Overview of what button does what for each model:
5276 mouse extend popup(_setpos) ~
5277 left click place cursor place cursor
5278 left drag start selection start selection
5279 shift-left search word extend selection
5280 right click extend selection popup menu (place cursor)
5281 right drag extend selection -
5282 middle click paste paste
5283
5284 In the "popup" model the right mouse button produces a pop-up menu.
5285 You need to define this first, see |popup-menu|.
5286
5287 Note that you can further refine the meaning of buttons with mappings.
5288 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5289 selection (because that's handled in the GUI code directly).
5290
5291 The 'mousemodel' option is set by the |:behave| command.
5292
5293 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005294'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5295 vs:leftright,vd:lrsizing,m:no,
5296 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005298 {only available when compiled with the |+mouseshape|
5299 feature}
5300 This option tells Vim what the mouse pointer should look like in
5301 different modes. The option is a comma separated list of parts, much
5302 like used for 'guicursor'. Each part consist of a mode/location-list
5303 and an argument-list:
5304 mode-list:shape,mode-list:shape,..
5305 The mode-list is a dash separated list of these modes/locations:
5306 In a normal window: ~
5307 n Normal mode
5308 v Visual mode
5309 ve Visual mode with 'selection' "exclusive" (same as 'v',
5310 if not specified)
5311 o Operator-pending mode
5312 i Insert mode
5313 r Replace mode
5314
5315 Others: ~
5316 c appending to the command-line
5317 ci inserting in the command-line
5318 cr replacing in the command-line
5319 m at the 'Hit ENTER' or 'More' prompts
5320 ml idem, but cursor in the last line
5321 e any mode, pointer below last window
5322 s any mode, pointer on a status line
5323 sd any mode, while dragging a status line
5324 vs any mode, pointer on a vertical separator line
5325 vd any mode, while dragging a vertical separator line
5326 a everywhere
5327
5328 The shape is one of the following:
5329 avail name looks like ~
5330 w x arrow Normal mouse pointer
5331 w x blank no pointer at all (use with care!)
5332 w x beam I-beam
5333 w x updown up-down sizing arrows
5334 w x leftright left-right sizing arrows
5335 w x busy The system's usual busy pointer
5336 w x no The system's usual 'no input' pointer
5337 x udsizing indicates up-down resizing
5338 x lrsizing indicates left-right resizing
5339 x crosshair like a big thin +
5340 x hand1 black hand
5341 x hand2 white hand
5342 x pencil what you write with
5343 x question big ?
5344 x rightup-arrow arrow pointing right-up
5345 w x up-arrow arrow pointing up
5346 x <number> any X11 pointer number (see X11/cursorfont.h)
5347
5348 The "avail" column contains a 'w' if the shape is available for Win32,
5349 x for X11.
5350 Any modes not specified or shapes not available use the normal mouse
5351 pointer.
5352
5353 Example: >
5354 :set mouseshape=s:udsizing,m:no
5355< will make the mouse turn to a sizing arrow over the status lines and
5356 indicate no input when the hit-enter prompt is displayed (since
5357 clicking the mouse has no effect in this state.)
5358
5359 *'mousetime'* *'mouset'*
5360'mousetime' 'mouset' number (default 500)
5361 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005362 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5363 time in msec between two mouse clicks for the second click to be
5364 recognized as a multi click.
5365
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005366 *'mzschemedll'*
5367'mzschemedll' string (default depends on the build)
5368 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005369 {only available when compiled with the |+mzscheme/dyn|
5370 feature}
5371 Specifies the name of the MzScheme shared library. The default is
5372 DYNAMIC_MZSCH_DLL which was specified at compile time.
5373 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005374 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005375 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005376 This option cannot be set from a |modeline| or in the |sandbox|, for
5377 security reasons.
5378
5379 *'mzschemegcdll'*
5380'mzschemegcdll' string (default depends on the build)
5381 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005382 {only available when compiled with the |+mzscheme/dyn|
5383 feature}
5384 Specifies the name of the MzScheme GC shared library. The default is
5385 DYNAMIC_MZGC_DLL which was specified at compile time.
5386 The value can be equal to 'mzschemedll' if it includes the GC code.
5387 Environment variables are expanded |:set_env|.
5388 This option cannot be set from a |modeline| or in the |sandbox|, for
5389 security reasons.
5390
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005391 *'mzquantum'* *'mzq'*
5392'mzquantum' 'mzq' number (default 100)
5393 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005394 {not available when compiled without the |+mzscheme|
5395 feature}
5396 The number of milliseconds between polls for MzScheme threads.
5397 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005398 NOTE: This option is set to the Vim default value when 'compatible'
5399 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005400
Bram Moolenaar071d4272004-06-13 20:20:40 +00005401 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005402'nrformats' 'nf' string (default "bin,octal,hex",
5403 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005405 This defines what bases Vim will consider for numbers when using the
5406 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5407 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005408 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005409 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005410 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005411 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005413 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005414 considered to be hexadecimal. Example: Using CTRL-X on
5415 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005416 bin If included, numbers starting with "0b" or "0B" will be
5417 considered to be binary. Example: Using CTRL-X on
5418 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005419 Numbers which simply begin with a digit in the range 1-9 are always
5420 considered decimal. This also happens for numbers that are not
5421 recognized as octal or hex.
5422
5423 *'number'* *'nu'* *'nonumber'* *'nonu'*
5424'number' 'nu' boolean (default off)
5425 local to window
5426 Print the line number in front of each line. When the 'n' option is
5427 excluded from 'cpoptions' a wrapped line will not use the column of
5428 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005429 The 'numberwidth' option can be used to set the room used for the line
5430 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005431 When a long, wrapped line doesn't start with the first character, '-'
5432 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005433 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5434 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005435 *number_relativenumber*
5436 The 'relativenumber' option changes the displayed number to be
5437 relative to the cursor. Together with 'number' there are these
5438 four combinations (cursor in line 3):
5439
Bram Moolenaar3848e002016-03-19 18:42:29 +01005440 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005441 'nornu' 'nornu' 'rnu' 'rnu'
5442
5443 |apple | 1 apple | 2 apple | 2 apple
5444 |pear | 2 pear | 1 pear | 1 pear
5445 |nobody | 3 nobody | 0 nobody |3 nobody
5446 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005447
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005448 *'numberwidth'* *'nuw'*
5449'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5450 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005451 {only available when compiled with the |+linebreak|
5452 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005453 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005454 when the 'number' or 'relativenumber' option is set or printing lines
5455 with a line number. Since one space is always between the number and
5456 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005457 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005458 fit the highest line number in the buffer respectively the number of
5459 rows in the window, depending on whether 'number' or 'relativenumber'
5460 is set. Thus with the Vim default of 4 there is room for a line number
5461 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005462 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005463 NOTE: This option is set to the Vi default value when 'compatible' is
5464 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005465
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005466 *'omnifunc'* *'ofu'*
5467'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005468 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005469 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005470 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005471 This option specifies a function to be used for Insert mode omni
5472 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005473 See |complete-functions| for an explanation of how the function is
5474 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005475 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005476 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005477 This option cannot be set from a |modeline| or in the |sandbox|, for
5478 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005479
5480
Bram Moolenaar02467872007-05-06 13:22:01 +00005481 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005482'opendevice' 'odev' boolean (default off)
5483 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005484 {only for MS-DOS, MS-Windows and OS/2}
5485 Enable reading and writing from devices. This may get Vim stuck on a
5486 device that can be opened but doesn't actually do the I/O. Therefore
5487 it is off by default.
5488 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5489 result in editing a device.
5490
5491
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005492 *'operatorfunc'* *'opfunc'*
5493'operatorfunc' 'opfunc' string (default: empty)
5494 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005495 This option specifies a function to be called by the |g@| operator.
5496 See |:map-operator| for more info and an example.
5497
5498 This option cannot be set from a |modeline| or in the |sandbox|, for
5499 security reasons.
5500
5501
Bram Moolenaar251e1912011-06-19 05:09:16 +02005502 *'osfiletype'* *'oft'*
5503'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005504 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005505 This option was supported on RISC OS, which has been removed.
5506
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005508 *'packpath'* *'pp'*
5509'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005510 Directories used to find packages. See |packages|.
5511
5512
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005514'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 global
5516 Specifies the nroff macros that separate paragraphs. These are pairs
5517 of two letters (see |object-motions|).
5518
5519 *'paste'* *'nopaste'*
5520'paste' boolean (default off)
5521 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005522 Put Vim in Paste mode. This is useful if you want to cut or copy
5523 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 unexpected effects.
5525 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005526 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 knows about pasting and will mostly do the right thing without 'paste'
5528 being set. The same is true for a terminal where Vim handles the
5529 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005530 This option is reset when starting the GUI. Thus if you set it in
5531 your .vimrc it will work in a terminal, but not in the GUI. Setting
5532 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5533 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005534 When the 'paste' option is switched on (also when it was already on):
5535 - mapping in Insert mode and Command-line mode is disabled
5536 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005538 - 'expandtab' is reset
5539 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 - 'revins' is reset
5541 - 'ruler' is reset
5542 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005543 - 'smartindent' is reset
5544 - 'smarttab' is reset
5545 - 'softtabstop' is set to 0
5546 - 'textwidth' is set to 0
5547 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005549 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005550 - 'indentexpr'
5551 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 NOTE: When you start editing another file while the 'paste' option is
5553 on, settings from the modelines or autocommands may change the
5554 settings again, causing trouble when pasting text. You might want to
5555 set the 'paste' option again.
5556 When the 'paste' option is reset the mentioned options are restored to
5557 the value before the moment 'paste' was switched from off to on.
5558 Resetting 'paste' before ever setting it does not have any effect.
5559 Since mapping doesn't work while 'paste' is active, you need to use
5560 the 'pastetoggle' option to toggle the 'paste' option with some key.
5561
5562 *'pastetoggle'* *'pt'*
5563'pastetoggle' 'pt' string (default "")
5564 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005565 When non-empty, specifies the key sequence that toggles the 'paste'
5566 option. This is like specifying a mapping: >
5567 :map {keys} :set invpaste<CR>
5568< Where {keys} is the value of 'pastetoggle'.
5569 The difference is that it will work even when 'paste' is set.
5570 'pastetoggle' works in Insert mode and Normal mode, but not in
5571 Command-line mode.
5572 Mappings are checked first, thus overrule 'pastetoggle'. However,
5573 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5574 this: >
5575 :map <F10> :set paste<CR>
5576 :map <F11> :set nopaste<CR>
5577 :imap <F10> <C-O>:set paste<CR>
5578 :imap <F11> <nop>
5579 :set pastetoggle=<F11>
5580< This will make <F10> start paste mode and <F11> stop paste mode.
5581 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5582 mode everything is inserted literally, except the 'pastetoggle' key
5583 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005584 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005585
5586 *'pex'* *'patchexpr'*
5587'patchexpr' 'pex' string (default "")
5588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005589 {not available when compiled without the |+diff|
5590 feature}
5591 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005592 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005593
Bram Moolenaardbc28022014-07-26 13:40:44 +02005594 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005595'patchmode' 'pm' string (default "")
5596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005597 When non-empty the oldest version of a file is kept. This can be used
5598 to keep the original version of a file if you are changing files in a
5599 source distribution. Only the first time that a file is written a
5600 copy of the original file will be kept. The name of the copy is the
5601 name of the original file with the string in the 'patchmode' option
5602 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005603 ".orig" or ".org". 'backupdir' must not be empty for this to work
5604 (Detail: The backup file is renamed to the patchmode file after the
5605 new file has been successfully written, that's why it must be possible
5606 to write a backup file). If there was no file to be backed up, an
5607 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005608 When the 'backupskip' pattern matches, a patchmode file is not made.
5609 Using 'patchmode' for compressed files appends the extension at the
5610 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5611 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005612 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005613
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005614 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615'path' 'pa' string (default on Unix: ".,/usr/include,,"
5616 on OS/2: ".,/emx/include,,"
5617 other systems: ".,,")
5618 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005620 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5621 provided that the file being searched for has a relative path (not
5622 starting with "/", "./" or "../"). The directories in the 'path'
5623 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005624 - Use commas to separate directory names: >
5625 :set path=.,/usr/local/include,/usr/include
5626< - Spaces can also be used to separate directory names (for backwards
5627 compatibility with version 3.0). To have a space in a directory
5628 name, precede it with an extra backslash, and escape the space: >
5629 :set path=.,/dir/with\\\ space
5630< - To include a comma in a directory name precede it with an extra
5631 backslash: >
5632 :set path=.,/dir/with\\,comma
5633< - To search relative to the directory of the current file, use: >
5634 :set path=.
5635< - To search in the current directory use an empty string between two
5636 commas: >
5637 :set path=,,
5638< - A directory name may end in a ':' or '/'.
5639 - Environment variables are expanded |:set_env|.
5640 - When using |netrw.vim| URLs can be used. For example, adding
5641 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005642 - Search upwards and downwards in a directory tree using "*", "**" and
5643 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005644 {not available when compiled without the |+path_extra| feature}
5645 - Careful with '\' characters, type two to get one in the option: >
5646 :set path=.,c:\\include
5647< Or just use '/' instead: >
5648 :set path=.,c:/include
5649< Don't forget "." or files won't even be found in the same directory as
5650 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005651 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005652 it is something like 256 or 1024 characters.
5653 You can check if all the include files are found, using the value of
5654 'path', see |:checkpath|.
5655 The use of |:set+=| and |:set-=| is preferred when adding or removing
5656 directories from the list. This avoids problems when a future version
5657 uses another default. To remove the current directory use: >
5658 :set path-=
5659< To add the current directory use: >
5660 :set path+=
5661< To use an environment variable, you probably need to replace the
5662 separator. Here is an example to append $INCL, in which directory
5663 names are separated with a semi-colon: >
5664 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5665< Replace the ';' with a ':' or whatever separator is used. Note that
5666 this doesn't work when $INCL contains a comma or white space.
5667
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005668 *'perldll'*
5669'perldll' string (default depends on the build)
5670 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005671 {only available when compiled with the |+perl/dyn|
5672 feature}
5673 Specifies the name of the Perl shared library. The default is
5674 DYNAMIC_PERL_DLL, which was specified at compile time.
5675 Environment variables are expanded |:set_env|.
5676 This option cannot be set from a |modeline| or in the |sandbox|, for
5677 security reasons.
5678
Bram Moolenaar071d4272004-06-13 20:20:40 +00005679 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5680'preserveindent' 'pi' boolean (default off)
5681 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 When changing the indent of the current line, preserve as much of the
5683 indent structure as possible. Normally the indent is replaced by a
5684 series of tabs followed by spaces as required (unless |'expandtab'| is
5685 enabled, in which case only spaces are used). Enabling this option
5686 means the indent will preserve as many existing characters as possible
5687 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005688 'expandtab' does not apply to the preserved white space, a Tab remains
5689 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005690 NOTE: When using ">>" multiple times the resulting indent is a mix of
5691 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005692 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 Also see 'copyindent'.
5694 Use |:retab| to clean up white space.
5695
5696 *'previewheight'* *'pvh'*
5697'previewheight' 'pvh' number (default 12)
5698 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005699 {not available when compiled without the |+quickfix|
5700 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005702 commands. Used for |CTRL-W_}| when no count is given. Not used when
5703 'previewpopup' is set.
5704
5705 *'previewpopup'* *'pvp'*
5706'previewpopup' 'pvp' string (default empty)
5707 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005708 {not available when compiled without the |+textprop|
5709 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005710 When not empty a popup window is used for commands that would open a
5711 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005712 Not used for the insert completion info, add "popup" to
5713 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005714
5715 *'previewwindow'* *'nopreviewwindow'*
5716 *'pvw'* *'nopvw'* *E590*
5717'previewwindow' 'pvw' boolean (default off)
5718 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005719 {not available when compiled without the |+quickfix|
5720 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005721 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005722 set. It's normally not set directly, but by using one of the commands
5723 |:ptag|, |:pedit|, etc.
5724
5725 *'printdevice'* *'pdev'*
5726'printdevice' 'pdev' string (default empty)
5727 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005728 {only available when compiled with the |+printer|
5729 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005730 The name of the printer to be used for |:hardcopy|.
5731 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005732 This option cannot be set from a |modeline| or in the |sandbox|, for
5733 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005734
Bram Moolenaar8299df92004-07-10 09:47:34 +00005735 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005736'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005738 {only available when compiled with the |+printer|
5739 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005740 Sets the character encoding used when printing.
5741 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005742
5743 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005744'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005746 {only available when compiled with the |+printer|
5747 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005748 Expression used to print the PostScript produced with |:hardcopy|.
5749 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005750 This option cannot be set from a |modeline| or in the |sandbox|, for
5751 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005752
Bram Moolenaar8299df92004-07-10 09:47:34 +00005753 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754'printfont' 'pfn' string (default "courier")
5755 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005756 {only available when compiled with the |+printer|
5757 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005758 The name of the font that will be used for |:hardcopy|.
5759 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005760
5761 *'printheader'* *'pheader'*
5762'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005764 {only available when compiled with the |+printer|
5765 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005766 The format of the header produced in |:hardcopy| output.
5767 See |pheader-option|.
5768
5769 *'printmbcharset'* *'pmbcs'*
5770'printmbcharset' 'pmbcs' string (default "")
5771 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005772 {only available when compiled with the |+printer|
5773 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005774 The CJK character set to be used for CJK output from |:hardcopy|.
5775 See |pmbcs-option|.
5776
5777 *'printmbfont'* *'pmbfn'*
5778'printmbfont' 'pmbfn' string (default "")
5779 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005780 {only available when compiled with the |+printer|
5781 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005782 List of font names to be used for CJK output from |:hardcopy|.
5783 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005784
5785 *'printoptions'* *'popt'*
5786'printoptions' 'popt' string (default "")
5787 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005788 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005789 List of items that control the format of the output of |:hardcopy|.
5790 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005792 *'prompt'* *'noprompt'*
5793'prompt' boolean (default on)
5794 global
5795 When on a ":" prompt is used in Ex mode.
5796
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005797 *'pumheight'* *'ph'*
5798'pumheight' 'ph' number (default 0)
5799 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005800 Determines the maximum number of items to show in the popup menu for
5801 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005802 |ins-completion-menu|.
5803
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005804 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005805'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005806 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005807 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005808 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005809
Bram Moolenaard94464e2015-11-02 15:28:18 +01005810 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005811'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005812 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005813 {only available when compiled with the |+python/dyn|
5814 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005815 Specifies the name of the Python 2.x shared library. The default is
5816 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005817 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005818 This option cannot be set from a |modeline| or in the |sandbox|, for
5819 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005820
Bram Moolenaar94073162018-01-31 21:49:05 +01005821 *'pythonhome'*
5822'pythonhome' string (default "")
5823 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005824 {only available when compiled with the |+python/dyn|
5825 feature}
5826 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5827 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5828 which was specified at compile time, will be used for the Python 2.x
5829 home directory.
5830 Environment variables are expanded |:set_env|.
5831 This option cannot be set from a |modeline| or in the |sandbox|, for
5832 security reasons.
5833
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005834 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005835'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005836 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005837 {only available when compiled with the |+python3/dyn|
5838 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005839 Specifies the name of the Python 3 shared library. The default is
5840 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005841 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005842 This option cannot be set from a |modeline| or in the |sandbox|, for
5843 security reasons.
5844
Bram Moolenaar94073162018-01-31 21:49:05 +01005845 *'pythonthreehome'*
5846'pythonthreehome' string (default "")
5847 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005848 {only available when compiled with the |+python3/dyn|
5849 feature}
5850 Specifies the name of the Python 3 home directory. When
5851 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5852 PYTHON3_HOME, which was specified at compile time, will be used for
5853 the Python 3 home directory.
5854 Environment variables are expanded |:set_env|.
5855 This option cannot be set from a |modeline| or in the |sandbox|, for
5856 security reasons.
5857
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005858 *'pyxversion'* *'pyx'*
5859'pyxversion' 'pyx' number (default depends on the build)
5860 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005861 {only available when compiled with the |+python| or
5862 the |+python3| feature}
5863 Specifies the python version used for pyx* functions and commands
5864 |python_x|. The default value is as follows:
5865
5866 Compiled with Default ~
5867 |+python| and |+python3| 0
5868 only |+python| 2
5869 only |+python3| 3
5870
5871 Available values are 0, 2 and 3.
5872 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5873 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5874 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5875 to 2 if Python 2 is available.
5876 See also: |has-pythonx|
5877
5878 If Vim is compiled with only |+python| or |+python3| setting
5879 'pyxversion' has no effect. The pyx* functions and commands are
5880 always the same as the compiled version.
5881
5882 This option cannot be set from a |modeline| or in the |sandbox|, for
5883 security reasons.
5884
Bram Moolenaar677ee682005-01-27 14:41:15 +00005885 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005886'quoteescape' 'qe' string (default "\")
5887 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005888 The characters that are used to escape quotes in a string. Used for
5889 objects like a', a" and a` |a'|.
5890 When one of the characters in this option is found inside a string,
5891 the following character will be skipped. The default value makes the
5892 text "foo\"bar\\" considered to be one string.
5893
Bram Moolenaar071d4272004-06-13 20:20:40 +00005894 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5895'readonly' 'ro' boolean (default off)
5896 local to buffer
5897 If on, writes fail unless you use a '!'. Protects you from
5898 accidentally overwriting a file. Default on when Vim is started
5899 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005900 When using ":w!" the 'readonly' option is reset for the current
5901 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005902 When using the ":view" command the 'readonly' option is set for the
5903 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005904 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005905
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005906 *'redrawtime'* *'rdt'*
5907'redrawtime' 'rdt' number (default 2000)
5908 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005909 {only available when compiled with the |+reltime|
5910 feature}
5911 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005912 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005913 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005914 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005915 matches will be highlighted.
5916 For syntax highlighting the time applies per window. When over the
5917 limit syntax highlighting is disabled until |CTRL-L| is used.
5918 This is used to avoid that Vim hangs when using a very complicated
5919 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005920
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005921 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005922'regexpengine' 're' number (default 0)
5923 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005924 This selects the default regexp engine. |two-engines|
5925 The possible values are:
5926 0 automatic selection
5927 1 old engine
5928 2 NFA engine
5929 Note that when using the NFA engine and the pattern contains something
5930 that is not supported the pattern will not match. This is only useful
5931 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005932 Using automatic selection enables Vim to switch the engine, if the
5933 default engine becomes too costly. E.g., when the NFA engine uses too
5934 many states. This should prevent Vim from hanging on a combination of
5935 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005936
Bram Moolenaar64486672010-05-16 15:46:46 +02005937 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5938'relativenumber' 'rnu' boolean (default off)
5939 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005940 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005941 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005942 precede some vertical motion commands (e.g. j k + -) with, without
5943 having to calculate it yourself. Especially useful in combination with
5944 other commands (e.g. y d c < > gq gw =).
5945 When the 'n' option is excluded from 'cpoptions' a wrapped
5946 line will not use the column of line numbers (this is the default when
5947 'compatible' isn't set).
5948 The 'numberwidth' option can be used to set the room used for the line
5949 number.
5950 When a long, wrapped line doesn't start with the first character, '-'
5951 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005952 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5953 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005954
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005955 The number in front of the cursor line also depends on the value of
5956 'number', see |number_relativenumber| for all combinations of the two
5957 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005958
Bram Moolenaar071d4272004-06-13 20:20:40 +00005959 *'remap'* *'noremap'*
5960'remap' boolean (default on)
5961 global
5962 Allows for mappings to work recursively. If you do not want this for
5963 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005964 NOTE: To avoid portability problems with Vim scripts, always keep
5965 this option at the default "on". Only switch it off when working with
5966 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005967
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005968 *'renderoptions'* *'rop'*
5969'renderoptions' 'rop' string (default: empty)
5970 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005971 {only available when compiled with GUI and DIRECTX on
5972 MS-Windows}
5973 Select a text renderer and set its options. The options depend on the
5974 renderer.
5975
5976 Syntax: >
5977 set rop=type:{renderer}(,{name}:{value})*
5978<
5979 Currently, only one optional renderer is available.
5980
5981 render behavior ~
5982 directx Vim will draw text using DirectX (DirectWrite). It makes
5983 drawn glyphs more beautiful than default GDI.
5984 It requires 'encoding' is "utf-8", and only works on
5985 MS-Windows Vista or newer version.
5986
5987 Options:
5988 name meaning type value ~
5989 gamma gamma float 1.0 - 2.2 (maybe)
5990 contrast enhancedContrast float (unknown)
5991 level clearTypeLevel float (unknown)
5992 geom pixelGeometry int 0 - 2 (see below)
5993 renmode renderingMode int 0 - 6 (see below)
5994 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005995 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005996
Bram Moolenaar92467d32017-12-05 13:22:16 +01005997 See this URL for detail (except for scrlines):
5998 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005999
6000 For geom: structure of a device pixel.
6001 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6002 1 - DWRITE_PIXEL_GEOMETRY_RGB
6003 2 - DWRITE_PIXEL_GEOMETRY_BGR
6004
6005 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006006 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006007
6008 For renmode: method of rendering glyphs.
6009 0 - DWRITE_RENDERING_MODE_DEFAULT
6010 1 - DWRITE_RENDERING_MODE_ALIASED
6011 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6012 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6013 4 - DWRITE_RENDERING_MODE_NATURAL
6014 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6015 6 - DWRITE_RENDERING_MODE_OUTLINE
6016
6017 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006018 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006019
6020 For taamode: antialiasing mode used for drawing text.
6021 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6022 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6023 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6024 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6025
6026 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006027 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6028
Bram Moolenaara338adc2018-01-31 20:51:47 +01006029 For scrlines:
6030 This was used for optimizing scrolling behavior, however this
6031 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006032
6033 Example: >
6034 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006035 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006036 set rop=type:directx
6037<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006038 If select a raster font (Courier, Terminal or FixedSys which
6039 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006040 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006041
6042 NOTE: It is known that some fonts and options combination
6043 causes trouble on drawing glyphs.
6044
Bram Moolenaar92467d32017-12-05 13:22:16 +01006045 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006046 special made fonts (True-Type fonts which includes only
6047 bitmap glyphs).
6048 - 'taamode:3' will not work with some vector fonts.
6049
6050 NOTE: With this option, you can display colored emoji
6051 (emoticon) in Windows 8.1 or later. To display colored emoji,
6052 there are some conditions which you should notice.
6053
6054 - If your font includes non-colored emoji already, it will
6055 be used.
6056 - If your font doesn't have emoji, the system chooses an
6057 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6058 will be used.
6059 - When this alternative font didn't have fixed width glyph,
6060 emoji might be rendered beyond the bounding box of drawing
6061 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006062
6063 Other render types are currently not supported.
6064
Bram Moolenaar071d4272004-06-13 20:20:40 +00006065 *'report'*
6066'report' number (default 2)
6067 global
6068 Threshold for reporting number of lines changed. When the number of
6069 changed lines is more than 'report' a message will be given for most
6070 ":" commands. If you want it always, set 'report' to 0.
6071 For the ":substitute" command the number of substitutions is used
6072 instead of the number of lines.
6073
6074 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6075'restorescreen' 'rs' boolean (default on)
6076 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006077 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 When set, the screen contents is restored when exiting Vim. This also
6079 happens when executing external commands.
6080
6081 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6082 options in your .vimrc. To disable restoring:
6083 set t_ti= t_te=
6084 To enable restoring (for an xterm):
6085 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6086 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6087
6088 *'revins'* *'ri'* *'norevins'* *'nori'*
6089'revins' 'ri' boolean (default off)
6090 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091 {only available when compiled with the |+rightleft|
6092 feature}
6093 Inserting characters in Insert mode will work backwards. See "typing
6094 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6095 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006096 NOTE: This option is reset when 'compatible' is set.
6097 This option is reset when 'paste' is set and restored when 'paste' is
6098 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006099
6100 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6101'rightleft' 'rl' boolean (default off)
6102 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006103 {only available when compiled with the |+rightleft|
6104 feature}
6105 When on, display orientation becomes right-to-left, i.e., characters
6106 that are stored in the file appear from the right to the left.
6107 Using this option, it is possible to edit files for languages that
6108 are written from the right to the left such as Hebrew and Arabic.
6109 This option is per window, so it is possible to edit mixed files
6110 simultaneously, or to view the same file in both ways (this is
6111 useful whenever you have a mixed text file with both right-to-left
6112 and left-to-right strings so that both sets are displayed properly
6113 in different windows). Also see |rileft.txt|.
6114
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006115 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116'rightleftcmd' 'rlc' string (default "search")
6117 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 {only available when compiled with the |+rightleft|
6119 feature}
6120 Each word in this option enables the command line editing to work in
6121 right-to-left mode for a group of commands:
6122
6123 search "/" and "?" commands
6124
6125 This is useful for languages such as Hebrew, Arabic and Farsi.
6126 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6127
Bram Moolenaard94464e2015-11-02 15:28:18 +01006128 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006129'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006130 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006131 {only available when compiled with the |+ruby/dyn|
6132 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006133 Specifies the name of the Ruby shared library. The default is
6134 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006135 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006136 This option cannot be set from a |modeline| or in the |sandbox|, for
6137 security reasons.
6138
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006140'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 {not available when compiled without the
6143 |+cmdline_info| feature}
6144 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006145 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 text in the file is shown on the far right:
6147 Top first line is visible
6148 Bot last line is visible
6149 All first and last line are visible
6150 45% relative position in the file
6151 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006152 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006154 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006155 this option takes precedence over 'ruler' and 'rulerformat'
6156 If the number of characters displayed is different from the number of
6157 bytes in the text (e.g., for a TAB or a multi-byte character), both
6158 the text column (byte number) and the screen column are shown,
6159 separated with a dash.
6160 For an empty line "0-1" is shown.
6161 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006162 This option is reset when 'paste' is set and restored when 'paste' is
6163 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006164 If you don't want to see the ruler all the time but want to know where
6165 you are, use "g CTRL-G" |g_CTRL-G|.
6166 NOTE: This option is reset when 'compatible' is set.
6167
6168 *'rulerformat'* *'ruf'*
6169'rulerformat' 'ruf' string (default empty)
6170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006171 {not available when compiled without the |+statusline|
6172 feature}
6173 When this option is not empty, it determines the content of the ruler
6174 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006175 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006176 This option cannot be set in a modeline when 'modelineexpr' is off.
6177
Bram Moolenaar071d4272004-06-13 20:20:40 +00006178 The default ruler width is 17 characters. To make the ruler 15
6179 characters wide, put "%15(" at the start and "%)" at the end.
6180 Example: >
6181 :set rulerformat=%15(%c%V\ %p%%%)
6182<
6183 *'runtimepath'* *'rtp'* *vimfiles*
6184'runtimepath' 'rtp' string (default:
6185 Unix: "$HOME/.vim,
6186 $VIM/vimfiles,
6187 $VIMRUNTIME,
6188 $VIM/vimfiles/after,
6189 $HOME/.vim/after"
6190 Amiga: "home:vimfiles,
6191 $VIM/vimfiles,
6192 $VIMRUNTIME,
6193 $VIM/vimfiles/after,
6194 home:vimfiles/after"
6195 PC, OS/2: "$HOME/vimfiles,
6196 $VIM/vimfiles,
6197 $VIMRUNTIME,
6198 $VIM/vimfiles/after,
6199 $HOME/vimfiles/after"
6200 Macintosh: "$VIM:vimfiles,
6201 $VIMRUNTIME,
6202 $VIM:vimfiles:after"
6203 RISC-OS: "Choices:vimfiles,
6204 $VIMRUNTIME,
6205 Choices:vimfiles/after"
6206 VMS: "sys$login:vimfiles,
6207 $VIM/vimfiles,
6208 $VIMRUNTIME,
6209 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006210 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006211 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006212 This is a list of directories which will be searched for runtime
6213 files:
6214 filetype.vim filetypes by file name |new-filetype|
6215 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006216 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 colors/ color scheme files |:colorscheme|
6218 compiler/ compiler files |:compiler|
6219 doc/ documentation |write-local-help|
6220 ftplugin/ filetype plugins |write-filetype-plugin|
6221 indent/ indent scripts |indent-expression|
6222 keymap/ key mapping files |mbyte-keymap|
6223 lang/ menu translations |:menutrans|
6224 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006225 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 plugin/ plugin scripts |write-plugin|
6227 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006228 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 syntax/ syntax files |mysyntaxfile|
6230 tutor/ files for vimtutor |tutor|
6231
6232 And any other file searched for with the |:runtime| command.
6233
6234 The defaults for most systems are setup to search five locations:
6235 1. In your home directory, for your personal preferences.
6236 2. In a system-wide Vim directory, for preferences from the system
6237 administrator.
6238 3. In $VIMRUNTIME, for files distributed with Vim.
6239 *after-directory*
6240 4. In the "after" directory in the system-wide Vim directory. This is
6241 for the system administrator to overrule or add to the distributed
6242 defaults (rarely needed)
6243 5. In the "after" directory in your home directory. This is for
6244 personal preferences to overrule or add to the distributed defaults
6245 or system-wide settings (rarely needed).
6246
Bram Moolenaard0796902016-09-16 20:02:31 +02006247 More entries are added when using |packages|. If it gets very long
6248 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6249 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006250
Bram Moolenaar071d4272004-06-13 20:20:40 +00006251 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6252 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006253 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 wildcards.
6255 See |:runtime|.
6256 Example: >
6257 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6258< This will use the directory "~/vimruntime" first (containing your
6259 personal Vim runtime files), then "/mygroup/vim" (shared between a
6260 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6261 files).
6262 You probably should always include $VIMRUNTIME somewhere, to use the
6263 distributed runtime files. You can put a directory before $VIMRUNTIME
6264 to find files which replace a distributed runtime files. You can put
6265 a directory after $VIMRUNTIME to find files which add to distributed
6266 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006267 When Vim is started with |--clean| the home directory entries are not
6268 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006269 This option cannot be set from a |modeline| or in the |sandbox|, for
6270 security reasons.
6271
6272 *'scroll'* *'scr'*
6273'scroll' 'scr' number (default: half the window height)
6274 local to window
6275 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6276 set to half the number of lines in the window when the window size
6277 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006278 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006279 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006280
6281 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6282'scrollbind' 'scb' boolean (default off)
6283 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006284 See also |scroll-binding|. When this option is set, the current
6285 window scrolls as other scrollbind windows (windows that also have
6286 this option set) scroll. This option is useful for viewing the
6287 differences between two versions of a file, see 'diff'.
6288 See |'scrollopt'| for options that determine how this option should be
6289 interpreted.
6290 This option is mostly reset when splitting a window to edit another
6291 file. This means that ":split | edit file" results in two windows
6292 with scroll-binding, but ":split file" does not.
6293
Bram Moolenaarae20f342019-11-05 21:09:23 +01006294 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6295'scrollfocus' 'scf' boolean (default off)
6296 global
6297 {only for MS-Windows GUI}
6298 When using the scroll wheel and this option is set, the window under
6299 the mouse pointer is scrolled. With this option off the current
6300 window is scrolled.
6301 Systems other than MS-Windows behave like this option is on.
6302
Bram Moolenaar071d4272004-06-13 20:20:40 +00006303 *'scrolljump'* *'sj'*
6304'scrolljump' 'sj' number (default 1)
6305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 Minimal number of lines to scroll when the cursor gets off the
6307 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6308 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006309 When set to a negative number from -1 to -100 this is used as the
6310 percentage of the window height. Thus -50 scrolls half the window
6311 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006312 NOTE: This option is set to 1 when 'compatible' is set.
6313
6314 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006315'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006316 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006317 Minimal number of screen lines to keep above and below the cursor.
6318 This will make some context visible around where you are working. If
6319 you set it to a very large value (999) the cursor line will always be
6320 in the middle of the window (except at the start or end of the file or
6321 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006322 After using the local value, go back the global value with one of
6323 these two: >
6324 setlocal scrolloff<
6325 setlocal scrolloff=-1
6326< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006327 NOTE: This option is set to 0 when 'compatible' is set.
6328
6329 *'scrollopt'* *'sbo'*
6330'scrollopt' 'sbo' string (default "ver,jump")
6331 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006332 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006333 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6334 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 The following words are available:
6336 ver Bind vertical scrolling for 'scrollbind' windows
6337 hor Bind horizontal scrolling for 'scrollbind' windows
6338 jump Applies to the offset between two windows for vertical
6339 scrolling. This offset is the difference in the first
6340 displayed line of the bound windows. When moving
6341 around in a window, another 'scrollbind' window may
6342 reach a position before the start or after the end of
6343 the buffer. The offset is not changed though, when
6344 moving back the 'scrollbind' window will try to scroll
6345 to the desired position when possible.
6346 When now making that window the current one, two
6347 things can be done with the relative offset:
6348 1. When "jump" is not included, the relative offset is
6349 adjusted for the scroll position in the new current
6350 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006351 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006352 2. When "jump" is included, the other windows are
6353 scrolled to keep the same relative offset. When
6354 going back to the other window, it still uses the
6355 same relative offset.
6356 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006357 When 'diff' mode is active there always is vertical scroll binding,
6358 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006359
6360 *'sections'* *'sect'*
6361'sections' 'sect' string (default "SHNHH HUnhsh")
6362 global
6363 Specifies the nroff macros that separate sections. These are pairs of
6364 two letters (See |object-motions|). The default makes a section start
6365 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6366
6367 *'secure'* *'nosecure'* *E523*
6368'secure' boolean (default off)
6369 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006370 When on, ":autocmd", shell and write commands are not allowed in
6371 ".vimrc" and ".exrc" in the current directory and map commands are
6372 displayed. Switch it off only if you know that you will not run into
6373 problems, or when the 'exrc' option is off. On Unix this option is
6374 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006375 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 'secure' at the end of your ~/.vimrc then.
6377 This option cannot be set from a |modeline| or in the |sandbox|, for
6378 security reasons.
6379
6380 *'selection'* *'sel'*
6381'selection' 'sel' string (default "inclusive")
6382 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006383 This option defines the behavior of the selection. It is only used
6384 in Visual and Select mode.
6385 Possible values:
6386 value past line inclusive ~
6387 old no yes
6388 inclusive yes yes
6389 exclusive yes no
6390 "past line" means that the cursor is allowed to be positioned one
6391 character past the line.
6392 "inclusive" means that the last character of the selection is included
6393 in an operation. For example, when "x" is used to delete the
6394 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006395 When "old" is used and 'virtualedit' allows the cursor to move past
6396 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006397 Note that when "exclusive" is used and selecting from the end
6398 backwards, you cannot include the last character of a line, when
6399 starting in Normal mode and 'virtualedit' empty.
6400
6401 The 'selection' option is set by the |:behave| command.
6402
6403 *'selectmode'* *'slm'*
6404'selectmode' 'slm' string (default "")
6405 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006406 This is a comma separated list of words, which specifies when to start
6407 Select mode instead of Visual mode, when a selection is started.
6408 Possible values:
6409 mouse when using the mouse
6410 key when using shifted special keys
6411 cmd when using "v", "V" or CTRL-V
6412 See |Select-mode|.
6413 The 'selectmode' option is set by the |:behave| command.
6414
6415 *'sessionoptions'* *'ssop'*
6416'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006417 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006418 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006419 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 feature}
6421 Changes the effect of the |:mksession| command. It is a comma
6422 separated list of words. Each word enables saving and restoring
6423 something:
6424 word save and restore ~
6425 blank empty windows
6426 buffers hidden and unloaded buffers, not just those in windows
6427 curdir the current directory
6428 folds manually created folds, opened/closed folds and local
6429 fold options
6430 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006431 and contain at least one lowercase letter. Only
6432 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 help the help window
6434 localoptions options and mappings local to a window or buffer (not
6435 global values for local options)
6436 options all options and mappings (also global values for local
6437 options)
6438 resize size of the Vim window: 'lines' and 'columns'
6439 sesdir the directory in which the session file is located
6440 will become the current directory (useful with
6441 projects accessed over a network from different
6442 systems)
6443 slash backslashes in file names replaced with forward
6444 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006445 tabpages all tab pages; without this only the current tab page
6446 is restored, so that you can make a session for each
6447 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006448 terminal include terminal windows where the command can be
6449 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006450 unix with Unix end-of-line format (single <NL>), even when
6451 on Windows or DOS
6452 winpos position of the whole Vim window
6453 winsize window sizes
6454
6455 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006456 When neither "curdir" nor "sesdir" is included, file names are stored
6457 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 "slash" and "unix" are useful on Windows when sharing session files
6459 with Unix. The Unix version of Vim cannot source dos format scripts,
6460 but the Windows version of Vim can source unix format scripts.
6461
6462 *'shell'* *'sh'* *E91*
6463'shell' 'sh' string (default $SHELL or "sh",
6464 MS-DOS and Win32: "command.com" or
6465 "cmd.exe", OS/2: "cmd")
6466 global
6467 Name of the shell to use for ! and :! commands. When changing the
6468 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6469 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006470 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 See |option-backslash| about including spaces and backslashes.
6472 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006473
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006474 If the name of the shell contains a space, you need to enclose it in
6475 quotes and escape the space. Example: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006476 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6477< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006478 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006480 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006482 Example with escaped space (Vim will do this when initializing the
6483 option from $SHELL): >
6484 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006485< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006486 backslashes are consumed by `:set`.
6487
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 Under MS-Windows, when the executable ends in ".com" it must be
6489 included. Thus setting the shell to "command.com" or "4dos.com"
6490 works, but "command" and "4dos" do not work for all commands (e.g.,
6491 filtering).
6492 For unknown reasons, when using "4dos.com" the current directory is
6493 changed to "C:\". To avoid this set 'shell' like this: >
6494 :set shell=command.com\ /c\ 4dos
6495< This option cannot be set from a |modeline| or in the |sandbox|, for
6496 security reasons.
6497
6498 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006499'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006500 MS-DOS and Win32, when 'shell' does not
6501 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006503 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6504 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6505 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006506 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006507 On Unix it can have more than one flag. Each white space separated
6508 part is passed as an argument to the shell command.
6509 See |option-backslash| about including spaces and backslashes.
6510 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006511 This option cannot be set from a |modeline| or in the |sandbox|, for
6512 security reasons.
6513
6514 *'shellpipe'* *'sp'*
6515'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006517 {not available when compiled without the |+quickfix|
6518 feature}
6519 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006520 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 including spaces and backslashes.
6522 The name of the temporary file can be represented by "%s" if necessary
6523 (the file name is appended automatically if no %s appears in the value
6524 of this option).
6525 For the Amiga and MS-DOS the default is ">". The output is directly
6526 saved in a file and not echoed to the screen.
6527 For Unix the default it "| tee". The stdout of the compiler is saved
6528 in a file and echoed to the screen. If the 'shell' option is "csh" or
6529 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006530 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6531 "bash" or "fish" the default becomes "2>&1| tee". This means that
6532 stderr is also included. Before using the 'shell' option a path is
6533 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006534 The initialization of this option is done after reading the ".vimrc"
6535 and the other initializations, so that when the 'shell' option is set
6536 there, the 'shellpipe' option changes automatically, unless it was
6537 explicitly set before.
6538 When 'shellpipe' is set to an empty string, no redirection of the
6539 ":make" output will be done. This is useful if you use a 'makeprg'
6540 that writes to 'makeef' by itself. If you want no piping, but do
6541 want to include the 'makeef', set 'shellpipe' to a single space.
6542 Don't forget to precede the space with a backslash: ":set sp=\ ".
6543 In the future pipes may be used for filtering and this option will
6544 become obsolete (at least for Unix).
6545 This option cannot be set from a |modeline| or in the |sandbox|, for
6546 security reasons.
6547
6548 *'shellquote'* *'shq'*
6549'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6550 contains "sh" somewhere: "\"")
6551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006552 Quoting character(s), put around the command passed to the shell, for
6553 the "!" and ":!" commands. The redirection is kept outside of the
6554 quoting. See 'shellxquote' to include the redirection. It's
6555 probably not useful to set both options.
6556 This is an empty string by default. Only known to be useful for
6557 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6558 or bash, where it should be "\"". The default is adjusted according
6559 the value of 'shell', to reduce the need to set this option by the
6560 user. See |dos-shell|.
6561 This option cannot be set from a |modeline| or in the |sandbox|, for
6562 security reasons.
6563
6564 *'shellredir'* *'srr'*
6565'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6566 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006567 String to be used to put the output of a filter command in a temporary
6568 file. See also |:!|. See |option-backslash| about including spaces
6569 and backslashes.
6570 The name of the temporary file can be represented by "%s" if necessary
6571 (the file name is appended automatically if no %s appears in the value
6572 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006573 The default is ">". For Unix, if the 'shell' option is "csh" or
6574 "tcsh" during initializations, the default becomes ">&". If the
6575 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh",
6576 "zsh-beta","bash" or "fish", the default becomes ">%s 2>&1". This
6577 means that stderr is also included. For Win32, the Unix checks are
6578 done and additionally "cmd" is checked for, which makes the default
6579 ">%s 2>&1". Also, the same names with ".exe" appended are checked
6580 for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006581 The initialization of this option is done after reading the ".vimrc"
6582 and the other initializations, so that when the 'shell' option is set
6583 there, the 'shellredir' option changes automatically unless it was
6584 explicitly set before.
6585 In the future pipes may be used for filtering and this option will
6586 become obsolete (at least for Unix).
6587 This option cannot be set from a |modeline| or in the |sandbox|, for
6588 security reasons.
6589
6590 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6591'shellslash' 'ssl' boolean (default off)
6592 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006593 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006594 When set, a forward slash is used when expanding file names. This is
6595 useful when a Unix-like shell is used instead of command.com or
6596 cmd.exe. Backward slashes can still be typed, but they are changed to
6597 forward slashes by Vim.
6598 Note that setting or resetting this option has no effect for some
6599 existing file names, thus this option needs to be set before opening
6600 any file for best results. This might change in the future.
6601 'shellslash' only works when a backslash can be used as a path
6602 separator. To test if this is so use: >
6603 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006604< Also see 'completeslash'.
6605
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006606 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6607'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6608 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006609 When on, use temp files for shell commands. When off use a pipe.
6610 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006611 Currently a pipe is only supported on Unix and MS-Windows 2K and
6612 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006613 :if has("filterpipe")
6614< The advantage of using a pipe is that nobody can read the temp file
6615 and the 'shell' command does not need to support redirection.
6616 The advantage of using a temp file is that the file type and encoding
6617 can be detected.
6618 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6619 |FilterWritePost| autocommands event are not triggered when
6620 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006621 The `system()` function does not respect this option and always uses
6622 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006623 NOTE: This option is set to the Vim default value when 'compatible'
6624 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006625
Bram Moolenaar071d4272004-06-13 20:20:40 +00006626 *'shelltype'* *'st'*
6627'shelltype' 'st' number (default 0)
6628 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006629 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006630 On the Amiga this option influences the way how the commands work
6631 which use a shell.
6632 0 and 1: always use the shell
6633 2 and 3: use the shell only to filter lines
6634 4 and 5: use shell only for ':sh' command
6635 When not using the shell, the command is executed directly.
6636
6637 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6638 1 and 3: use "shell cmd" to start external commands
6639
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006640 *'shellxescape'* *'sxe'*
6641'shellxescape' 'sxe' string (default: "";
6642 for MS-DOS and MS-Windows: "\"&|<>()@^")
6643 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006644 When 'shellxquote' is set to "(" then the characters listed in this
6645 option will be escaped with a '^' character. This makes it possible
6646 to execute most external commands with cmd.exe.
6647
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 *'shellxquote'* *'sxq'*
6649'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006650 for Win32, when 'shell' is cmd.exe: "("
6651 for Win32, when 'shell' contains "sh"
6652 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006653 for Unix, when using system(): "\"")
6654 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 Quoting character(s), put around the command passed to the shell, for
6656 the "!" and ":!" commands. Includes the redirection. See
6657 'shellquote' to exclude the redirection. It's probably not useful
6658 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006659 When the value is '(' then ')' is appended. When the value is '"('
6660 then ')"' is appended.
6661 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006662 This is an empty string by default on most systems, but is known to be
6663 useful for on Win32 version, either for cmd.exe which automatically
6664 strips off the first and last quote on a command, or 3rd-party shells
6665 such as the MKS Korn Shell or bash, where it should be "\"". The
6666 default is adjusted according the value of 'shell', to reduce the need
6667 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006668 This option cannot be set from a |modeline| or in the |sandbox|, for
6669 security reasons.
6670
6671 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6672'shiftround' 'sr' boolean (default off)
6673 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006674 Round indent to multiple of 'shiftwidth'. Applies to > and <
6675 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6676 a multiple of 'shiftwidth' (this is Vi compatible).
6677 NOTE: This option is reset when 'compatible' is set.
6678
6679 *'shiftwidth'* *'sw'*
6680'shiftwidth' 'sw' number (default 8)
6681 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006682 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006684 When zero the 'ts' value will be used. Use the |shiftwidth()|
6685 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686
6687 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006688'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6689 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006691 This option helps to avoid all the |hit-enter| prompts caused by file
6692 messages, for example with CTRL-G, and to avoid some other messages.
6693 It is a list of flags:
6694 flag meaning when present ~
6695 f use "(3 of 5)" instead of "(file 3 of 5)"
6696 i use "[noeol]" instead of "[Incomplete last line]"
6697 l use "999L, 888C" instead of "999 lines, 888 characters"
6698 m use "[+]" instead of "[Modified]"
6699 n use "[New]" instead of "[New File]"
6700 r use "[RO]" instead of "[readonly]"
6701 w use "[w]" instead of "written" for file write message
6702 and "[a]" instead of "appended" for ':w >> file' command
6703 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6704 "[unix format]" and "[mac]" instead of "[mac format]".
6705 a all of the above abbreviations
6706
6707 o overwrite message for writing a file with subsequent message
6708 for reading a file (useful for ":wn" or when 'autowrite' on)
6709 O message for reading a file overwrites any previous message.
6710 Also for quickfix message (e.g., ":cn").
6711 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006712 hit TOP, continuing at BOTTOM" messages; when using the search
6713 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 t truncate file message at the start if it is too long to fit
6715 on the command-line, "<" will appear in the left most column.
6716 Ignored in Ex mode.
6717 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006718 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006719 Ignored in Ex mode.
6720 W don't give "written" or "[w]" when writing a file
6721 A don't give the "ATTENTION" message when an existing swap file
6722 is found.
6723 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006724 c don't give |ins-completion-menu| messages. For example,
6725 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6726 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006727 q use "recording" instead of "recording @a"
6728 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006729 was used for the command; note that this also affects messages
6730 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006731 S do not show search count message when searching, e.g.
6732 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006733
6734 This gives you the opportunity to avoid that a change between buffers
6735 requires you to hit <Enter>, but still gives as useful a message as
6736 possible for the space available. To get the whole message that you
6737 would have got with 'shm' empty, use ":file!"
6738 Useful values:
6739 shm= No abbreviation of message.
6740 shm=a Abbreviation, but no loss of information.
6741 shm=at Abbreviation, and truncate message when necessary.
6742
6743 NOTE: This option is set to the Vi default value when 'compatible' is
6744 set and to the Vim default value when 'compatible' is reset.
6745
6746 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6747'shortname' 'sn' boolean (default off)
6748 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006749 Filenames are assumed to be 8 characters plus one extension of 3
6750 characters. Multiple dots in file names are not allowed. When this
6751 option is on, dots in file names are replaced with underscores when
6752 adding an extension (".~" or ".swp"). This option is not available
6753 for MS-DOS, because then it would always be on. This option is useful
6754 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6755 or crossdos. When running the Win32 GUI version under Win32s, this
6756 option is always on by default.
6757
6758 *'showbreak'* *'sbr'* *E595*
6759'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006760 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006761 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 feature}
6763 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006764 values are "> " or "+++ ": >
6765 :set showbreak=>\
6766< Note the backslash to escape the trailing space. It's easier like
6767 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006768 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006769< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006770 comma (in a future version the comma might be used to separate the
6771 part that is shown at the end and at the start of a line).
6772 The characters are highlighted according to the '@' flag in
6773 'highlight'.
6774 Note that tabs after the showbreak will be displayed differently.
6775 If you want the 'showbreak' to appear in between line numbers, add the
6776 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006777 A window-local value overrules a global value. If the global value is
6778 set and you want no value in the current window use NONE: >
6779 :setlocal showbreak=NONE
6780<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006782'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6783 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006784 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006785 {not available when compiled without the
6786 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006787 Show (partial) command in the last line of the screen. Set this
6788 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 In Visual mode the size of the selected area is shown:
6790 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006791 If the number of bytes is different it is also displayed: "2-6"
6792 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006794 - When selecting a block, the size in screen characters:
6795 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006796 NOTE: This option is set to the Vi default value when 'compatible' is
6797 set and to the Vim default value when 'compatible' is reset.
6798
6799 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6800'showfulltag' 'sft' boolean (default off)
6801 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006802 When completing a word in insert mode (see |ins-completion|) from the
6803 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 matched a C function, you can see a template for what arguments are
6806 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006807 Note that this doesn't work well together with having "longest" in
6808 'completeopt', because the completion from the search pattern may not
6809 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006810
6811 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6812'showmatch' 'sm' boolean (default off)
6813 global
6814 When a bracket is inserted, briefly jump to the matching one. The
6815 jump is only done if the match can be seen on the screen. The time to
6816 show the match can be set with 'matchtime'.
6817 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006818 seen or not).
6819 This option is reset when 'paste' is set and restored when 'paste' is
6820 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 When the 'm' flag is not included in 'cpoptions', typing a character
6822 will immediately move the cursor back to where it belongs.
6823 See the "sm" field in 'guicursor' for setting the cursor shape and
6824 blinking when showing the match.
6825 The 'matchpairs' option can be used to specify the characters to show
6826 matches for. 'rightleft' and 'revins' are used to look for opposite
6827 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006828 Also see the matchparen plugin for highlighting the match when moving
6829 around |pi_paren.txt|.
6830 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831
6832 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6833'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6834 global
6835 If in Insert, Replace or Visual mode put a message on the last line.
6836 Use the 'M' flag in 'highlight' to set the type of highlighting for
6837 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006838 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006839 doesn't mean XIM is really active, especially when 'imactivatekey' is
6840 not set.
6841 NOTE: This option is set to the Vi default value when 'compatible' is
6842 set and to the Vim default value when 'compatible' is reset.
6843
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006844 *'showtabline'* *'stal'*
6845'showtabline' 'stal' number (default 1)
6846 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006847 The value of this option specifies when the line with tab page labels
6848 will be displayed:
6849 0: never
6850 1: only if there are at least two tab pages
6851 2: always
6852 This is both for the GUI and non-GUI implementation of the tab pages
6853 line.
6854 See |tab-page| for more information about tab pages.
6855
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 *'sidescroll'* *'ss'*
6857'sidescroll' 'ss' number (default 0)
6858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006859 The minimal number of columns to scroll horizontally. Used only when
6860 the 'wrap' option is off and the cursor is moved off of the screen.
6861 When it is zero the cursor will be put in the middle of the screen.
6862 When using a slow terminal set it to a large number or 0. When using
6863 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6864 commands.
6865
6866 *'sidescrolloff'* *'siso'*
6867'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006868 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006869 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006870 right of the cursor if 'nowrap' is set. Setting this option to a
6871 value greater than 0 while having |'sidescroll'| also at a non-zero
6872 value makes some context visible in the line you are scrolling in
6873 horizontally (except at beginning of the line). Setting this option
6874 to a large value (like 999) has the effect of keeping the cursor
6875 horizontally centered in the window, as long as one does not come too
6876 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006877 After using the local value, go back the global value with one of
6878 these two: >
6879 setlocal sidescrolloff<
6880 setlocal sidescrolloff=-1
6881< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006882
6883 Example: Try this together with 'sidescroll' and 'listchars' as
6884 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006885 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006886
6887 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6888 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006889<
6890 *'signcolumn'* *'scl'*
6891'signcolumn' 'scl' string (default "auto")
6892 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006893 {not available when compiled without the |+signs|
6894 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006895 Whether or not to draw the signcolumn. Valid values are:
6896 "auto" only when there is a sign to display
6897 "no" never
6898 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006899 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006900 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901
6902
6903 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6904'smartcase' 'scs' boolean (default off)
6905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006906 Override the 'ignorecase' option if the search pattern contains upper
6907 case characters. Only used when the search pattern is typed and
6908 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006909 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006910 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6911 recalling the search pattern from history and hitting <Enter>.
6912 NOTE: This option is reset when 'compatible' is set.
6913
6914 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6915'smartindent' 'si' boolean (default off)
6916 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006917 {not available when compiled without the
6918 |+smartindent| feature}
6919 Do smart autoindenting when starting a new line. Works for C-like
6920 programs, but can also be used for other languages. 'cindent' does
6921 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006922 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006923 setting 'si' has no effect. 'indentexpr' is a more advanced
6924 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006925 Normally 'autoindent' should also be on when using 'smartindent'.
6926 An indent is automatically inserted:
6927 - After a line ending in '{'.
6928 - After a line starting with a keyword from 'cinwords'.
6929 - Before a line starting with '}' (only with the "O" command).
6930 When typing '}' as the first character in a new line, that line is
6931 given the same indent as the matching '{'.
6932 When typing '#' as the first character in a new line, the indent for
6933 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006934 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006935 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6936 When using the ">>" command, lines starting with '#' are not shifted
6937 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006938 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006939 This option is reset when 'paste' is set and restored when 'paste' is
6940 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006941
6942 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6943'smarttab' 'sta' boolean (default off)
6944 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006945 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006946 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6947 <BS> will delete a 'shiftwidth' worth of space at the start of the
6948 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006949 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006950 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6951 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006952 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006953 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006954 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006955 This option is reset when 'paste' is set and restored when 'paste' is
6956 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006957 NOTE: This option is reset when 'compatible' is set.
6958
6959 *'softtabstop'* *'sts'*
6960'softtabstop' 'sts' number (default 0)
6961 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006962 Number of spaces that a <Tab> counts for while performing editing
6963 operations, like inserting a <Tab> or using <BS>. It "feels" like
6964 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6965 used. This is useful to keep the 'ts' setting at its standard value
6966 of 8, while being able to edit like it is set to 'sts'. However,
6967 commands like "x" still work on the actual characters.
6968 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006969 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006970 'softtabstop' is set to 0 when the 'paste' option is set and restored
6971 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006972 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6973 spaces is minimized by using <Tab>s.
6974 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6975 set.
6976 NOTE: This option is set to 0 when 'compatible' is set.
6977
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006978 If Vim is compiled with the |+vartabs| feature then the value of
6979 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6980 anything other than an empty string.
6981
Bram Moolenaar217ad922005-03-20 22:37:15 +00006982 *'spell'* *'nospell'*
6983'spell' boolean (default off)
6984 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006985 {not available when compiled without the |+syntax|
6986 feature}
6987 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006988 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006989
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006990 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006991'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006992 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006993 {not available when compiled without the |+syntax|
6994 feature}
6995 Pattern to locate the end of a sentence. The following word will be
6996 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006997 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006998 When this check is not wanted make this option empty.
6999 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007000 Be careful with special characters, see |option-backslash| about
7001 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007002 To set this option automatically depending on the language, see
7003 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007004
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007005 *'spellfile'* *'spf'*
7006'spellfile' 'spf' string (default empty)
7007 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007008 {not available when compiled without the |+syntax|
7009 feature}
7010 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007011 commands. It must end in ".{encoding}.add". You need to include the
7012 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007013 *E765*
7014 It may also be a comma separated list of names. A count before the
7015 |zg| and |zw| commands can be used to access each. This allows using
7016 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007017 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007018 you: Using the first directory in 'runtimepath' that is writable. If
7019 there is no "spell" directory yet it will be created. For the file
7020 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007021 ignoring the region.
7022 The resulting ".spl" file will be used for spell checking, it does not
7023 have to appear in 'spelllang'.
7024 Normally one file is used for all regions, but you can add the region
7025 name if you want to. However, it will then only be used when
7026 'spellfile' is set to it, for entries in 'spelllang' only files
7027 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007028 This option cannot be set from a |modeline| or in the |sandbox|, for
7029 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007030
Bram Moolenaar217ad922005-03-20 22:37:15 +00007031 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007032'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007033 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007034 {not available when compiled without the |+syntax|
7035 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007036 A comma separated list of word list names. When the 'spell' option is
7037 on spellchecking will be done for these languages. Example: >
7038 set spelllang=en_us,nl,medical
7039< This means US English, Dutch and medical words are recognized. Words
7040 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007041 The word list name must consist of alphanumeric characters, a dash or
7042 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007043 recommended to separate the two letter language name from a
7044 specification. Thus "en-rare" is used for rare English words.
7045 A region name must come last and have the form "_xx", where "xx" is
7046 the two-letter, lower case region name. You can use more than one
7047 region by listing them: "en_us,en_ca" supports both US and Canadian
7048 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007049 Britain. (Note: currently en_au and en_nz dictionaries are older than
7050 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007051 If the name "cjk" is included East Asian characters are excluded from
7052 spell checking. This is useful when editing text that also has Asian
7053 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007054 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007055 As a special case the name of a .spl file can be given as-is. The
7056 first "_xx" in the name is removed and used as the region name
7057 (_xx is an underscore, two letters and followed by a non-letter).
7058 This is mainly for testing purposes. You must make sure the correct
7059 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007060 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007061 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7062 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007063 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007064
Bram Moolenaar98692072006-02-04 00:57:42 +00007065 If the |spellfile.vim| plugin is active and you use a language name
7066 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7067 will ask you if you want to download the file.
7068
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007069 After this option has been set successfully, Vim will source the files
7070 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007071 up to the first character that is not an ASCII letter or number and
7072 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007073
7074
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007075 *'spellsuggest'* *'sps'*
7076'spellsuggest' 'sps' string (default "best")
7077 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007078 {not available when compiled without the |+syntax|
7079 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007080 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007081 the |spellsuggest()| function. This is a comma-separated list of
7082 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007083
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007084 best Internal method that works best for English. Finds
7085 changes like "fast" and uses a bit of sound-a-like
7086 scoring to improve the ordering.
7087
7088 double Internal method that uses two methods and mixes the
7089 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007090 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007091 word. That only works when the language specifies
7092 sound folding. Can be slow and doesn't always give
7093 better results.
7094
7095 fast Internal method that only checks for simple changes:
7096 character inserts/deletes/swaps. Works well for
7097 simple typing mistakes.
7098
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007099 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007100 Not used for |spellsuggest()|. The number of
7101 suggestions is never more than the value of 'lines'
7102 minus two.
7103
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007104 file:{filename} Read file {filename}, which must have two columns,
7105 separated by a slash. The first column contains the
7106 bad word, the second column the suggested good word.
7107 Example:
7108 theribal/terrible ~
7109 Use this for common mistakes that do not appear at the
7110 top of the suggestion list with the internal methods.
7111 Lines without a slash are ignored, use this for
7112 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007113 The word in the second column must be correct,
7114 otherwise it will not be used. Add the word to an
7115 ".add" file if it is currently flagged as a spelling
7116 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007117 The file is used for all languages.
7118
7119 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7120 trouble with spaces. |v:val| holds the badly spelled
7121 word. The expression must evaluate to a List of
7122 Lists, each with a suggestion and a score.
7123 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007124 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007125 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007126 internal methods use. A lower score is better.
7127 This may invoke |spellsuggest()| if you temporarily
7128 set 'spellsuggest' to exclude the "expr:" part.
7129 Errors are silently ignored, unless you set the
7130 'verbose' option to a non-zero value.
7131
7132 Only one of "best", "double" or "fast" may be used. The others may
7133 appear several times in any order. Example: >
7134 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7135<
7136 This option cannot be set from a |modeline| or in the |sandbox|, for
7137 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007138
7139
Bram Moolenaar071d4272004-06-13 20:20:40 +00007140 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7141'splitbelow' 'sb' boolean (default off)
7142 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 When on, splitting a window will put the new window below the current
7144 one. |:split|
7145
7146 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7147'splitright' 'spr' boolean (default off)
7148 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007149 When on, splitting a window will put the new window right of the
7150 current one. |:vsplit|
7151
7152 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7153'startofline' 'sol' boolean (default on)
7154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007156 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007157 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007158 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 with a linewise operator, with "%" with a count and to buffer changing
7160 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7161 only has a line number, e.g., ":25" or ":+".
7162 In case of buffer changing commands the cursor is placed at the column
7163 where it was the last time the buffer was edited.
7164 NOTE: This option is set when 'compatible' is set.
7165
Bram Moolenaar00654022011-02-25 14:42:19 +01007166 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007167'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007168 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 {not available when compiled without the |+statusline|
7170 feature}
7171 When nonempty, this option determines the content of the status line.
7172 Also see |status-line|.
7173
7174 The option consists of printf style '%' items interspersed with
7175 normal text. Each status line item is of the form:
7176 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007177 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007178 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007179
Bram Moolenaar238a5642006-02-21 22:12:05 +00007180 When the option starts with "%!" then it is used as an expression,
7181 evaluated and the result is used as the option value. Example: >
7182 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007183< The *g:statusline_winid* variable will be set to the |window-ID| of the
7184 window that the status line belongs to.
7185 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007186 Note that the "%!" expression is evaluated in the context of the
7187 current window and buffer, while %{} items are evaluated in the
7188 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007189
7190 When there is error while evaluating the option then it will be made
7191 empty to avoid further errors. Otherwise screen updating would loop.
7192
Bram Moolenaar071d4272004-06-13 20:20:40 +00007193 Note that the only effect of 'ruler' when this option is set (and
7194 'laststatus' is 2) is controlling the output of |CTRL-G|.
7195
7196 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007197 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007199 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 minwid Minimum width of the item, padding as set by '-' & '0'.
7201 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007202 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007203 on the left for text items. Numeric items will be
7204 shifted down to maxwid-2 digits followed by '>'number
7205 where number is the amount of missing digits, much like
7206 an exponential notation.
7207 item A one letter code as described below.
7208
7209 Following is a description of the possible statusline items. The
7210 second character in "item" is the type:
7211 N for number
7212 S for string
7213 F for flags as described below
7214 - not applicable
7215
7216 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007217 f S Path to the file in the buffer, as typed or relative to current
7218 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 F S Full path to the file in the buffer.
7220 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007221 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007222 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007223 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007225 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007227 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007229 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007231 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7233 being used: "<keymap>"
7234 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007235 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007236 B N As above, in hexadecimal.
7237 o N Byte number in file of byte under cursor, first byte is 1.
7238 Mnemonic: Offset from start of file (with one added)
7239 {not available when compiled without |+byte_offset| feature}
7240 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007241 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007242 l N Line number.
7243 L N Number of lines in buffer.
7244 c N Column number.
7245 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007246 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007247 p N Percentage through file in lines as in |CTRL-G|.
7248 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007249 percentage described for 'ruler'. Always 3 in length, unless
7250 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007251 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007252 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007253 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007254 Note that there is no '%' before the closing '}'. The
7255 expression cannot contain a '}' character, call a function to
7256 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007257 ( - Start of item group. Can be used for setting the width and
7258 alignment of a section. Must be followed by %) somewhere.
7259 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007260 T N For 'tabline': start of tab page N label. Use %T after the last
7261 label. This information is used for mouse clicks.
7262 X N For 'tabline': start of close tab N label. Use %X after the
7263 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7264 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 < - Where to truncate line if too long. Default is at the start.
7266 No width fields allowed.
7267 = - Separation point between left and right aligned items.
7268 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007269 # - Set highlight group. The name must follow and then a # again.
7270 Thus use %#HLname# for highlight group HLname. The same
7271 highlighting is used, also for the statusline of non-current
7272 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007273 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007274 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 The difference between User{N} and StatusLine will be applied
7276 to StatusLineNC for the statusline of non-current windows.
7277 The number N must be between 1 and 9. See |hl-User1..9|
7278
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007279 When displaying a flag, Vim removes the leading comma, if any, when
7280 that flag comes right after plaintext. This will make a nice display
7281 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007282
Bram Moolenaar582fd852005-03-28 20:58:01 +00007283 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284 not set) and a minwid is not set for the group, the whole group will
7285 become empty. This will make a group like the following disappear
7286 completely from the statusline when none of the flags are set. >
7287 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007288< Beware that an expression is evaluated each and every time the status
7289 line is displayed.
7290 *g:actual_curbuf* *g:actual_curwin*
7291 The current buffer and current window will be set temporarily to that
7292 of the window (and buffer) whose statusline is currently being drawn.
7293 The expression will evaluate in this context. The variable
7294 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7295 buffer and "g:actual_curwin" to the |window-ID| of the real current
7296 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007297
Bram Moolenaar30b65812012-07-12 22:01:11 +02007298 The 'statusline' option will be evaluated in the |sandbox| if set from
7299 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007300 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007301
7302 It is not allowed to change text or jump to another window while
7303 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304
7305 If the statusline is not updated when you want it (e.g., after setting
7306 a variable that's used in an expression), you can force an update by
7307 setting an option without changing its value. Example: >
7308 :let &ro = &ro
7309
7310< A result of all digits is regarded a number for display purposes.
7311 Otherwise the result is taken as flag text and applied to the rules
7312 described above.
7313
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007314 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007315 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007316 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317
7318 Examples:
7319 Emulate standard status line with 'ruler' set >
7320 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7321< Similar, but add ASCII value of char under the cursor (like "ga") >
7322 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7323< Display byte count and byte value, modified flag in red. >
7324 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7325 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7326< Display a ,GZ flag if a compressed file is loaded >
7327 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7328< In the |:autocmd|'s: >
7329 :let b:gzflag = 1
7330< And: >
7331 :unlet b:gzflag
7332< And define this function: >
7333 :function VarExists(var, val)
7334 : if exists(a:var) | return a:val | else | return '' | endif
7335 :endfunction
7336<
7337 *'suffixes'* *'su'*
7338'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340 Files with these suffixes get a lower priority when multiple files
7341 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007342 suffixes. Spaces after the comma are ignored. A dot is also seen as
7343 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344 separator, precede it with a backslash (see |option-backslash| about
7345 including spaces and backslashes).
7346 See 'wildignore' for completely ignoring files.
7347 The use of |:set+=| and |:set-=| is preferred when adding or removing
7348 suffixes from the list. This avoids problems when a future version
7349 uses another default.
7350
7351 *'suffixesadd'* *'sua'*
7352'suffixesadd' 'sua' string (default "")
7353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007354 {not available when compiled without the
7355 |+file_in_path| feature}
7356 Comma separated list of suffixes, which are used when searching for a
7357 file for the "gf", "[I", etc. commands. Example: >
7358 :set suffixesadd=.java
7359<
7360 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7361'swapfile' 'swf' boolean (default on)
7362 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007363 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007364 swapfile is not wanted for a specific buffer. For example, with
7365 confidential information that even root must not be able to access.
7366 Careful: All text will be in memory:
7367 - Don't use this for big files.
7368 - Recovery will be impossible!
7369 A swapfile will only be present when |'updatecount'| is non-zero and
7370 'swapfile' is set.
7371 When 'swapfile' is reset, the swap file for the current buffer is
7372 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7373 non-zero, a swap file is immediately created.
7374 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007375 If you want to open a new buffer without creating a swap file for it,
7376 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007377 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007378
7379 This option is used together with 'bufhidden' and 'buftype' to
7380 specify special kinds of buffers. See |special-buffers|.
7381
7382 *'swapsync'* *'sws'*
7383'swapsync' 'sws' string (default "fsync")
7384 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007385 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007386 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 When this option is empty parts of the swap file may be in memory and
7388 not written to disk. When the system crashes you may lose more work.
7389 On Unix the system does a sync now and then without Vim asking for it,
7390 so the disadvantage of setting this option off is small. On some
7391 systems the swap file will not be written at all. For a unix system
7392 setting it to "sync" will use the sync() call instead of the default
7393 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007394 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007395
7396 *'switchbuf'* *'swb'*
7397'switchbuf' 'swb' string (default "")
7398 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007399 This option controls the behavior when switching between buffers.
7400 Possible values (comma separated list):
7401 useopen If included, jump to the first open window that
7402 contains the specified buffer (if there is one).
7403 Otherwise: Do not examine other windows.
7404 This setting is checked with |quickfix| commands, when
7405 jumping to errors (":cc", ":cn", "cp", etc.). It is
7406 also used in all buffer related split commands, for
7407 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007408 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007409 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007410 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007411 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007412 Otherwise: do not split, use current window (when used
7413 in the quickfix window: the previously used window or
7414 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007415 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007416 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007417 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007418
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007419 *'synmaxcol'* *'smc'*
7420'synmaxcol' 'smc' number (default 3000)
7421 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007422 {not available when compiled without the |+syntax|
7423 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007424 Maximum column in which to search for syntax items. In long lines the
7425 text after this column is not highlighted and following lines may not
7426 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007427 This helps to avoid very slow redrawing for an XML file that is one
7428 long line.
7429 Set to zero to remove the limit.
7430
Bram Moolenaar071d4272004-06-13 20:20:40 +00007431 *'syntax'* *'syn'*
7432'syntax' 'syn' string (default empty)
7433 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007434 {not available when compiled without the |+syntax|
7435 feature}
7436 When this option is set, the syntax with this name is loaded, unless
7437 syntax highlighting has been switched off with ":syntax off".
7438 Otherwise this option does not always reflect the current syntax (the
7439 b:current_syntax variable does).
7440 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007441 not automatically recognized. Example, in an IDL file:
7442 /* vim: set syntax=idl : */ ~
7443 When a dot appears in the value then this separates two filetype
7444 names. Example:
7445 /* vim: set syntax=c.doxygen : */ ~
7446 This will use the "c" syntax first, then the "doxygen" syntax.
7447 Note that the second one must be prepared to be loaded as an addition,
7448 otherwise it will be skipped. More than one dot may appear.
7449 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007450 :set syntax=OFF
7451< To switch syntax highlighting on according to the current value of the
7452 'filetype' option: >
7453 :set syntax=ON
7454< What actually happens when setting the 'syntax' option is that the
7455 Syntax autocommand event is triggered with the value as argument.
7456 This option is not copied to another buffer, independent of the 's' or
7457 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007458 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007460 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007461'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007462 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007463 When nonempty, this option determines the content of the tab pages
7464 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007465 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007466
7467 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007468 option and only when there is no GUI tab line. When 'e' is in
7469 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007470 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007471
7472 The value is evaluated like with 'statusline'. You can use
7473 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007474 the text to be displayed. Use "%1T" for the first label, "%2T" for
7475 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007476
Bram Moolenaare12bab32019-01-08 22:02:56 +01007477 When changing something that is used in 'tabline' that does not
7478 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007479 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007480
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007481 Keep in mind that only one of the tab pages is the current one, others
7482 are invisible and you can't jump to their windows.
7483
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007484
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007485 *'tabpagemax'* *'tpm'*
7486'tabpagemax' 'tpm' number (default 10)
7487 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007488 Maximum number of tab pages to be opened by the |-p| command line
7489 argument or the ":tab all" command. |tabpage|
7490
7491
7492 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007493'tabstop' 'ts' number (default 8)
7494 local to buffer
7495 Number of spaces that a <Tab> in the file counts for. Also see
7496 |:retab| command, and 'softtabstop' option.
7497
7498 Note: Setting 'tabstop' to any other value than 8 can make your file
7499 appear wrong in many places (e.g., when printing it).
7500
7501 There are four main ways to use tabs in Vim:
7502 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7503 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007504 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007505 behave like a tab appears every 4 (or 3) characters.
7506 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7507 'expandtab'. This way you will always insert spaces. The
7508 formatting will never be messed up when 'tabstop' is changed.
7509 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007510 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007511 works when using Vim to edit the file.
7512 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7513 'noexpandtab'. This should then work (for initial indents only)
7514 for any tabstop setting that people use. It might be nice to have
7515 tabs after the first non-blank inserted as spaces if you do this
7516 though. Otherwise aligned comments will be wrong when 'tabstop' is
7517 changed.
7518
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007519 If Vim is compiled with the |+vartabs| feature then the value of
7520 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7521 than an empty string.
7522
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7524'tagbsearch' 'tbs' boolean (default on)
7525 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007527 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007528 searching makes searching for a tag a LOT faster, but a linear search
7529 will find more tags if the tags file wasn't properly sorted.
7530 Vim normally assumes that your tags files are sorted, or indicate that
7531 they are not sorted. Only when this is not the case does the
7532 'tagbsearch' option need to be switched off.
7533
7534 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007535 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007536 certain files, or retry all files with a linear search. When
7537 'tagbsearch' is off, only a linear search is done.
7538
7539 Linear searching is done anyway, for one file, when Vim finds a line
7540 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007541 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007542< [The whitespace before and after the '0' must be a single <Tab>]
7543
7544 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007545 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546 instead of a normal tag name, a retry is done with a linear search.
7547 Tags in unsorted tags files, and matches with different case will only
7548 be found in the retry.
7549
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007550 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007551 linear search can be avoided when case is ignored. Use a value of '2'
7552 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7553 sorted with the -f switch to "sort" in most unices, as in the command:
7554 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7555 (at least 5.5) the --sort=foldcase switch can be used for this as
7556 well. Note that case must be folded to uppercase for this to work.
7557
7558 By default, tag searches are case-sensitive. Case is ignored when
7559 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7560 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007561 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7562 'tagcase' is "smart", and the pattern contains only lowercase
7563 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007564
7565 When 'tagbsearch' is off, tags searching is slower when a full match
7566 exists, but faster when no full match exists. Tags in unsorted tags
7567 files may only be found with 'tagbsearch' off.
7568 When the tags file is not sorted, or sorted in a wrong way (not on
7569 ASCII byte value), 'tagbsearch' should be off, or the line given above
7570 must be included in the tags file.
7571 This option doesn't affect commands that find all matching tags (e.g.,
7572 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007574 *'tagcase'* *'tc'*
7575'tagcase' 'tc' string (default "followic")
7576 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007577 This option specifies how case is handled when searching the tags
7578 file:
7579 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007580 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007581 ignore Ignore case
7582 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007583 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007584 NOTE: This option is set to the Vi default value when 'compatible' is
7585 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007586
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007587 *'tagfunc'* *'tfu'*
7588'tagfunc' 'tfu' string (default: empty)
7589 local to buffer
7590 {not available when compiled without the |+eval|
7591 feature}
7592 This option specifies a function to be used to perform tag searches.
7593 The function gets the tag pattern and should return a List of matching
7594 tags. See |tag-function| for an explanation of how to write the
7595 function and an example.
7596
Bram Moolenaar071d4272004-06-13 20:20:40 +00007597 *'taglength'* *'tl'*
7598'taglength' 'tl' number (default 0)
7599 global
7600 If non-zero, tags are significant up to this number of characters.
7601
7602 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7603'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7604 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007605 If on and using a tags file in another directory, file names in that
7606 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007607 NOTE: This option is set to the Vi default value when 'compatible' is
7608 set and to the Vim default value when 'compatible' is reset.
7609
7610 *'tags'* *'tag'* *E433*
7611'tags' 'tag' string (default "./tags,tags", when compiled with
7612 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7613 global or local to buffer |global-local|
7614 Filenames for the tag command, separated by spaces or commas. To
7615 include a space or comma in a file name, precede it with a backslash
7616 (see |option-backslash| about including spaces and backslashes).
7617 When a file name starts with "./", the '.' is replaced with the path
7618 of the current file. But only when the 'd' flag is not included in
7619 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7620 |tags-option|.
7621 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007622 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7623 find all files named "tags" below "/lib". The filename itself cannot
7624 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7625 files called "tags?". {not available when compiled without the
7626 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007627 The |tagfiles()| function can be used to get a list of the file names
7628 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007629 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7630 files are also supported. They are automatically recognized. The
7631 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7632 differences are ignored (MS-Windows). |emacs-tags|
7633 The use of |:set+=| and |:set-=| is preferred when adding or removing
7634 file names from the list. This avoids problems when a future version
7635 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007636
7637 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7638'tagstack' 'tgst' boolean (default on)
7639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640 When on, the |tagstack| is used normally. When off, a ":tag" or
7641 ":tselect" command with an argument will not push the tag onto the
7642 tagstack. A following ":tag" without an argument, a ":pop" command or
7643 any other command that uses the tagstack will use the unmodified
7644 tagstack, but does change the pointer to the active entry.
7645 Resetting this option is useful when using a ":tag" command in a
7646 mapping which should not change the tagstack.
7647
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007648 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007649'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007650 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007651 {only available when compiled with the |+tcl/dyn|
7652 feature}
7653 Specifies the name of the Tcl shared library. The default is
7654 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007655 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007656 This option cannot be set from a |modeline| or in the |sandbox|, for
7657 security reasons.
7658
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 *'term'* *E529* *E530* *E531*
7660'term' string (default is $TERM, if that fails:
7661 in the GUI: "builtin_gui"
7662 on Amiga: "amiga"
7663 on BeOS: "beos-ansi"
7664 on Mac: "mac-ansi"
7665 on MiNT: "vt52"
7666 on MS-DOS: "pcterm"
7667 on OS/2: "os2ansi"
7668 on Unix: "ansi"
7669 on VMS: "ansi"
7670 on Win 32: "win32")
7671 global
7672 Name of the terminal. Used for choosing the terminal control
7673 characters. Environment variables are expanded |:set_env|.
7674 For example: >
7675 :set term=$TERM
7676< See |termcap|.
7677
7678 *'termbidi'* *'tbidi'*
7679 *'notermbidi'* *'notbidi'*
7680'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7681 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007682 {only available when compiled with the |+arabic|
7683 feature}
7684 The terminal is in charge of Bi-directionality of text (as specified
7685 by Unicode). The terminal is also expected to do the required shaping
7686 that some languages (such as Arabic) require.
7687 Setting this option implies that 'rightleft' will not be set when
7688 'arabic' is set and the value of 'arabicshape' will be ignored.
7689 Note that setting 'termbidi' has the immediate effect that
7690 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7691 This option is reset when the GUI is started.
7692 For further details see |arabic.txt|.
7693
7694 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007695'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007696 Macintosh GUI: "macroman")
7697 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007698 Encoding used for the terminal. This specifies what character
7699 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007700 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007701 display). Except for the Mac when 'macatsui' is off, then
7702 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007703 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007704 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007705 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7706 Any attempts to set a different value will be rejected, and an error
7707 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007708 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 because the Win32 system always passes Unicode characters.
7710 When empty, the same encoding is used as for the 'encoding' option.
7711 This is the normal value.
7712 Not all combinations for 'termencoding' and 'encoding' are valid. See
7713 |encoding-table|.
7714 The value for this option must be supported by internal conversions or
7715 iconv(). When this is not possible no conversion will be done and you
7716 will probably experience problems with non-ASCII characters.
7717 Example: You are working with the locale set to euc-jp (Japanese) and
7718 want to edit a UTF-8 file: >
7719 :let &termencoding = &encoding
7720 :set encoding=utf-8
7721< You need to do this when your system has no locale support for UTF-8.
7722
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007723 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007724'termguicolors' 'tgc' boolean (default off)
7725 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007726 {not available when compiled without the
7727 |+termguicolors| feature}
7728 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007729 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007730
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007731 Requires a ISO-8613-3 compatible terminal. If setting this option
7732 does not work (produces a colorless UI) reading |xterm-true-color|
7733 might help.
7734
7735 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7736 is required. Use this check to find out: >
7737 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007738< This requires Vim to be built with the |+vtp| feature.
7739
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007740 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007741 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007742
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007743 *'termwinkey'* *'twk'*
7744'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007745 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007746 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007747 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007748 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007749 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007750< The string must be one key stroke but can be multiple bytes.
7751 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007752 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007753 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007754
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007755 *'termwinscroll'* *'twsl'*
7756'termwinscroll' 'twsl' number (default 10000)
7757 local to buffer
7758 {not available when compiled without the
7759 |+terminal| feature}
7760 Number of scrollback lines to keep. When going over this limit the
7761 first 10% of the scrollback lines are deleted. This is just to reduce
7762 the memory usage. See |Terminal-Normal|.
7763
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007764 *'termwinsize'* *'tws'*
7765'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007766 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007767 Size of the |terminal| window. Format: {rows}x{columns} or
7768 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007769 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007770 - When set with a "x" (e.g., "24x80") the terminal size is not
7771 adjusted to the window size. If the window is smaller only the
7772 top-left part is displayed.
7773 - When set with a "*" (e.g., "10*50") the terminal size follows the
7774 window size, but will not be smaller than the specified rows and/or
7775 columns.
7776 - When rows is zero then use the height of the window.
7777 - When columns is zero then use the width of the window.
7778 - Using "0x0" or "0*0" is the same as empty.
7779
7780 Examples:
7781 "30x0" uses 30 rows and the current window width.
7782 "20*0" uses at least 20 rows and the current window width.
7783 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007784 Note that the command running in the terminal window may still change
7785 the size of the terminal. In that case the Vim window will be
7786 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007787
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007788 *'termwintype'* *'twt'*
7789'termwintype' 'twt' string (default "")
7790 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007791 {only available when compiled with the |terminal|
7792 feature on MS-Windows}
7793 Specify the virtual console (pty) used when opening the terminal
7794 window.
7795
7796 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007797 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007798 "winpty" use winpty, fail if not supported
7799 "conpty" use |ConPTY|, fail if not supported
7800
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007801 |ConPTY| support depends on the platform. Windows 10 October 2018
7802 Update is the first version that supports ConPTY, however it is still
7803 considered unstable. ConPTY might become stable in the next release
7804 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007805 supported then you cannot open a terminal window.
7806
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 *'terse'* *'noterse'*
7808'terse' boolean (default off)
7809 global
7810 When set: Add 's' flag to 'shortmess' option (this makes the message
7811 for a search that hits the start or end of the file not being
7812 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7813 shortens a lot of messages}
7814
7815 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7816'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7817 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007818 This option is obsolete. Use 'fileformats'.
7819 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7820 set to the default value for the current system. When 'textauto' is
7821 reset, 'fileformats' is made empty.
7822 NOTE: This option is set to the Vi default value when 'compatible' is
7823 set and to the Vim default value when 'compatible' is reset.
7824
7825 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7826'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7827 others: default off)
7828 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007829 This option is obsolete. Use 'fileformat'.
7830 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7831 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7832 "unix".
7833
7834 *'textwidth'* *'tw'*
7835'textwidth' 'tw' number (default 0)
7836 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007837 Maximum width of text that is being inserted. A longer line will be
7838 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007839 this.
7840 'textwidth' is set to 0 when the 'paste' option is set and restored
7841 when 'paste' is reset.
7842 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007843 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007844 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 NOTE: This option is set to 0 when 'compatible' is set.
7846
7847 *'thesaurus'* *'tsr'*
7848'thesaurus' 'tsr' string (default "")
7849 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007850 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007851 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7852
7853 Each line in the file should contain words with similar meaning,
7854 separated by non-keyword characters (white space is preferred).
7855 Maximum line length is 510 bytes.
7856
Bram Moolenaard47d5222018-12-09 20:43:55 +01007857 An English word list was added to this github issue:
7858 https://github.com/vim/vim/issues/629#issuecomment-443293282
7859 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7860 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7861 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007862
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007863 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 after a comma are ignored, otherwise spaces are included in the file
7865 name. See |option-backslash| about using backslashes.
7866 The use of |:set+=| and |:set-=| is preferred when adding or removing
7867 directories from the list. This avoids problems when a future version
7868 uses another default.
7869 Backticks cannot be used in this option for security reasons.
7870
7871 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7872'tildeop' 'top' boolean (default off)
7873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007874 When on: The tilde command "~" behaves like an operator.
7875 NOTE: This option is reset when 'compatible' is set.
7876
7877 *'timeout'* *'to'* *'notimeout'* *'noto'*
7878'timeout' 'to' boolean (default on)
7879 global
7880 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007881'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 These two options together determine the behavior when part of a
7884 mapped key sequence or keyboard code has been received:
7885
7886 'timeout' 'ttimeout' action ~
7887 off off do not time out
7888 on on or off time out on :mappings and key codes
7889 off on time out on key codes
7890
7891 If both options are off, Vim will wait until either the complete
7892 mapping or key sequence has been received, or it is clear that there
7893 is no mapping or key sequence for the received characters. For
7894 example: if you have mapped "vl" and Vim has received 'v', the next
7895 character is needed to see if the 'v' is followed by an 'l'.
7896 When one of the options is on, Vim will wait for about 1 second for
7897 the next character to arrive. After that the already received
7898 characters are interpreted as single characters. The waiting time can
7899 be changed with the 'timeoutlen' option.
7900 On slow terminals or very busy systems timing out may cause
7901 malfunctioning cursor keys. If both options are off, Vim waits
7902 forever after an entered <Esc> if there are key codes that start
7903 with <Esc>. You will have to type <Esc> twice. If you do not have
7904 problems with key codes, but would like to have :mapped key
7905 sequences not timing out in 1 second, set the 'ttimeout' option and
7906 reset the 'timeout' option.
7907
7908 NOTE: 'ttimeout' is reset when 'compatible' is set.
7909
7910 *'timeoutlen'* *'tm'*
7911'timeoutlen' 'tm' number (default 1000)
7912 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007913
Bram Moolenaar071d4272004-06-13 20:20:40 +00007914 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007915'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007916 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007917 The time in milliseconds that is waited for a key code or mapped key
7918 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7919 when part of a command has been typed.
7920 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7921 different timeout value for key codes is desired set 'ttimeoutlen' to
7922 a non-negative number.
7923
7924 ttimeoutlen mapping delay key code delay ~
7925 < 0 'timeoutlen' 'timeoutlen'
7926 >= 0 'timeoutlen' 'ttimeoutlen'
7927
7928 The timeout only happens when the 'timeout' and 'ttimeout' options
7929 tell so. A useful setting would be >
7930 :set timeout timeoutlen=3000 ttimeoutlen=100
7931< (time out on mapping after three seconds, time out on key codes after
7932 a tenth of a second).
7933
7934 *'title'* *'notitle'*
7935'title' boolean (default off, on when title can be restored)
7936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 {not available when compiled without the |+title|
7938 feature}
7939 When on, the title of the window will be set to the value of
7940 'titlestring' (if it is not empty), or to:
7941 filename [+=-] (path) - VIM
7942 Where:
7943 filename the name of the file being edited
7944 - indicates the file cannot be modified, 'ma' off
7945 + indicates the file was modified
7946 = indicates the file is read-only
7947 =+ indicates the file is read-only and modified
7948 (path) is the path of the file being edited
7949 - VIM the server name |v:servername| or "VIM"
7950 Only works if the terminal supports setting window titles
7951 (currently Amiga console, Win32 console, all GUI versions and
7952 terminals with a non- empty 't_ts' option - these are Unix xterm and
7953 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7954 *X11*
7955 When Vim was compiled with HAVE_X11 defined, the original title will
7956 be restored if possible. The output of ":version" will include "+X11"
7957 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7958 works for the icon name |'icon'|.
7959 But: When Vim was started with the |-X| argument, restoring the title
7960 will not work (except in the GUI).
7961 If the title cannot be restored, it is set to the value of 'titleold'.
7962 You might want to restore the title outside of Vim then.
7963 When using an xterm from a remote machine you can use this command:
7964 rsh machine_name xterm -display $DISPLAY &
7965 then the WINDOWID environment variable should be inherited and the
7966 title of the window should change back to what it should be after
7967 exiting Vim.
7968
7969 *'titlelen'*
7970'titlelen' number (default 85)
7971 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007972 {not available when compiled without the |+title|
7973 feature}
7974 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007975 title. When the title is longer, only the end of the path name is
7976 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 Using a percentage makes this adapt to the width of the window. But
7978 it won't work perfectly, because the actual number of characters
7979 available also depends on the font used and other things in the title
7980 bar. When 'titlelen' is zero the full path is used. Otherwise,
7981 values from 1 to 30000 percent can be used.
7982 'titlelen' is also used for the 'titlestring' option.
7983
7984 *'titleold'*
7985'titleold' string (default "Thanks for flying Vim")
7986 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007987 {only available when compiled with the |+title|
7988 feature}
7989 This option will be used for the window title when exiting Vim if the
7990 original title cannot be restored. Only happens if 'title' is on or
7991 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007992 This option cannot be set from a |modeline| or in the |sandbox|, for
7993 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007994 *'titlestring'*
7995'titlestring' string (default "")
7996 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 {not available when compiled without the |+title|
7998 feature}
7999 When this option is not empty, it will be used for the title of the
8000 window. This happens only when the 'title' option is on.
8001 Only works if the terminal supports setting window titles (currently
8002 Amiga console, Win32 console, all GUI versions and terminals with a
8003 non-empty 't_ts' option).
8004 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008005 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008006
Bram Moolenaar071d4272004-06-13 20:20:40 +00008007 When this option contains printf-style '%' items, they will be
8008 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008009 This option cannot be set in a modeline when 'modelineexpr' is off.
8010
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 Example: >
8012 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8013 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8014< The value of 'titlelen' is used to align items in the middle or right
8015 of the available space.
8016 Some people prefer to have the file name first: >
8017 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8018< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008019 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008020 separating space only when needed.
8021 NOTE: Use of special characters in 'titlestring' may cause the display
8022 to be garbled (e.g., when it contains a CR or NL character).
8023 {not available when compiled without the |+statusline| feature}
8024
8025 *'toolbar'* *'tb'*
8026'toolbar' 'tb' string (default "icons,tooltips")
8027 global
8028 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8029 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008030 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008031 possible values are:
8032 icons Toolbar buttons are shown with icons.
8033 text Toolbar buttons shown with text.
8034 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008035 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008036 tooltips Tooltips are active for toolbar buttons.
8037 Tooltips refer to the popup help text which appears after the mouse
8038 cursor is placed over a toolbar button for a brief moment.
8039
8040 If you want the toolbar to be shown with icons as well as text, do the
8041 following: >
8042 :set tb=icons,text
8043< Motif and Athena cannot display icons and text at the same time. They
8044 will show icons if both are requested.
8045
8046 If none of the strings specified in 'toolbar' are valid or if
8047 'toolbar' is empty, this option is ignored. If you want to disable
8048 the toolbar, you need to set the 'guioptions' option. For example: >
8049 :set guioptions-=T
8050< Also see |gui-toolbar|.
8051
8052 *'toolbariconsize'* *'tbis'*
8053'toolbariconsize' 'tbis' string (default "small")
8054 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008055 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008056 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008057 tiny Use tiny icons.
8058 small Use small icons (default).
8059 medium Use medium-sized icons.
8060 large Use large icons.
8061 huge Use even larger icons.
8062 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008063 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008064 the current theme. Common dimensions are giant=48x48, huge=32x32,
8065 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066
8067 If 'toolbariconsize' is empty, the global default size as determined
8068 by user preferences or the current theme is used.
8069
8070 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8071'ttybuiltin' 'tbi' boolean (default on)
8072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 When on, the builtin termcaps are searched before the external ones.
8074 When off the builtin termcaps are searched after the external ones.
8075 When this option is changed, you should set the 'term' option next for
8076 the change to take effect, for example: >
8077 :set notbi term=$TERM
8078< See also |termcap|.
8079 Rationale: The default for this option is "on", because the builtin
8080 termcap entries are generally better (many systems contain faulty
8081 xterm entries...).
8082
8083 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8084'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8085 sun-cmd, screen, rxvt, dtterm or
8086 iris-ansi; also on when running Vim in
8087 a DOS console)
8088 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 Indicates a fast terminal connection. More characters will be sent to
8090 the screen for redrawing, instead of using insert/delete line
8091 commands. Improves smoothness of redrawing when there are multiple
8092 windows and the terminal does not support a scrolling region.
8093 Also enables the extra writing of characters at the end of each screen
8094 line for lines that wrap. This helps when using copy/paste with the
8095 mouse in an xterm and other terminals.
8096
8097 *'ttymouse'* *'ttym'*
8098'ttymouse' 'ttym' string (default depends on 'term')
8099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008100 {only in Unix and VMS, doesn't work in the GUI; not
8101 available when compiled without |+mouse|}
8102 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008103 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 *xterm-mouse*
8105 xterm xterm-like mouse handling. The mouse generates
8106 "<Esc>[Mscr", where "scr" is three bytes:
8107 "s" = button state
8108 "c" = column plus 33
8109 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008110 This only works up to 223 columns! See "dec",
8111 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008112 xterm2 Works like "xterm", but with the xterm reporting the
8113 mouse position while the mouse is dragged. This works
8114 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008115 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 work. See below for how Vim detects this
8117 automatically.
8118 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008119 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008121 for the row and column. No other mouse events are
8122 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008123 *dec-mouse*
8124 dec DEC terminal mouse handling. The mouse generates a
8125 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008126 This is also available for an Xterm, if it was
8127 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008128 *jsbterm-mouse*
8129 jsbterm JSB term mouse handling.
8130 *pterm-mouse*
8131 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008132 *urxvt-mouse*
8133 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008134 The mouse works only if the terminal supports this
8135 encoding style, but it does not have 223 columns limit
8136 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008137 *sgr-mouse*
8138 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008139 mouse reporting. The mouse works even in columns
8140 beyond 223. This option is backward compatible with
8141 "xterm2" because it can also decode "xterm2" style
8142 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008143
8144 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008145 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8146 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8148 recognized, if enabled at compile time. DEC terminal mouse codes
8149 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008150 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8151 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008152 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008153 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8154 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8155 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008156 Additionally, if vim is compiled with the |+termresponse| feature and
8157 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008158 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008159 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008160 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8161 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8162 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008163 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8164 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008165 :set t_RV=
8166<
8167 *'ttyscroll'* *'tsl'*
8168'ttyscroll' 'tsl' number (default 999)
8169 global
8170 Maximum number of lines to scroll the screen. If there are more lines
8171 to scroll the window is redrawn. For terminals where scrolling is
8172 very slow and redrawing is not slow this can be set to a small number,
8173 e.g., 3, to speed up displaying.
8174
8175 *'ttytype'* *'tty'*
8176'ttytype' 'tty' string (default from $TERM)
8177 global
8178 Alias for 'term', see above.
8179
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008180 *'undodir'* *'udir'*
8181'undodir' 'udir' string (default ".")
8182 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008183 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008184 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008185 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008186 "." means using the directory of the file. The undo file name for
8187 "file.txt" is ".file.txt.un~".
8188 For other directories the file name is the full path of the edited
8189 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008190 When writing: The first directory that exists is used. "." always
8191 works, no directories after "." will be used for writing.
8192 When reading all entries are tried to find an undo file. The first
8193 undo file that exists is used. When it cannot be read an error is
8194 given, no further entry is used.
8195 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008196 This option cannot be set from a |modeline| or in the |sandbox|, for
8197 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008198
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008199 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008200'undofile' 'udf' boolean (default off)
8201 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008202 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008203 When on, Vim automatically saves undo history to an undo file when
8204 writing a buffer to a file, and restores undo history from the same
8205 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008206 The directory where the undo file is stored is specified by 'undodir'.
8207 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008208 The undo file is not read when 'undoreload' causes the buffer from
8209 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008210 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008211 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008212
Bram Moolenaar071d4272004-06-13 20:20:40 +00008213 *'undolevels'* *'ul'*
8214'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8215 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008216 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008218 is kept in memory, higher numbers will cause more memory to be used.
8219 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008220 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8221 itself: >
8222 set ul=0
8223< But you can also get Vi compatibility by including the 'u' flag in
8224 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008225 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008226 Set to -1 for no undo at all. You might want to do this only for the
8227 current buffer: >
8228 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008229< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008230
8231 The local value is set to -123456 when the global value is to be used.
8232
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008233 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008234
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008235 *'undoreload'* *'ur'*
8236'undoreload' 'ur' number (default 10000)
8237 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008238 Save the whole buffer for undo when reloading it. This applies to the
8239 ":e!" command and reloading for when the buffer changed outside of
8240 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008241 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008242 of lines is smaller than the value of this option.
8243 Set this option to zero to disable undo for a reload.
8244
8245 When saving undo for a reload, any undo file is not read.
8246
8247 Note that this causes the whole buffer to be stored in memory. Set
8248 this option to a lower value if you run out of memory.
8249
Bram Moolenaar071d4272004-06-13 20:20:40 +00008250 *'updatecount'* *'uc'*
8251'updatecount' 'uc' number (default: 200)
8252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008253 After typing this many characters the swap file will be written to
8254 disk. When zero, no swap file will be created at all (see chapter on
8255 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8256 Vim with the "-n" option, see |startup|. When editing in readonly
8257 mode this option will be initialized to 10000.
8258 The swapfile can be disabled per buffer with |'swapfile'|.
8259 When 'updatecount' is set from zero to non-zero, swap files are
8260 created for all buffers that have 'swapfile' set. When 'updatecount'
8261 is set to zero, existing swap files are not deleted.
8262 Also see |'swapsync'|.
8263 This option has no meaning in buffers where |'buftype'| is "nofile"
8264 or "nowrite".
8265
8266 *'updatetime'* *'ut'*
8267'updatetime' 'ut' number (default 4000)
8268 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008269 If this many milliseconds nothing is typed the swap file will be
8270 written to disk (see |crash-recovery|). Also used for the
8271 |CursorHold| autocommand event.
8272
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008273 *'varsofttabstop'* *'vsts'*
8274'varsofttabstop' 'vsts' string (default "")
8275 local to buffer
8276 {only available when compiled with the |+vartabs|
8277 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008278 A list of the number of spaces that a <Tab> counts for while editing,
8279 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8280 width <Tab>s are being inserted, while in fact a mixture of spaces
8281 and <Tab>s is used. Tab widths are separated with commas, with the
8282 final value applying to all subsequent tabs.
8283
8284 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008285 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008286 to use the following: >
8287 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008288< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8289 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008290
8291 Note that the value of |'softtabstop'| will be ignored while
8292 'varsofttabstop' is set.
8293
8294 *'vartabstop'* *'vts'*
8295'vartabstop' 'vts' string (default "")
8296 local to buffer
8297 {only available when compiled with the |+vartabs|
8298 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008299 A list of the number of spaces that a <Tab> in the file counts for,
8300 separated by commas. Each value corresponds to one tab, with the
8301 final value applying to all subsequent tabs. For example: >
8302 :set vartabstop=4,20,10,8
8303< This will make the first tab 4 spaces wide, the second 20 spaces,
8304 the third 10 spaces, and all following tabs 8 spaces.
8305
8306 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8307 is set.
8308
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 *'verbose'* *'vbs'*
8310'verbose' 'vbs' number (default 0)
8311 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 When bigger than zero, Vim will give messages about what it is doing.
8313 Currently, these messages are given:
8314 >= 1 When the viminfo file is read or written.
8315 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008316 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008317 >= 8 Files for which a group of autocommands is executed.
8318 >= 9 Every executed autocommand.
8319 >= 12 Every executed function.
8320 >= 13 When an exception is thrown, caught, finished, or discarded.
8321 >= 14 Anything pending in a ":finally" clause.
8322 >= 15 Every executed Ex command (truncated at 200 characters).
8323
8324 This option can also be set with the "-V" argument. See |-V|.
8325 This option is also set by the |:verbose| command.
8326
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008327 When the 'verbosefile' option is set then the verbose messages are not
8328 displayed.
8329
8330 *'verbosefile'* *'vfile'*
8331'verbosefile' 'vfile' string (default empty)
8332 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008333 When not empty all messages are written in a file with this name.
8334 When the file exists messages are appended.
8335 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008336 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008337 Setting 'verbosefile' to a new value is like making it empty first.
8338 The difference with |:redir| is that verbose messages are not
8339 displayed when 'verbosefile' is set.
8340
Bram Moolenaar071d4272004-06-13 20:20:40 +00008341 *'viewdir'* *'vdir'*
8342'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8343 "$VIM/vimfiles/view",
8344 for Unix: "~/.vim/view",
8345 for Macintosh: "$VIM:vimfiles:view"
8346 for VMS: "sys$login:vimfiles/view"
8347 for RiscOS: "Choices:vimfiles/view")
8348 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008349 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 feature}
8351 Name of the directory where to store files for |:mkview|.
8352 This option cannot be set from a |modeline| or in the |sandbox|, for
8353 security reasons.
8354
8355 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008356'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008357 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008358 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 feature}
8360 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008361 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 word save and restore ~
8363 cursor cursor position in file and in window
8364 folds manually created folds, opened/closed folds and local
8365 fold options
8366 options options and mappings local to a window or buffer (not
8367 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008368 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 slash backslashes in file names replaced with forward
8370 slashes
8371 unix with Unix end-of-line format (single <NL>), even when
8372 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008373 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008374
8375 "slash" and "unix" are useful on Windows when sharing view files
8376 with Unix. The Unix version of Vim cannot source dos format scripts,
8377 but the Windows version of Vim can source unix format scripts.
8378
8379 *'viminfo'* *'vi'* *E526* *E527* *E528*
8380'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008381 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8382 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8383 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008384 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008385 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008386 feature}
8387 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008388 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8389 "NONE".
8390 The string should be a comma separated list of parameters, each
8391 consisting of a single character identifying the particular parameter,
8392 followed by a number or string which specifies the value of that
8393 parameter. If a particular character is left out, then the default
8394 value is used for that parameter. The following is a list of the
8395 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008397 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 ! When included, save and restore global variables that start
8399 with an uppercase letter, and don't contain a lowercase
8400 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008401 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008402 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 " Maximum number of lines saved for each register. Old name of
8405 the '<' item, with the disadvantage that you need to put a
8406 backslash before the ", otherwise it will be recognized as the
8407 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008408 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008409 % When included, save and restore the buffer list. If Vim is
8410 started with a file name argument, the buffer list is not
8411 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008412 buffer list is restored from the viminfo file. Quickfix
8413 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8414 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008415 When followed by a number, the number specifies the maximum
8416 number of buffers that are stored. Without a number all
8417 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008418 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 ' Maximum number of previously edited files for which the marks
8420 are remembered. This parameter must always be included when
8421 'viminfo' is non-empty.
8422 Including this item also means that the |jumplist| and the
8423 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008424 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008425 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008426 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008427 patterns are also saved. When not included, the value of
8428 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008429 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008430 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008431 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008432 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008433 < Maximum number of lines saved for each register. If zero then
8434 registers are not saved. When not included, all lines are
8435 saved. '"' is the old name for this item.
8436 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008437 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008438 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008439 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008440 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008441 c When included, convert the text in the viminfo file from the
8442 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008443 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008444 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 f Whether file marks need to be stored. If zero, file marks ('0
8446 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008447 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008448 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008449 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008450 h Disable the effect of 'hlsearch' when loading the viminfo
8451 file. When not included, it depends on whether ":nohlsearch"
8452 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008453 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008455 the 'n'. Must be at the end of the option! If the
8456 'viminfofile' option is set, that file name overrides the one
8457 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008458 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008459 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 r Removable media. The argument is a string (up to the next
8461 ','). This parameter can be given several times. Each
8462 specifies the start of a path for which no marks will be
8463 stored. This is to avoid removable media. For MS-DOS you
8464 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8465 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8466 ignored. Maximum length of each 'r' argument is 50
8467 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008468 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008469 s Maximum size of an item in Kbyte. If zero then registers are
8470 not saved. Currently only applies to registers. The default
8471 "s10" will exclude registers with more than 10 Kbyte of text.
8472 Also see the '<' item above: line count limit.
8473
8474 Example: >
8475 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8476<
8477 '50 Marks will be remembered for the last 50 files you
8478 edited.
8479 <1000 Contents of registers (up to 1000 lines each) will be
8480 remembered.
8481 s100 Registers with more than 100 Kbyte text are skipped.
8482 :0 Command-line history will not be saved.
8483 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8484 no / Since '/' is not specified, the default will be used,
8485 that is, save all of the search history, and also the
8486 previous search and substitute patterns.
8487 no % The buffer list will not be saved nor read back.
8488 no h 'hlsearch' highlighting will be restored.
8489
8490 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8491 load the contents of the file, this is not done automatically.
8492
8493 This option cannot be set from a |modeline| or in the |sandbox|, for
8494 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008495 NOTE: This option is set to the Vim default value when 'compatible'
8496 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008497
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008498 *'viminfofile'* *'vif'*
8499'viminfofile' 'vif' string (default: "")
8500 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008501 {not available when compiled without the |+viminfo|
8502 feature}
8503 When non-empty, overrides the file name used for viminfo.
8504 When equal to "NONE" no viminfo file will be read or written.
8505 This option can be set with the |-i| command line flag. The |--clean|
8506 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008507 This option cannot be set from a |modeline| or in the |sandbox|, for
8508 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008509
Bram Moolenaar071d4272004-06-13 20:20:40 +00008510 *'virtualedit'* *'ve'*
8511'virtualedit' 've' string (default "")
8512 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008513 {not available when compiled without the
8514 |+virtualedit| feature}
8515 A comma separated list of these words:
8516 block Allow virtual editing in Visual block mode.
8517 insert Allow virtual editing in Insert mode.
8518 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008519 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008520
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008522 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008523 of the line. Useful for selecting a rectangle in Visual mode and
8524 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008525 "onemore" is not the same, it will only allow moving the cursor just
8526 after the last character of the line. This makes some commands more
8527 consistent. Previously the cursor was always past the end of the line
8528 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008529 break some plugins or Vim scripts. For example because |l| can move
8530 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008531 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008532 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008533 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008534 It doesn't make sense to combine "all" with "onemore", but you will
8535 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008536 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537
8538 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8539'visualbell' 'vb' boolean (default off)
8540 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008541 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008542 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008543 use: >
8544 :set vb t_vb=
8545< If you want a short flash, you can use this on many terminals: >
8546 :set vb t_vb=[?5h$<100>[?5l
8547< Here $<100> specifies the time, you can use a smaller or bigger value
8548 to get a shorter or longer flash.
8549
8550 Note: Vim will limit the bell to once per half a second. This avoids
8551 having to wait for the flashing to finish when there are lots of
8552 bells, e.g. on key repeat. This also happens without 'visualbell'
8553 set.
8554
Bram Moolenaar071d4272004-06-13 20:20:40 +00008555 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8556 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8557 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008558
8559 Note: When the GUI starts, 't_vb' is reset to its default value. You
8560 might want to set it again in your |gvimrc|.
8561
Bram Moolenaar071d4272004-06-13 20:20:40 +00008562 Does not work on the Amiga, you always get a screen flash.
8563 Also see 'errorbells'.
8564
8565 *'warn'* *'nowarn'*
8566'warn' boolean (default on)
8567 global
8568 Give a warning message when a shell command is used while the buffer
8569 has been changed.
8570
8571 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8572'weirdinvert' 'wiv' boolean (default off)
8573 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008574 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008575 It is provided for backwards compatibility with version 4.x.
8576 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8577 vice versa. Has no effect when the GUI is running.
8578
8579 *'whichwrap'* *'ww'*
8580'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008582 Allow specified keys that move the cursor left/right to move to the
8583 previous/next line when the cursor is on the first/last character in
8584 the line. Concatenate characters to allow this for these keys:
8585 char key mode ~
8586 b <BS> Normal and Visual
8587 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008588 h "h" Normal and Visual (not recommended)
8589 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008590 < <Left> Normal and Visual
8591 > <Right> Normal and Visual
8592 ~ "~" Normal
8593 [ <Left> Insert and Replace
8594 ] <Right> Insert and Replace
8595 For example: >
8596 :set ww=<,>,[,]
8597< allows wrap only when cursor keys are used.
8598 When the movement keys are used in combination with a delete or change
8599 operator, the <EOL> also counts for a character. This makes "3h"
8600 different from "3dh" when the cursor crosses the end of a line. This
8601 is also true for "x" and "X", because they do the same as "dl" and
8602 "dh". If you use this, you may also want to use the mapping
8603 ":map <BS> X" to make backspace delete the character in front of the
8604 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008605 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008606 line (not an empty line) then it will not move to the next line. This
8607 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008608 NOTE: This option is set to the Vi default value when 'compatible' is
8609 set and to the Vim default value when 'compatible' is reset.
8610
8611 *'wildchar'* *'wc'*
8612'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8613 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008614 Character you have to type to start wildcard expansion in the
8615 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008616 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008617 The character is not recognized when used inside a macro. See
8618 'wildcharm' for that.
8619 Although 'wc' is a number option, you can set it to a special key: >
8620 :set wc=<Esc>
8621< NOTE: This option is set to the Vi default value when 'compatible' is
8622 set and to the Vim default value when 'compatible' is reset.
8623
8624 *'wildcharm'* *'wcm'*
8625'wildcharm' 'wcm' number (default: none (0))
8626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008628 recognized when used inside a macro. You can find "spare" command-line
8629 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008630 you'll never actually type 'wildcharm', just use it in mappings that
8631 automatically invoke completion mode, e.g.: >
8632 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008633 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634< Then after typing :ss you can use CTRL-P & CTRL-N.
8635
8636 *'wildignore'* *'wig'*
8637'wildignore' 'wig' string (default "")
8638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 {not available when compiled without the |+wildignore|
8640 feature}
8641 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008642 patterns is ignored when expanding |wildcards|, completing file or
8643 directory names, and influences the result of |expand()|, |glob()| and
8644 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008645 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8646 Also see 'suffixes'.
8647 Example: >
8648 :set wildignore=*.o,*.obj
8649< The use of |:set+=| and |:set-=| is preferred when adding or removing
8650 a pattern from the list. This avoids problems when a future version
8651 uses another default.
8652
Bram Moolenaar94950a92010-12-02 16:01:29 +01008653
Bram Moolenaar81af9252010-12-10 20:35:50 +01008654 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008655'wildignorecase' 'wic' boolean (default off)
8656 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008657 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008658 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008659 Does not apply when the shell is used to expand wildcards, which
8660 happens when there are special characters.
8661
8662
Bram Moolenaar071d4272004-06-13 20:20:40 +00008663 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008664'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008666 {not available if compiled without the |+wildmenu|
8667 feature}
8668 When 'wildmenu' is on, command-line completion operates in an enhanced
8669 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8670 the possible matches are shown just above the command line, with the
8671 first match highlighted (overwriting the status line, if there is
8672 one). Keys that show the previous/next match, such as <Tab> or
8673 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8674 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8675 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008676 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008677 If there are more matches than can fit in the line, a ">" is shown on
8678 the right and/or a "<" is shown on the left. The status line scrolls
8679 as needed.
8680 The "wildmenu" mode is abandoned when a key is hit that is not used
8681 for selecting a completion.
8682 While the "wildmenu" is active the following keys have special
8683 meanings:
8684
8685 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8686 <Down> - in filename/menu name completion: move into a
8687 subdirectory or submenu.
8688 <CR> - in menu completion, when the cursor is just after a
8689 dot: move into a submenu.
8690 <Up> - in filename/menu name completion: move up into
8691 parent directory or parent menu.
8692
8693 This makes the menus accessible from the console |console-menus|.
8694
8695 If you prefer the <Left> and <Right> keys to move the cursor instead
8696 of selecting a different match, use this: >
8697 :cnoremap <Left> <Space><BS><Left>
8698 :cnoremap <Right> <Space><BS><Right>
8699<
8700 The "WildMenu" highlighting is used for displaying the current match
8701 |hl-WildMenu|.
8702
8703 *'wildmode'* *'wim'*
8704'wildmode' 'wim' string (Vim default: "full")
8705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008706 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008707 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008708 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008709 first part specifies the behavior for the first use of 'wildchar',
8710 The second part for the second use, etc.
8711 These are the possible values for each part:
8712 "" Complete only the first match.
8713 "full" Complete the next full match. After the last match,
8714 the original string is used and then the first match
8715 again.
8716 "longest" Complete till longest common string. If this doesn't
8717 result in a longer string, use the next part.
8718 "longest:full" Like "longest", but also start 'wildmenu' if it is
8719 enabled.
8720 "list" When more than one match, list all matches.
8721 "list:full" When more than one match, list all matches and
8722 complete first match.
8723 "list:longest" When more than one match, list all matches and
8724 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008725 "list:lastused" When more than one buffer matches, sort buffers
8726 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008727 When there is only a single match, it is fully completed in all cases.
8728
8729 Examples: >
8730 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008731< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008732 :set wildmode=longest,full
8733< Complete longest common string, then each full match >
8734 :set wildmode=list:full
8735< List all matches and complete each full match >
8736 :set wildmode=list,full
8737< List all matches without completing, then each full match >
8738 :set wildmode=longest,list
8739< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008740 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008741
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008742 *'wildoptions'* *'wop'*
8743'wildoptions' 'wop' string (default "")
8744 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008745 {not available when compiled without the |+wildignore|
8746 feature}
8747 A list of words that change how command line completion is done.
8748 Currently only one word is allowed:
8749 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008750 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008751 is displayed per line. Often used tag kinds are:
8752 d #define
8753 f function
8754 Also see |cmdline-completion|.
8755
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 *'winaltkeys'* *'wak'*
8757'winaltkeys' 'wak' string (default "menu")
8758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 {only used in Win32, Motif, GTK and Photon GUI}
8760 Some GUI versions allow the access to menu entries by using the ALT
8761 key in combination with a character that appears underlined in the
8762 menu. This conflicts with the use of the ALT key for mappings and
8763 entering special characters. This option tells what to do:
8764 no Don't use ALT keys for menus. ALT key combinations can be
8765 mapped, but there is no automatic handling. This can then be
8766 done with the |:simalt| command.
8767 yes ALT key handling is done by the windowing system. ALT key
8768 combinations cannot be mapped.
8769 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008770 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008771 keys can be mapped.
8772 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8773 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008774 This option is not used for <F10>; on Win32 and with GTK <F10> will
8775 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008777 *'wincolor'* *'wcr'*
8778'wincolor' 'wcr' string (default empty)
8779 local to window
8780 Highlight group name to use for this window instead of the Normal
8781 color |hl-Normal|.
8782
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008783 *'window'* *'wi'*
8784'window' 'wi' number (default screen height - 1)
8785 global
8786 Window height. Do not confuse this with the height of the Vim window,
8787 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008788 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8789 value is smaller than 'lines' minus one. The screen will scroll
8790 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008791 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8792 in a much smarter way, taking care of wrapping lines.
8793 When resizing the Vim window, the value is smaller than 1 or more than
8794 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008795
Bram Moolenaar071d4272004-06-13 20:20:40 +00008796 *'winheight'* *'wh'* *E591*
8797'winheight' 'wh' number (default 1)
8798 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008799 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008800 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008801 focus goes to a window that is smaller, its size is increased, at the
8802 cost of the height of other windows.
8803 Set 'winheight' to a small number for normal editing.
8804 Set it to 999 to make the current window fill most of the screen.
8805 Other windows will be only 'winminheight' high. This has the drawback
8806 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8807 to create only two windows, set the option after startup is done,
8808 using the |VimEnter| event: >
8809 au VimEnter * set winheight=999
8810< Minimum value is 1.
8811 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008812 height of the current window.
8813 'winheight' applies to the current window. Use 'winminheight' to set
8814 the minimal height for other windows.
8815
8816 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8817'winfixheight' 'wfh' boolean (default off)
8818 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008820 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8821 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 The height may be changed anyway when running out of room.
8823
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008824 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8825'winfixwidth' 'wfw' boolean (default off)
8826 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008827 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008828 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008829 The width may be changed anyway when running out of room.
8830
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 *'winminheight'* *'wmh'*
8832'winminheight' 'wmh' number (default 1)
8833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 The minimal height of a window, when it's not the current window.
8835 This is a hard minimum, windows will never become smaller.
8836 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8837 status bar) if necessary. They will return to at least one line when
8838 they become active (since the cursor has to have somewhere to go.)
8839 Use 'winheight' to set the minimal height of the current window.
8840 This option is only checked when making a window smaller. Don't use a
8841 large number, it will cause errors when opening more than a few
8842 windows. A value of 0 to 3 is reasonable.
8843
8844 *'winminwidth'* *'wmw'*
8845'winminwidth' 'wmw' number (default 1)
8846 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008847 The minimal width of a window, when it's not the current window.
8848 This is a hard minimum, windows will never become smaller.
8849 When set to zero, windows may be "squashed" to zero columns (i.e. just
8850 a vertical separator) if necessary. They will return to at least one
8851 line when they become active (since the cursor has to have somewhere
8852 to go.)
8853 Use 'winwidth' to set the minimal width of the current window.
8854 This option is only checked when making a window smaller. Don't use a
8855 large number, it will cause errors when opening more than a few
8856 windows. A value of 0 to 12 is reasonable.
8857
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008858 *'winptydll'*
8859'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8860 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008861 {only available when compiled with the |terminal|
8862 feature on MS-Windows}
8863 Specifies the name of the winpty shared library, used for the
8864 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008865 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008866 a fallback.
8867 Environment variables are expanded |:set_env|.
8868 This option cannot be set from a |modeline| or in the |sandbox|, for
8869 security reasons.
8870
Bram Moolenaar071d4272004-06-13 20:20:40 +00008871 *'winwidth'* *'wiw'* *E592*
8872'winwidth' 'wiw' number (default 20)
8873 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008874 Minimal number of columns for the current window. This is not a hard
8875 minimum, Vim will use fewer columns if there is not enough room. If
8876 the current window is smaller, its size is increased, at the cost of
8877 the width of other windows. Set it to 999 to make the current window
8878 always fill the screen. Set it to a small number for normal editing.
8879 The width is not adjusted after one of the commands to change the
8880 width of the current window.
8881 'winwidth' applies to the current window. Use 'winminwidth' to set
8882 the minimal width for other windows.
8883
8884 *'wrap'* *'nowrap'*
8885'wrap' boolean (default on)
8886 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008887 This option changes how text is displayed. It doesn't change the text
8888 in the buffer, see 'textwidth' for that.
8889 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008890 displaying continues on the next line. When off lines will not wrap
8891 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 moved to a part that is not shown, the screen will scroll
8893 horizontally.
8894 The line will be broken in the middle of a word if necessary. See
8895 'linebreak' to get the break at a word boundary.
8896 To make scrolling horizontally a bit more useful, try this: >
8897 :set sidescroll=5
8898 :set listchars+=precedes:<,extends:>
8899< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008900 This option can't be set from a |modeline| when the 'diff' option is
8901 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008902
8903 *'wrapmargin'* *'wm'*
8904'wrapmargin' 'wm' number (default 0)
8905 local to buffer
8906 Number of characters from the right window border where wrapping
8907 starts. When typing text beyond this limit, an <EOL> will be inserted
8908 and inserting continues on the next line.
8909 Options that add a margin, such as 'number' and 'foldcolumn', cause
8910 the text width to be further reduced. This is Vi compatible.
8911 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008912 This option is set to 0 when 'paste' is set and restored when 'paste'
8913 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008914 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008915
8916 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8917'wrapscan' 'ws' boolean (default on) *E384* *E385*
8918 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008919 Searches wrap around the end of the file. Also applies to |]s| and
8920 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921
8922 *'write'* *'nowrite'*
8923'write' boolean (default on)
8924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925 Allows writing files. When not set, writing a file is not allowed.
8926 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008927 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008928 argument. Filtering text is still possible, even though this requires
8929 writing a temporary file.
8930
8931 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8932'writeany' 'wa' boolean (default off)
8933 global
8934 Allows writing to any file with no need for "!" override.
8935
8936 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8937'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8938 otherwise)
8939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008940 Make a backup before overwriting a file. The backup is removed after
8941 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008942 also on.
8943 WARNING: Switching this option off means that when Vim fails to write
8944 your buffer correctly and then, for whatever reason, Vim exits, you
8945 lose both the original file and what you were writing. Only reset
8946 this option if your file system is almost full and it makes the write
8947 fail (and make sure not to exit Vim until the write was successful).
8948 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008949 When the 'backupskip' pattern matches, a backup is not made anyway.
8950 NOTE: This option is set to the default value when 'compatible' is
8951 set.
8952
8953 *'writedelay'* *'wd'*
8954'writedelay' 'wd' number (default 0)
8955 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008956 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008957 screen. When non-zero, characters are sent to the terminal one by
8958 one. For MS-DOS pcterm this does not work. For debugging purposes.
8959
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008960 vim:tw=78:ts=8:noet:ft=help:norl: