blob: c7247ff9da5b69adff7091ffcf557a694e527751 [file] [log] [blame]
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001*options.txt* For Vim version 8.1. Last change: 2019 Aug 21
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.
859
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200860 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200861 color from the terminal. If the returned RGB value is dark/light and
862 'background' is not dark/light, 'background' will be set and the
863 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200864 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100865 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200866
Bram Moolenaar071d4272004-06-13 20:20:40 +0000867 When starting the GUI, the default value for 'background' will be
868 "light". When the value is not set in the .gvimrc, and Vim detects
869 that the background is actually quite dark, 'background' is set to
870 "dark". But this happens only AFTER the .gvimrc file has been read
871 (because the window needs to be opened to find the actual background
872 color). To get around this, force the GUI window to be opened by
873 putting a ":gui" command in the .gvimrc file, before where the value
874 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200875
876 For MS-DOS, Windows and OS/2 the default is "dark".
877 For other systems "dark" is used when 'term' is "linux",
878 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
879 background. Otherwise the default is "light".
880
Bram Moolenaarc572da52017-08-27 16:52:01 +0200881 The |:terminal| command and the |term_start()| function use the
882 'background' value to decide whether the terminal window will start
883 with a white or black background.
884
Bram Moolenaar071d4272004-06-13 20:20:40 +0000885 Normally this option would be set in the .vimrc file. Possibly
886 depending on the terminal name. Example: >
887 :if &term == "pcterm"
888 : set background=dark
889 :endif
890< When this option is set, the default settings for the highlight groups
891 will change. To use other settings, place ":highlight" commands AFTER
892 the setting of the 'background' option.
893 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
894 to select the colors for syntax highlighting. After changing this
895 option, you must load syntax.vim again to see the result. This can be
896 done with ":syntax on".
897
898 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200899'backspace' 'bs' string (default "", set to "indent,eol,start"
900 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000901 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000902 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
903 mode. This is a list of items, separated by commas. Each item allows
904 a way to backspace over something:
905 value effect ~
906 indent allow backspacing over autoindent
907 eol allow backspacing over line breaks (join lines)
908 start allow backspacing over the start of insert; CTRL-W and CTRL-U
909 stop once at the start of insert.
910
911 When the value is empty, Vi compatible backspacing is used.
912
913 For backwards compatibility with version 5.4 and earlier:
914 value effect ~
915 0 same as ":set backspace=" (Vi compatible)
916 1 same as ":set backspace=indent,eol"
917 2 same as ":set backspace=indent,eol,start"
918
919 See |:fixdel| if your <BS> or <Del> key does not do what you want.
920 NOTE: This option is set to "" when 'compatible' is set.
921
922 *'backup'* *'bk'* *'nobackup'* *'nobk'*
923'backup' 'bk' boolean (default off)
924 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000925 Make a backup before overwriting a file. Leave it around after the
926 file has been successfully written. If you do not want to keep the
927 backup file, but you do want a backup while the file is being
928 written, reset this option and set the 'writebackup' option (this is
929 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000930 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000931 |backup-table| for more explanations.
932 When the 'backupskip' pattern matches, a backup is not made anyway.
933 When 'patchmode' is set, the backup may be renamed to become the
934 oldest version of a file.
935 NOTE: This option is reset when 'compatible' is set.
936
937 *'backupcopy'* *'bkc'*
938'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200939 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000940 When writing a file and a backup is made, this option tells how it's
941 done. This is a comma separated list of words.
942
943 The main values are:
944 "yes" make a copy of the file and overwrite the original one
945 "no" rename the file and write a new one
946 "auto" one of the previous, what works best
947
948 Extra values that can be combined with the ones above are:
949 "breaksymlink" always break symlinks when writing
950 "breakhardlink" always break hardlinks when writing
951
952 Making a copy and overwriting the original file:
953 - Takes extra time to copy the file.
954 + When the file has special attributes, is a (hard/symbolic) link or
955 has a resource fork, all this is preserved.
956 - When the file is a link the backup will have the name of the link,
957 not of the real file.
958
959 Renaming the file and writing a new one:
960 + It's fast.
961 - Sometimes not all attributes of the file can be copied to the new
962 file.
963 - When the file is a link the new file will not be a link.
964
965 The "auto" value is the middle way: When Vim sees that renaming file
966 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000967 the file is not a link) that is used. When problems are expected, a
968 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000969
970 The "breaksymlink" and "breakhardlink" values can be used in
971 combination with any of "yes", "no" and "auto". When included, they
972 force Vim to always break either symbolic or hard links by doing
973 exactly what the "no" option does, renaming the original file to
974 become the backup and writing a new file in its place. This can be
975 useful for example in source trees where all the files are symbolic or
976 hard links and any changes should stay in the local source tree, not
977 be propagated back to the original source.
978 *crontab*
979 One situation where "no" and "auto" will cause problems: A program
980 that opens a file, invokes Vim to edit that file, and then tests if
981 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000982 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000983 example.
984
985 When a copy is made, the original file is truncated and then filled
986 with the new text. This means that protection bits, owner and
987 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000988 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000989 group of the backup is set to the group of the original file. If this
990 fails, the protection bits for the group are made the same as for
991 others.
992
993 When the file is renamed this is the other way around: The backup has
994 the same attributes of the original file, and the newly written file
995 is owned by the current user. When the file was a (hard/symbolic)
996 link, the new file will not! That's why the "auto" value doesn't
997 rename when the file is a link. The owner and group of the newly
998 written file will be set to the same ones as the original file, but
999 the system may refuse to do this. In that case the "auto" value will
1000 again not rename the file.
1001
Bram Moolenaar036986f2017-03-16 17:41:02 +01001002 NOTE: This option is set to the Vi default value when 'compatible' is
1003 set and to the Vim default value when 'compatible' is reset.
1004
Bram Moolenaar071d4272004-06-13 20:20:40 +00001005 *'backupdir'* *'bdir'*
1006'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001007 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 for Unix: ".,~/tmp,~/")
1009 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 List of directories for the backup file, separated with commas.
1011 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001012 where this is possible. The directory must exist, Vim will not
1013 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001014 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001015 impossible!). Writing may fail because of this.
1016 - A directory "." means to put the backup file in the same directory
1017 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001018 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001019 put the backup file relative to where the edited file is. The
1020 leading "." is replaced with the path name of the edited file.
1021 ("." inside a directory name has no special meaning).
1022 - Spaces after the comma are ignored, other spaces are considered part
1023 of the directory name. To have a space at the start of a directory
1024 name, precede it with a backslash.
1025 - To include a comma in a directory name precede it with a backslash.
1026 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001027 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001028 the backup file name will be built from the complete path to the
1029 file with all path separators changed to percent '%' signs. This
1030 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001031 On Win32, it is also possible to end with "\\". However, When a
1032 separating comma is following, you must use "//", since "\\" will
1033 include the comma in the file name. Therefore it is recommended to
1034 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001035 - Environment variables are expanded |:set_env|.
1036 - Careful with '\' characters, type one before a space, type two to
1037 get one in the option (see |option-backslash|), for example: >
1038 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1039< - For backwards compatibility with Vim version 3.0 a '>' at the start
1040 of the option is removed.
1041 See also 'backup' and 'writebackup' options.
1042 If you want to hide your backup files on Unix, consider this value: >
1043 :set backupdir=./.backup,~/.backup,.,/tmp
1044< You must create a ".backup" directory in each directory and in your
1045 home directory for this to work properly.
1046 The use of |:set+=| and |:set-=| is preferred when adding or removing
1047 directories from the list. This avoids problems when a future version
1048 uses another default.
1049 This option cannot be set from a |modeline| or in the |sandbox|, for
1050 security reasons.
1051
1052 *'backupext'* *'bex'* *E589*
1053'backupext' 'bex' string (default "~", for VMS: "_")
1054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001055 String which is appended to a file name to make the name of the
1056 backup file. The default is quite unusual, because this avoids
1057 accidentally overwriting existing files with a backup file. You might
1058 prefer using ".bak", but make sure that you don't have files with
1059 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001060 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001061
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001062 If you like to keep a lot of backups, you could use a BufWritePre
1063 autocommand to change 'backupext' just before writing the file to
1064 include a timestamp. >
1065 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1066< Use 'backupdir' to put the backup in a different directory.
1067
Bram Moolenaar071d4272004-06-13 20:20:40 +00001068 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001069'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1070 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1071 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001072 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001073 {not available when compiled without the |+wildignore|
1074 feature}
1075 A list of file patterns. When one of the patterns matches with the
1076 name of the file which is written, no backup file is created. Both
1077 the specified file name and the full path name of the file are used.
1078 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1079 Watch out for special characters, see |option-backslash|.
1080 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001081 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001082
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001083 WARNING: Not having a backup file means that when Vim fails to write
1084 your buffer correctly and then, for whatever reason, Vim exits, you
1085 lose both the original file and what you were writing. Only disable
1086 backups if you don't care about losing the file.
1087
Bram Moolenaar02467872007-05-06 13:22:01 +00001088 Note that environment variables are not expanded. If you want to use
1089 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001090 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001091
1092< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001093 backup would be made by renaming the original file crontab won't see
1094 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001095
1096 *'balloondelay'* *'bdlay'*
1097'balloondelay' 'bdlay' number (default: 600)
1098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001099 {only available when compiled with the |+balloon_eval|
1100 feature}
1101 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1102
1103 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1104'ballooneval' 'beval' boolean (default off)
1105 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001106 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001107 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001108 Switch on the |balloon-eval| functionality for the GUI.
1109
1110 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1111 *'nobevalterm'*
1112'balloonevalterm' 'bevalterm' boolean (default off)
1113 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001114 {only available when compiled with the
1115 |+balloon_eval_term| feature}
1116 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001117
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001118 *'balloonexpr'* *'bexpr'*
1119'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001120 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 {only available when compiled with the |+balloon_eval|
1122 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001123 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001124 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1125 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001126
1127 v:beval_bufnr number of the buffer in which balloon is going to show
1128 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001129 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001130 v:beval_lnum line number
1131 v:beval_col column number (byte index)
1132 v:beval_text word under or after the mouse pointer
1133
Bram Moolenaar54775062019-07-31 21:07:14 +02001134 Instead of showing a balloon, which is limited to plain text, consider
1135 using a popup window, see |popup_beval_example|. A popup window can
1136 use highlighting and show a border.
1137
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001138 The evaluation of the expression must not have side effects!
1139 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001140 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001141 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001142 \', column ' . v:beval_col .
1143 \ ' of file ' . bufname(v:beval_bufnr) .
1144 \ ' on word "' . v:beval_text . '"'
1145 endfunction
1146 set bexpr=MyBalloonExpr()
1147 set ballooneval
1148<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001149 Also see |balloon_show()|, it can be used if the content of the balloon
1150 is to be fetched asynchronously. In that case evaluating
1151 'balloonexpr' should result in an empty string. If you get a balloon
1152 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001153
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001154 NOTE: The balloon is displayed only if the cursor is on a text
1155 character. If the result of evaluating 'balloonexpr' is not empty,
1156 Vim does not try to send a message to an external debugger (Netbeans
1157 or Sun Workshop).
1158
Bram Moolenaar30b65812012-07-12 22:01:11 +02001159 The expression will be evaluated in the |sandbox| when set from a
1160 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001161 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001162
1163 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001164 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001165
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001166 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001167 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001168< When they are supported "\n" characters will start a new line. If the
1169 expression evaluates to a |List| this is equal to using each List item
1170 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001171 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001172
Bram Moolenaar165bc692015-07-21 17:53:25 +02001173 *'belloff'* *'bo'*
1174'belloff' 'bo' string (default "")
1175 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001176 Specifies for which events the bell will not be rung. It is a comma
1177 separated list of items. For each item that is present, the bell
1178 will be silenced. This is most useful to specify specific events in
1179 insert mode to be silenced.
1180
1181 item meaning when present ~
1182 all All events.
1183 backspace When hitting <BS> or <Del> and deleting results in an
1184 error.
1185 cursor Fail to move around using the cursor keys or
1186 <PageUp>/<PageDown> in |Insert-mode|.
1187 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1188 |i_CTRL-X_CTRL-T|.
1189 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1190 |i_CTRL-E|.
1191 ctrlg Unknown Char after <C-G> in Insert mode.
1192 error Other Error occurred (e.g. try to join last line)
1193 (mostly used in |Normal-mode| or |Cmdline-mode|).
1194 esc hitting <Esc> in |Normal-mode|.
1195 ex In |Visual-mode|, hitting |Q| results in an error.
1196 hangul Error occurred when using hangul input.
1197 insertmode Pressing <Esc> in 'insertmode'.
1198 lang Calling the beep module for Lua/Mzscheme/TCL.
1199 mess No output available for |g<|.
1200 showmatch Error occurred for 'showmatch' function.
1201 operator Empty region error |cpo-E|.
1202 register Unknown register after <C-R> in |Insert-mode|.
1203 shell Bell from shell output |:!|.
1204 spell Error happened on spell suggest.
1205 wildmode More matches in |cmdline-completion| available
1206 (depends on the 'wildmode' setting).
1207
Bram Moolenaar036986f2017-03-16 17:41:02 +01001208 This is most useful to fine tune when in Insert mode the bell should
1209 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001210 indicate that an error occurred. It can be silenced by adding the
1211 "error" keyword.
1212
Bram Moolenaar071d4272004-06-13 20:20:40 +00001213 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1214'binary' 'bin' boolean (default off)
1215 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 This option should be set before editing a binary file. You can also
1217 use the |-b| Vim argument. When this option is switched on a few
1218 options will be changed (also when it already was on):
1219 'textwidth' will be set to 0
1220 'wrapmargin' will be set to 0
1221 'modeline' will be off
1222 'expandtab' will be off
1223 Also, 'fileformat' and 'fileformats' options will not be used, the
1224 file is read and written like 'fileformat' was "unix" (a single <NL>
1225 separates lines).
1226 The 'fileencoding' and 'fileencodings' options will not be used, the
1227 file is read without conversion.
1228 NOTE: When you start editing a(nother) file while the 'bin' option is
1229 on, settings from autocommands may change the settings again (e.g.,
1230 'textwidth'), causing trouble when editing. You might want to set
1231 'bin' again when the file has been loaded.
1232 The previous values of these options are remembered and restored when
1233 'bin' is switched from on to off. Each buffer has its own set of
1234 saved option values.
1235 To edit a file with 'binary' set you can use the |++bin| argument.
1236 This avoids you have to do ":set bin", which would have effect for all
1237 files you edit.
1238 When writing a file the <EOL> for the last line is only written if
1239 there was one in the original file (normally Vim appends an <EOL> to
1240 the last line if there is none; this would make the file longer). See
1241 the 'endofline' option.
1242
1243 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1244'bioskey' 'biosk' boolean (default on)
1245 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001246 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001247 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001248
1249 *'bomb'* *'nobomb'*
1250'bomb' boolean (default off)
1251 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001252 When writing a file and the following conditions are met, a BOM (Byte
1253 Order Mark) is prepended to the file:
1254 - this option is on
1255 - the 'binary' option is off
1256 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1257 endian variants.
1258 Some applications use the BOM to recognize the encoding of the file.
1259 Often used for UCS-2 files on MS-Windows. For other applications it
1260 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001261 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001262 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1263 check for the presence of the BOM is done and 'bomb' set accordingly.
1264 Unless 'binary' is set, it is removed from the first line, so that you
1265 don't see it when editing. When you don't change the options, the BOM
1266 will be restored when writing the file.
1267
1268 *'breakat'* *'brk'*
1269'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1270 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001271 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001272 feature}
1273 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001274 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1275 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001276
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001277 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001278'breakindent' 'bri' boolean (default off)
1279 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280 {not available when compiled without the |+linebreak|
1281 feature}
1282 Every wrapped line will continue visually indented (same amount of
1283 space as the beginning of that line), thus preserving horizontal blocks
1284 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001285 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001286
1287 *'breakindentopt'* *'briopt'*
1288'breakindentopt' 'briopt' string (default empty)
1289 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001290 {not available when compiled without the |+linebreak|
1291 feature}
1292 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001293 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001294 min:{n} Minimum text width that will be kept after
1295 applying 'breakindent', even if the resulting
1296 text should normally be narrower. This prevents
1297 text indented almost to the right window border
1298 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001299 shift:{n} After applying 'breakindent', the wrapped line's
1300 beginning will be shifted by the given number of
1301 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001302 indentation (negative) or emphasizing the line
1303 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001304 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 additional indent.
1306 The default value for min is 20 and shift is 0.
1307
Bram Moolenaar071d4272004-06-13 20:20:40 +00001308 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001309'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001311 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001313 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001314 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 buffer Use the directory of the related buffer.
1316 current Use the current directory.
1317 {path} Use the specified directory
1318
1319 *'bufhidden'* *'bh'*
1320'bufhidden' 'bh' string (default: "")
1321 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001322 This option specifies what happens when a buffer is no longer
1323 displayed in a window:
1324 <empty> follow the global 'hidden' option
1325 hide hide the buffer (don't unload it), also when 'hidden'
1326 is not set
1327 unload unload the buffer, also when 'hidden' is set or using
1328 |:hide|
1329 delete delete the buffer from the buffer list, also when
1330 'hidden' is set or using |:hide|, like using
1331 |:bdelete|
1332 wipe wipe out the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bwipeout|
1335
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001336 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001337 are lost without a warning. Also, these values may break autocommands
1338 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001339 This option is used together with 'buftype' and 'swapfile' to specify
1340 special kinds of buffers. See |special-buffers|.
1341
1342 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1343'buflisted' 'bl' boolean (default: on)
1344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001345 When this option is set, the buffer shows up in the buffer list. If
1346 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1347 This option is reset by Vim for buffers that are only used to remember
1348 a file name or marks. Vim sets it when starting to edit a buffer.
1349 But not when moving to a buffer with ":buffer".
1350
1351 *'buftype'* *'bt'* *E382*
1352'buftype' 'bt' string (default: "")
1353 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001354 The value of this option specifies the type of a buffer:
1355 <empty> normal buffer
1356 nofile buffer which is not related to a file and will not be
1357 written
1358 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001359 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001360 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001361 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001362 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 help help buffer (you are not supposed to set this
1364 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001365 terminal buffer for a |terminal| (you are not supposed to set
1366 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001367 prompt buffer where only the last line can be edited, meant
1368 to be used by a plugin, see |prompt-buffer|
1369 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001370 popup buffer used in a popup window, see |popup|.
1371 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001372
1373 This option is used together with 'bufhidden' and 'swapfile' to
1374 specify special kinds of buffers. See |special-buffers|.
1375
1376 Be careful with changing this option, it can have many side effects!
1377
Bram Moolenaar280f1262006-01-30 00:14:18 +00001378 A "quickfix" buffer is only used for the error list and the location
1379 list. This value is set by the |:cwindow| and |:lwindow| commands and
1380 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001381
1382 "nofile" and "nowrite" buffers are similar:
1383 both: The buffer is not to be written to disk, ":w" doesn't
1384 work (":w filename" does work though).
1385 both: The buffer is never considered to be |'modified'|.
1386 There is no warning when the changes will be lost, for
1387 example when you quit Vim.
1388 both: A swap file is only created when using too much memory
1389 (when 'swapfile' has been reset there is never a swap
1390 file).
1391 nofile only: The buffer name is fixed, it is not handled like a
1392 file name. It is not modified in response to a |:cd|
1393 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001394 both: When using ":e bufname" and already editing "bufname"
1395 the buffer is made empty and autocommands are
1396 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001397 *E676*
1398 "acwrite" implies that the buffer name is not related to a file, like
1399 "nofile", but it will be written. Thus, in contrast to "nofile" and
1400 "nowrite", ":w" does work and a modified buffer can't be abandoned
1401 without saving. For writing there must be matching |BufWriteCmd|,
1402 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001403
1404 *'casemap'* *'cmp'*
1405'casemap' 'cmp' string (default: "internal,keepascii")
1406 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001407 Specifies details about changing the case of letters. It may contain
1408 these words, separated by a comma:
1409 internal Use internal case mapping functions, the current
1410 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001411 matters when 'encoding' is a Unicode encoding,
1412 "latin1" or "iso-8859-15". When "internal" is
1413 omitted, the towupper() and towlower() system library
1414 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001415 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1416 case mapping, the current locale is not effective.
1417 This probably only matters for Turkish.
1418
1419 *'cdpath'* *'cd'* *E344* *E346*
1420'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1421 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001422 {not available when compiled without the
1423 |+file_in_path| feature}
1424 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001425 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1426 searched for has a relative path, not an absolute part starting with
1427 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001428 The 'cdpath' option's value has the same form and semantics as
1429 |'path'|. Also see |file-searching|.
1430 The default value is taken from $CDPATH, with a "," prepended to look
1431 in the current directory first.
1432 If the default value taken from $CDPATH is not what you want, include
1433 a modified version of the following command in your vimrc file to
1434 override it: >
1435 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1436< This option cannot be set from a |modeline| or in the |sandbox|, for
1437 security reasons.
1438 (parts of 'cdpath' can be passed to the shell to expand file names).
1439
1440 *'cedit'*
1441'cedit' string (Vi default: "", Vim default: CTRL-F)
1442 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001443 The key used in Command-line Mode to open the command-line window.
1444 The default is CTRL-F when 'compatible' is off.
1445 Only non-printable keys are allowed.
1446 The key can be specified as a single character, but it is difficult to
1447 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001448 :exe "set cedit=\<C-Y>"
1449 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001450< |Nvi| also has this option, but it only uses the first character.
1451 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001452 NOTE: This option is set to the Vim default value when 'compatible'
1453 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001454
1455 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1456'charconvert' 'ccv' string (default "")
1457 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001458 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001459 An expression that is used for character encoding conversion. It is
1460 evaluated when a file that is to be read or has been written has a
1461 different encoding from what is desired.
1462 'charconvert' is not used when the internal iconv() function is
1463 supported and is able to do the conversion. Using iconv() is
1464 preferred, because it is much faster.
1465 'charconvert' is not used when reading stdin |--|, because there is no
1466 file to convert from. You will have to save the text in a file first.
1467 The expression must return zero or an empty string for success,
1468 non-zero for failure.
1469 The possible encoding names encountered are in 'encoding'.
1470 Additionally, names given in 'fileencodings' and 'fileencoding' are
1471 used.
1472 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1473 is done internally by Vim, 'charconvert' is not used for this.
1474 'charconvert' is also used to convert the viminfo file, if the 'c'
1475 flag is present in 'viminfo'. Also used for Unicode conversion.
1476 Example: >
1477 set charconvert=CharConvert()
1478 fun CharConvert()
1479 system("recode "
1480 \ . v:charconvert_from . ".." . v:charconvert_to
1481 \ . " <" . v:fname_in . " >" v:fname_out)
1482 return v:shell_error
1483 endfun
1484< The related Vim variables are:
1485 v:charconvert_from name of the current encoding
1486 v:charconvert_to name of the desired encoding
1487 v:fname_in name of the input file
1488 v:fname_out name of the output file
1489 Note that v:fname_in and v:fname_out will never be the same.
1490 Note that v:charconvert_from and v:charconvert_to may be different
1491 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1492 Encryption is not done by Vim when using 'charconvert'. If you want
1493 to encrypt the file after conversion, 'charconvert' should take care
1494 of this.
1495 This option cannot be set from a |modeline| or in the |sandbox|, for
1496 security reasons.
1497
1498 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1499'cindent' 'cin' boolean (default off)
1500 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001501 {not available when compiled without the |+cindent|
1502 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001503 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 that trigger reindenting in insert mode and 'cinoptions' to set your
1505 preferred indent style.
1506 If 'indentexpr' is not empty, it overrules 'cindent'.
1507 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1508 the "=" operator indents using this algorithm rather than calling an
1509 external program.
1510 See |C-indenting|.
1511 When you don't like the way 'cindent' works, try the 'smartindent'
1512 option or 'indentexpr'.
1513 This option is not used when 'paste' is set.
1514 NOTE: This option is reset when 'compatible' is set.
1515
1516 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001517'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001518 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001519 {not available when compiled without the |+cindent|
1520 feature}
1521 A list of keys that, when typed in Insert mode, cause reindenting of
1522 the current line. Only used if 'cindent' is on and 'indentexpr' is
1523 empty.
1524 For the format of this option see |cinkeys-format|.
1525 See |C-indenting|.
1526
1527 *'cinoptions'* *'cino'*
1528'cinoptions' 'cino' string (default "")
1529 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001530 {not available when compiled without the |+cindent|
1531 feature}
1532 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1533 program. See |cinoptions-values| for the values of this option, and
1534 |C-indenting| for info on C indenting in general.
1535
1536
1537 *'cinwords'* *'cinw'*
1538'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1539 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001540 {not available when compiled without both the
1541 |+cindent| and the |+smartindent| features}
1542 These keywords start an extra indent in the next line when
1543 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1544 an appropriate place (inside {}).
1545 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1546 matter, include the keyword both the uppercase and lowercase:
1547 "if,If,IF".
1548
1549 *'clipboard'* *'cb'*
1550'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1551 for X-windows, "" otherwise)
1552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001553 {only in GUI versions or when the |+xterm_clipboard|
1554 feature is included}
1555 This option is a list of comma separated names.
1556 These names are recognized:
1557
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001558 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001559 unnamed When included, Vim will use the clipboard register '*'
1560 for all yank, delete, change and put operations which
1561 would normally go to the unnamed register. When a
1562 register is explicitly specified, it will always be
1563 used regardless of whether "unnamed" is in 'clipboard'
1564 or not. The clipboard register can always be
1565 explicitly accessed using the "* notation. Also see
1566 |gui-clipboard|.
1567
Bram Moolenaar30b65812012-07-12 22:01:11 +02001568 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001569 unnamedplus A variant of the "unnamed" flag which uses the
1570 clipboard register '+' (|quoteplus|) instead of
1571 register '*' for all yank, delete, change and put
1572 operations which would normally go to the unnamed
1573 register. When "unnamed" is also included to the
1574 option, yank operations (but not delete, change or
1575 put) will additionally copy the text into register
1576 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001577 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001578 Availability can be checked with: >
1579 if has('unnamedplus')
1580<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001581 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001582 autoselect Works like the 'a' flag in 'guioptions': If present,
1583 then whenever Visual mode is started, or the Visual
1584 area extended, Vim tries to become the owner of the
1585 windowing system's global selection or put the
1586 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001587 register "*. See |'go-a'| and |quotestar| for details.
1588 When the GUI is active, the 'a' flag in 'guioptions'
1589 is used, when the GUI is not active, this "autoselect"
1590 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001591 Also applies to the modeless selection.
1592
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001593 *clipboard-autoselectplus*
1594 autoselectplus Like "autoselect" but using the + register instead of
1595 the * register. Compare to the 'P' flag in
1596 'guioptions'.
1597
1598 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001599 autoselectml Like "autoselect", but for the modeless selection
1600 only. Compare to the 'A' flag in 'guioptions'.
1601
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001602 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001603 html When the clipboard contains HTML, use this when
1604 pasting. When putting text on the clipboard, mark it
1605 as HTML. This works to copy rendered HTML from
1606 Firefox, paste it as raw HTML in Vim, select the HTML
1607 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001608 You probably want to add this only temporarily,
1609 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001610 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001611
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001612 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001613 exclude:{pattern}
1614 Defines a pattern that is matched against the name of
1615 the terminal 'term'. If there is a match, no
1616 connection will be made to the X server. This is
1617 useful in this situation:
1618 - Running Vim in a console.
1619 - $DISPLAY is set to start applications on another
1620 display.
1621 - You do not want to connect to the X server in the
1622 console, but do want this in a terminal emulator.
1623 To never connect to the X server use: >
1624 exclude:.*
1625< This has the same effect as using the |-X| argument.
1626 Note that when there is no connection to the X server
1627 the window title won't be restored and the clipboard
1628 cannot be accessed.
1629 The value of 'magic' is ignored, {pattern} is
1630 interpreted as if 'magic' was on.
1631 The rest of the option value will be used for
1632 {pattern}, this must be the last entry.
1633
1634 *'cmdheight'* *'ch'*
1635'cmdheight' 'ch' number (default 1)
1636 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001637 Number of screen lines to use for the command-line. Helps avoiding
1638 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001639 The value of this option is stored with the tab page, so that each tab
1640 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001641
1642 *'cmdwinheight'* *'cwh'*
1643'cmdwinheight' 'cwh' number (default 7)
1644 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001645 Number of screen lines to use for the command-line window. |cmdwin|
1646
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001647 *'colorcolumn'* *'cc'*
1648'colorcolumn' 'cc' string (default "")
1649 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001650 {not available when compiled without the |+syntax|
1651 feature}
1652 'colorcolumn' is a comma separated list of screen columns that are
1653 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1654 text. Will make screen redrawing slower.
1655 The screen column can be an absolute number, or a number preceded with
1656 '+' or '-', which is added to or subtracted from 'textwidth'. >
1657
1658 :set cc=+1 " highlight column after 'textwidth'
1659 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1660 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1661<
1662 When 'textwidth' is zero then the items with '-' and '+' are not used.
1663 A maximum of 256 columns are highlighted.
1664
Bram Moolenaar071d4272004-06-13 20:20:40 +00001665 *'columns'* *'co'* *E594*
1666'columns' 'co' number (default 80 or terminal width)
1667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001669 initialization and does not have to be set by hand. Also see
1670 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 When Vim is running in the GUI or in a resizable window, setting this
1672 option will cause the window size to be changed. When you only want
1673 to use the size for the GUI, put the command in your |gvimrc| file.
1674 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001675 number of columns of the display, the display may be messed up. For
1676 the GUI it is always possible and Vim limits the number of columns to
1677 what fits on the screen. You can use this command to get the widest
1678 window possible: >
1679 :set columns=9999
1680< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001681
1682 *'comments'* *'com'* *E524* *E525*
1683'comments' 'com' string (default
1684 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1685 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001686 {not available when compiled without the |+comments|
1687 feature}
1688 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
1880 {not in Vi} {only for MS-Windows}
1881 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 Moolenaar576a4a62019-08-18 15:25:17 +02001920 {only works when compiled with the +textprop feature}
1921
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001922 noinsert Do not insert any text for a match until the user selects
1923 a match from the menu. Only works in combination with
1924 "menu" or "menuone". No effect if "longest" is present.
1925
1926 noselect Do not select a match in the menu, force the user to
1927 select one from the menu. Only works in combination with
1928 "menu" or "menuone".
1929
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001930
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001931 *'completepopup'* *'cpp'*
1932'completepopup' 'cpp' string (default empty)
1933 global
1934 {not available when compiled without the |+textprop|
1935 or |+quickfix| feature}
1936 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001937 properties of the info popup when it is created. You can also use
1938 |popup_findinfo()| and then set properties for an existing info popup
1939 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001940
1941
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001942 *'concealcursor'* *'cocu'*
1943'concealcursor' 'cocu' string (default: "")
1944 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001945 {not available when compiled without the |+conceal|
1946 feature}
1947 Sets the modes in which text in the cursor line can also be concealed.
1948 When the current mode is listed then concealing happens just like in
1949 other lines.
1950 n Normal mode
1951 v Visual mode
1952 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001953 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001954
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001955 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001956 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001957 are moving around text is concealed, but when starting to insert text
1958 or selecting a Visual area the concealed text is displayed, so that
1959 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001960 Keep in mind that the cursor position is not always where it's
1961 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962
1963
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001964 *'conceallevel'* *'cole'*
1965'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001966 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001967 {not available when compiled without the |+conceal|
1968 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001969 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1970 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001971
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001972 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001974 1 Each block of concealed text is replaced with one
1975 character. If the syntax item does not have a custom
1976 replacement character defined (see |:syn-cchar|) the
1977 character defined in 'listchars' is used (default is a
1978 space).
1979 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 2 Concealed text is completely hidden unless it has a
1981 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001982 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001983 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001984
Bram Moolenaara7781e02010-07-19 20:13:22 +02001985 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001986 edit and copy the text. This can be changed with the 'concealcursor'
1987 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988
Bram Moolenaar071d4272004-06-13 20:20:40 +00001989 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1990'confirm' 'cf' boolean (default off)
1991 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001992 When 'confirm' is on, certain operations that would normally
1993 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1994 instead raise a |dialog| asking if you wish to save the current
1995 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1996 If 'confirm' is off you can still activate confirmation for one
1997 command only (this is most useful in mappings) with the |:confirm|
1998 command.
1999 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2000
2001 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2002'conskey' 'consk' boolean (default off)
2003 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002004 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002005
2006 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2007'copyindent' 'ci' boolean (default off)
2008 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002009 Copy the structure of the existing lines indent when autoindenting a
2010 new line. Normally the new indent is reconstructed by a series of
2011 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2012 in which case only spaces are used). Enabling this option makes the
2013 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002014 existing line. 'expandtab' has no effect on these characters, a Tab
2015 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002017 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 Also see 'preserveindent'.
2019
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002020 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002021'cpoptions' 'cpo' string (Vim default: "aABceFs",
2022 Vi default: all flags)
2023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002025 this indicates Vi-compatible behavior. This is used for things where
2026 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002027 'cpoptions' stands for "compatible-options".
2028 Commas can be added for readability.
2029 To avoid problems with flags that are added in the future, use the
2030 "+=" and "-=" feature of ":set" |add-option-flags|.
2031 NOTE: This option is set to the Vi default value when 'compatible' is
2032 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002033 NOTE: This option is set to the POSIX default value at startup when
2034 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002035 variable exists |posix|. This means Vim tries to behave like the
2036 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002037
2038 contains behavior ~
2039 *cpo-a*
2040 a When included, a ":read" command with a file name
2041 argument will set the alternate file name for the
2042 current window.
2043 *cpo-A*
2044 A When included, a ":write" command with a file name
2045 argument will set the alternate file name for the
2046 current window.
2047 *cpo-b*
2048 b "\|" in a ":map" command is recognized as the end of
2049 the map command. The '\' is included in the mapping,
2050 the text after the '|' is interpreted as the next
2051 command. Use a CTRL-V instead of a backslash to
2052 include the '|' in the mapping. Applies to all
2053 mapping, abbreviation, menu and autocmd commands.
2054 See also |map_bar|.
2055 *cpo-B*
2056 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002057 abbreviations, user commands and the "to" part of the
2058 menu commands. Remove this flag to be able to use a
2059 backslash like a CTRL-V. For example, the command
2060 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002061 'B' included: "\^[" (^[ is a real <Esc>)
2062 'B' excluded: "<Esc>" (5 characters)
2063 ('<' excluded in both cases)
2064 *cpo-c*
2065 c Searching continues at the end of any match at the
2066 cursor position, but not further than the start of the
2067 next line. When not present searching continues
2068 one character from the cursor position. With 'c'
2069 "abababababab" only gets three matches when repeating
2070 "/abab", without 'c' there are five matches.
2071 *cpo-C*
2072 C Do not concatenate sourced lines that start with a
2073 backslash. See |line-continuation|.
2074 *cpo-d*
2075 d Using "./" in the 'tags' option doesn't mean to use
2076 the tags file relative to the current file, but the
2077 tags file in the current directory.
2078 *cpo-D*
2079 D Can't use CTRL-K to enter a digraph after Normal mode
2080 commands with a character argument, like |r|, |f| and
2081 |t|.
2082 *cpo-e*
2083 e When executing a register with ":@r", always add a
2084 <CR> to the last line, also when the register is not
2085 linewise. If this flag is not present, the register
2086 is not linewise and the last line does not end in a
2087 <CR>, then the last line is put on the command-line
2088 and can be edited before hitting <CR>.
2089 *cpo-E*
2090 E It is an error when using "y", "d", "c", "g~", "gu" or
2091 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002092 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002093 This makes "y0" fail in the first column.
2094 *cpo-f*
2095 f When included, a ":read" command with a file name
2096 argument will set the file name for the current buffer,
2097 if the current buffer doesn't have a file name yet.
2098 *cpo-F*
2099 F When included, a ":write" command with a file name
2100 argument will set the file name for the current
2101 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002102 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002103 *cpo-g*
2104 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002105 *cpo-H*
2106 H When using "I" on a line with only blanks, insert
2107 before the last blank. Without this flag insert after
2108 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002109 *cpo-i*
2110 i When included, interrupting the reading of a file will
2111 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002112 *cpo-I*
2113 I When moving the cursor up or down just after inserting
2114 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002115 *cpo-j*
2116 j When joining lines, only add two spaces after a '.',
2117 not after '!' or '?'. Also see 'joinspaces'.
2118 *cpo-J*
2119 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002120 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002121 white space.
2122 *cpo-k*
2123 k Disable the recognition of raw key codes in
2124 mappings, abbreviations, and the "to" part of menu
2125 commands. For example, if <Key> sends ^[OA (where ^[
2126 is <Esc>), the command ":map X ^[OA" results in X
2127 being mapped to:
2128 'k' included: "^[OA" (3 characters)
2129 'k' excluded: "<Key>" (one key code)
2130 Also see the '<' flag below.
2131 *cpo-K*
2132 K Don't wait for a key code to complete when it is
2133 halfway a mapping. This breaks mapping <F1><F1> when
2134 only part of the second <F1> has been read. It
2135 enables cancelling the mapping by typing <F1><Esc>.
2136 *cpo-l*
2137 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002138 literally, only "\]", "\^", "\-" and "\\" are special.
2139 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002140 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2141 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002142 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002143 *cpo-L*
2144 L When the 'list' option is set, 'wrapmargin',
2145 'textwidth', 'softtabstop' and Virtual Replace mode
2146 (see |gR|) count a <Tab> as two characters, instead of
2147 the normal behavior of a <Tab>.
2148 *cpo-m*
2149 m When included, a showmatch will always wait half a
2150 second. When not included, a showmatch will wait half
2151 a second or until a character is typed. |'showmatch'|
2152 *cpo-M*
2153 M When excluded, "%" matching will take backslashes into
2154 account. Thus in "( \( )" and "\( ( \)" the outer
2155 parenthesis match. When included "%" ignores
2156 backslashes, which is Vi compatible.
2157 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002158 n When included, the column used for 'number' and
2159 'relativenumber' will also be used for text of wrapped
2160 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002161 *cpo-o*
2162 o Line offset to search command is not remembered for
2163 next search.
2164 *cpo-O*
2165 O Don't complain if a file is being overwritten, even
2166 when it didn't exist when editing it. This is a
2167 protection against a file unexpectedly created by
2168 someone else. Vi didn't complain about this.
2169 *cpo-p*
2170 p Vi compatible Lisp indenting. When not present, a
2171 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002172 *cpo-P*
2173 P When included, a ":write" command that appends to a
2174 file will set the file name for the current buffer, if
2175 the current buffer doesn't have a file name yet and
2176 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002177 *cpo-q*
2178 q When joining multiple lines leave the cursor at the
2179 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002180 *cpo-r*
2181 r Redo ("." command) uses "/" to repeat a search
2182 command, instead of the actually used search string.
2183 *cpo-R*
2184 R Remove marks from filtered lines. Without this flag
2185 marks are kept like |:keepmarks| was used.
2186 *cpo-s*
2187 s Set buffer options when entering the buffer for the
2188 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002189 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002190 set when the buffer is created.
2191 *cpo-S*
2192 S Set buffer options always when entering a buffer
2193 (except 'readonly', 'fileformat', 'filetype' and
2194 'syntax'). This is the (most) Vi compatible setting.
2195 The options are set to the values in the current
2196 buffer. When you change an option and go to another
2197 buffer, the value is copied. Effectively makes the
2198 buffer options global to all buffers.
2199
2200 's' 'S' copy buffer options
2201 no no when buffer created
2202 yes no when buffer first entered (default)
2203 X yes each time when buffer entered (vi comp.)
2204 *cpo-t*
2205 t Search pattern for the tag command is remembered for
2206 "n" command. Otherwise Vim only puts the pattern in
2207 the history for search pattern, but doesn't change the
2208 last used search pattern.
2209 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002210 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002211 *cpo-v*
2212 v Backspaced characters remain visible on the screen in
2213 Insert mode. Without this flag the characters are
2214 erased from the screen right away. With this flag the
2215 screen newly typed text overwrites backspaced
2216 characters.
2217 *cpo-w*
2218 w When using "cw" on a blank character, only change one
2219 character and not all blanks until the start of the
2220 next word.
2221 *cpo-W*
2222 W Don't overwrite a readonly file. When omitted, ":w!"
2223 overwrites a readonly file, if possible.
2224 *cpo-x*
2225 x <Esc> on the command-line executes the command-line.
2226 The default in Vim is to abandon the command-line,
2227 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002228 *cpo-X*
2229 X When using a count with "R" the replaced text is
2230 deleted only once. Also when repeating "R" with "."
2231 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002232 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002233 y A yank command can be redone with ".". Think twice if
2234 you really want to use this, it may break some
2235 plugins, since most people expect "." to only repeat a
2236 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002237 *cpo-Z*
2238 Z When using "w!" while the 'readonly' option is set,
2239 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 *cpo-!*
2241 ! When redoing a filter command, use the last used
2242 external command, whatever it was. Otherwise the last
2243 used -filter- command is used.
2244 *cpo-$*
2245 $ When making a change to one line, don't redisplay the
2246 line, but put a '$' at the end of the changed text.
2247 The changed text will be overwritten when you type the
2248 new text. The line is redisplayed if you type any
2249 command that moves the cursor from the insertion
2250 point.
2251 *cpo-%*
2252 % Vi-compatible matching is done for the "%" command.
2253 Does not recognize "#if", "#endif", etc.
2254 Does not recognize "/*" and "*/".
2255 Parens inside single and double quotes are also
2256 counted, causing a string that contains a paren to
2257 disturb the matching. For example, in a line like
2258 "if (strcmp("foo(", s))" the first paren does not
2259 match the last one. When this flag is not included,
2260 parens inside single and double quotes are treated
2261 specially. When matching a paren outside of quotes,
2262 everything inside quotes is ignored. When matching a
2263 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002264 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002265 This flag is also used for other features, such as
2266 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002267 *cpo--*
2268 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002269 it would go above the first line or below the last
2270 line. Without it the cursor moves to the first or
2271 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002272 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002273 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002274 *cpo-+*
2275 + When included, a ":write file" command will reset the
2276 'modified' flag of the buffer, even though the buffer
2277 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002278 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002279 * Use ":*" in the same way as ":@". When not included,
2280 ":*" is an alias for ":'<,'>", select the Visual area.
2281 *cpo-<*
2282 < Disable the recognition of special key codes in |<>|
2283 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002284 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002285 ":map X <Tab>" results in X being mapped to:
2286 '<' included: "<Tab>" (5 characters)
2287 '<' excluded: "^I" (^I is a real <Tab>)
2288 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002289 *cpo->*
2290 > When appending to a register, put a line break before
2291 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002292 *cpo-;*
2293 ; When using |,| or |;| to repeat the last |t| search
2294 and the cursor is right in front of the searched
2295 character, the cursor won't move. When not included,
2296 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002297 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002298
2299 POSIX flags. These are not included in the Vi default value, except
2300 when $VIM_POSIX was set on startup. |posix|
2301
2302 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002303 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002304 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305 *cpo-&*
2306 & When ":preserve" was used keep the swap file when
2307 exiting normally while this buffer is still loaded.
2308 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002309 *cpo-\*
2310 \ Backslash in a [] range in a search pattern is taken
2311 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002312 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2313 '\' excluded: "/[ \-]" finds <Space> and '-'
2314 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002315 *cpo-/*
2316 / When "%" is used as the replacement string in a |:s|
2317 command, use the previous replacement string. |:s%|
2318 *cpo-{*
2319 { The |{| and |}| commands also stop at a "{" character
2320 at the start of a line.
2321 *cpo-.*
2322 . The ":chdir" and ":cd" commands fail if the current
2323 buffer is modified, unless ! is used. Vim doesn't
2324 need this, since it remembers the full path of an
2325 opened file.
2326 *cpo-bar*
2327 | The value of the $LINES and $COLUMNS environment
2328 variables overrule the terminal size values obtained
2329 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002330
Bram Moolenaar071d4272004-06-13 20:20:40 +00002331
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002332 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002333'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002334 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002335 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002336 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002337 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002338 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002339 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002340 blowfish Blowfish method. Medium strong encryption but it has
2341 an implementation flaw. Requires Vim 7.3 or later,
2342 files can NOT be read by Vim 7.2 and older. This adds
2343 a "seed" to the file, every time you write the file
2344 the encrypted bytes will be different.
2345 *blowfish2*
2346 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002347 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002348 and older. This adds a "seed" to the file, every time
2349 you write the file the encrypted bytes will be
2350 different. The whole undo file is encrypted, not just
2351 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002352
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002353 You should use "blowfish2", also to re-encrypt older files.
2354
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002355 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002356 to the detected method of the file being read. Thus if you write it
2357 without changing 'cryptmethod' the same method will be used.
2358 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002359 explicitly write it, you don't get a warning unless there are other
2360 modifications. Also see |:X|.
2361
2362 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002363 the value "blowfish2". When setting the local value to an empty
2364 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002365
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002366 When a new encryption method is added in a later version of Vim, and
2367 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002368 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002369
2370
Bram Moolenaar071d4272004-06-13 20:20:40 +00002371 *'cscopepathcomp'* *'cspc'*
2372'cscopepathcomp' 'cspc' number (default 0)
2373 global
2374 {not available when compiled without the |+cscope|
2375 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002376 Determines how many components of the path to show in a list of tags.
2377 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002378 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379
2380 *'cscopeprg'* *'csprg'*
2381'cscopeprg' 'csprg' string (default "cscope")
2382 global
2383 {not available when compiled without the |+cscope|
2384 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002385 Specifies the command to execute cscope. See |cscopeprg|.
2386 This option cannot be set from a |modeline| or in the |sandbox|, for
2387 security reasons.
2388
2389 *'cscopequickfix'* *'csqf'*
2390'cscopequickfix' 'csqf' string (default "")
2391 global
2392 {not available when compiled without the |+cscope|
2393 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002394 Specifies whether to use quickfix window to show cscope results.
2395 See |cscopequickfix|.
2396
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002397 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002398'cscoperelative' 'csre' boolean (default off)
2399 global
2400 {not available when compiled without the |+cscope|
2401 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002402 In the absence of a prefix (-P) for cscope. setting this option enables
2403 to use the basename of cscope.out path as the prefix.
2404 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002405 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002406
Bram Moolenaar071d4272004-06-13 20:20:40 +00002407 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2408'cscopetag' 'cst' boolean (default off)
2409 global
2410 {not available when compiled without the |+cscope|
2411 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002412 Use cscope for tag commands. See |cscope-options|.
2413 NOTE: This option is reset when 'compatible' is set.
2414
2415 *'cscopetagorder'* *'csto'*
2416'cscopetagorder' 'csto' number (default 0)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Determines the order in which ":cstag" performs a search. See
2421 |cscopetagorder|.
2422 NOTE: This option is set to 0 when 'compatible' is set.
2423
2424 *'cscopeverbose'* *'csverb'*
2425 *'nocscopeverbose'* *'nocsverb'*
2426'cscopeverbose' 'csverb' boolean (default off)
2427 global
2428 {not available when compiled without the |+cscope|
2429 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002430 Give messages when adding a cscope database. See |cscopeverbose|.
2431 NOTE: This option is reset when 'compatible' is set.
2432
Bram Moolenaar860cae12010-06-05 23:22:07 +02002433 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2434'cursorbind' 'crb' boolean (default off)
2435 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002436 When this option is set, as the cursor in the current
2437 window moves other cursorbound windows (windows that also have
2438 this option set) move their cursors to the corresponding line and
2439 column. This option is useful for viewing the
2440 differences between two versions of a file (see 'diff'); in diff mode,
2441 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002442 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002443
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002444
2445 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2446'cursorcolumn' 'cuc' boolean (default off)
2447 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002448 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002449 feature}
2450 Highlight the screen column of the cursor with CursorColumn
2451 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2452 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002453 If you only want the highlighting in the current window you can use
2454 these autocommands: >
2455 au WinLeave * set nocursorline nocursorcolumn
2456 au WinEnter * set cursorline cursorcolumn
2457<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002458
2459 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2460'cursorline' 'cul' boolean (default off)
2461 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002462 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002463 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002464 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2465 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002466 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002467 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002468
2469
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002470 *'cursorlineopt'* *'culopt'*
2471'cursorlineopt' 'culopt' string (default: "both")
2472 local to window
2473 {not in Vi}
2474 {not available when compiled without the |+syntax|
2475 feature}
2476 Settings for how 'cursorline' is displayed. Valid values:
2477 "line" Highlight the text line of the cursor with
2478 CursorLine |hl-CursorLine|.
2479 "number" Highlight the line number of the cursor with
2480 CursorLineNr |hl-CursorLineNr|.
2481 "both" Highlight as both "line" and "number" are set.
2482
2483
Bram Moolenaar071d4272004-06-13 20:20:40 +00002484 *'debug'*
2485'debug' string (default "")
2486 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002487 These values can be used:
2488 msg Error messages that would otherwise be omitted will be given
2489 anyway.
2490 throw Error messages that would otherwise be omitted will be given
2491 anyway and also throw an exception and set |v:errmsg|.
2492 beep A message will be given when otherwise only a beep would be
2493 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002494 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002495 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2496 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497
2498 *'define'* *'def'*
2499'define' 'def' string (default "^\s*#\s*define")
2500 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002501 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002502 pattern, just like for the "/" command. This option is used for the
2503 commands like "[i" and "[d" |include-search|. The 'isident' option is
2504 used to recognize the defined name after the match:
2505 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2506 See |option-backslash| about inserting backslashes to include a space
2507 or backslash.
2508 The default value is for C programs. For C++ this value would be
2509 useful, to include const type declarations: >
2510 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002511< You can also use "\ze" just before the name and continue the pattern
2512 to check what is following. E.g. for Javascript, if a function is
2513 defined with "func_name = function(args)": >
2514 ^\s*\ze\i\+\s*=\s*function(
2515< If the function is defined with "func_name : function() {...": >
2516 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002517< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002518 To avoid that use `:let` with a single quote string: >
2519 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002520<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002521
2522 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2523'delcombine' 'deco' boolean (default off)
2524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002525 If editing Unicode and this option is set, backspace and Normal mode
2526 "x" delete each combining character on its own. When it is off (the
2527 default) the character along with its combining characters are
2528 deleted.
2529 Note: When 'delcombine' is set "xx" may work different from "2x"!
2530
2531 This is useful for Arabic, Hebrew and many other languages where one
2532 may have combining characters overtop of base characters, and want
2533 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002534 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535
2536 *'dictionary'* *'dict'*
2537'dictionary' 'dict' string (default "")
2538 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 List of file names, separated by commas, that are used to lookup words
2540 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2541 contain a list of words. This can be one word per line, or several
2542 words per line, separated by non-keyword characters (white space is
2543 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002544
2545 When this option is empty or an entry "spell" is present, and spell
2546 checking is enabled, words in the word lists for the currently active
2547 'spelllang' are used. See |spell|.
2548
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002549 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002550 after a comma are ignored, otherwise spaces are included in the file
2551 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002552 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 Where to find a list of words?
2554 - On FreeBSD, there is the file "/usr/share/dict/words".
2555 - In the Simtel archive, look in the "msdos/linguist" directory.
2556 - In "miscfiles" of the GNU collection.
2557 The use of |:set+=| and |:set-=| is preferred when adding or removing
2558 directories from the list. This avoids problems when a future version
2559 uses another default.
2560 Backticks cannot be used in this option for security reasons.
2561
2562 *'diff'* *'nodiff'*
2563'diff' boolean (default off)
2564 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002565 {not available when compiled without the |+diff|
2566 feature}
2567 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002568 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002569
2570 *'dex'* *'diffexpr'*
2571'diffexpr' 'dex' string (default "")
2572 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002573 {not available when compiled without the |+diff|
2574 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002575 Expression which is evaluated to obtain a diff file (either ed-style
2576 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002577 This option cannot be set from a |modeline| or in the |sandbox|, for
2578 security reasons.
2579
2580 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002581'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583 {not available when compiled without the |+diff|
2584 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002585 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 All are optional. Items must be separated by a comma.
2587
2588 filler Show filler lines, to keep the text
2589 synchronized with a window that has inserted
2590 lines at the same position. Mostly useful
2591 when windows are side-by-side and 'scrollbind'
2592 is set.
2593
2594 context:{n} Use a context of {n} lines between a change
2595 and a fold that contains unchanged lines.
2596 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002597 When using zero the context is actually one,
2598 since folds require a line in between, also
2599 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 See |fold-diff|.
2601
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002602 iblank Ignore changes where lines are all blank. Adds
2603 the "-B" flag to the "diff" command if
2604 'diffexpr' is empty. Check the documentation
2605 of the "diff" command for what this does
2606 exactly.
2607 NOTE: the diff windows will get out of sync,
2608 because no differences between blank lines are
2609 taken into account.
2610
Bram Moolenaar071d4272004-06-13 20:20:40 +00002611 icase Ignore changes in case of text. "a" and "A"
2612 are considered the same. Adds the "-i" flag
2613 to the "diff" command if 'diffexpr' is empty.
2614
2615 iwhite Ignore changes in amount of white space. 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. It should ignore adding trailing
2620 white space, but not leading white space.
2621
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002622 iwhiteall Ignore all white space changes. Adds
2623 the "-w" flag to the "diff" command if
2624 'diffexpr' is empty. Check the documentation
2625 of the "diff" command for what this does
2626 exactly.
2627
2628 iwhiteeol Ignore white space changes at end of line.
2629 Adds the "-Z" flag to the "diff" command if
2630 'diffexpr' is empty. Check the documentation
2631 of the "diff" command for what this does
2632 exactly.
2633
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002634 horizontal Start diff mode with horizontal splits (unless
2635 explicitly specified otherwise).
2636
2637 vertical Start diff mode with vertical splits (unless
2638 explicitly specified otherwise).
2639
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002640 hiddenoff Do not use diff mode for a buffer when it
2641 becomes hidden.
2642
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002643 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2644 starting diff mode. Without this 2 is used.
2645
Bram Moolenaare828b762018-09-10 17:51:58 +02002646 internal Use the internal diff library. This is
2647 ignored when 'diffexpr' is set. *E960*
2648 When running out of memory when writing a
2649 buffer this item will be ignored for diffs
2650 involving that buffer. Set the 'verbose'
2651 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002652
Bram Moolenaare828b762018-09-10 17:51:58 +02002653 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002654 Use the indent heuristic for the internal
2655 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002656
2657 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002658 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002659 algorithms are:
2660 myers the default algorithm
2661 minimal spend extra time to generate the
2662 smallest possible diff
2663 patience patience diff algorithm
2664 histogram histogram diff algorithm
2665
2666 Examples: >
2667 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002668 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002669 :set diffopt=internal,filler,foldcolumn:3
2670 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002671<
2672 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2673'digraph' 'dg' boolean (default off)
2674 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002675 {not available when compiled without the |+digraphs|
2676 feature}
2677 Enable the entering of digraphs in Insert mode with {char1} <BS>
2678 {char2}. See |digraphs|.
2679 NOTE: This option is reset when 'compatible' is set.
2680
2681 *'directory'* *'dir'*
2682'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002683 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 for Unix: ".,~/tmp,/var/tmp,/tmp")
2685 global
2686 List of directory names for the swap file, separated with commas.
2687 - The swap file will be created in the first directory where this is
2688 possible.
2689 - Empty means that no swap file will be used (recovery is
2690 impossible!).
2691 - A directory "." means to put the swap file in the same directory as
2692 the edited file. On Unix, a dot is prepended to the file name, so
2693 it doesn't show in a directory listing. On MS-Windows the "hidden"
2694 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002695 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002696 put the swap file relative to where the edited file is. The leading
2697 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002698 - For Unix and Win32, if a directory ends in two path separators "//",
2699 the swap file name will be built from the complete path to the file
2700 with all path separators substituted to percent '%' signs. This will
2701 ensure file name uniqueness in the preserve directory.
2702 On Win32, it is also possible to end with "\\". However, When a
2703 separating comma is following, you must use "//", since "\\" will
2704 include the comma in the file name. Therefore it is recommended to
2705 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002706 - Spaces after the comma are ignored, other spaces are considered part
2707 of the directory name. To have a space at the start of a directory
2708 name, precede it with a backslash.
2709 - To include a comma in a directory name precede it with a backslash.
2710 - A directory name may end in an ':' or '/'.
2711 - Environment variables are expanded |:set_env|.
2712 - Careful with '\' characters, type one before a space, type two to
2713 get one in the option (see |option-backslash|), for example: >
2714 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2715< - For backwards compatibility with Vim version 3.0 a '>' at the start
2716 of the option is removed.
2717 Using "." first in the list is recommended. This means that editing
2718 the same file twice will result in a warning. Using "/tmp" on Unix is
2719 discouraged: When the system crashes you lose the swap file.
2720 "/var/tmp" is often not cleared when rebooting, thus is a better
2721 choice than "/tmp". But it can contain a lot of files, your swap
2722 files get lost in the crowd. That is why a "tmp" directory in your
2723 home directory is tried first.
2724 The use of |:set+=| and |:set-=| is preferred when adding or removing
2725 directories from the list. This avoids problems when a future version
2726 uses another default.
2727 This option cannot be set from a |modeline| or in the |sandbox|, for
2728 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002729
2730 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002731'display' 'dy' string (default "", set to "truncate" in
2732 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002734 Change the way text is displayed. This is comma separated list of
2735 flags:
2736 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002737 in a window will be displayed. "@@@" is put in the
2738 last columns of the last screen line to indicate the
2739 rest of the line is not displayed.
2740 truncate Like "lastline", but "@@@" is displayed in the first
2741 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 uhex Show unprintable characters hexadecimal as <xx>
2743 instead of using ^C and ~C.
2744
Bram Moolenaard0796902016-09-16 20:02:31 +02002745 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002746 doesn't fit is replaced with "@" lines.
2747
Bram Moolenaar071d4272004-06-13 20:20:40 +00002748 *'eadirection'* *'ead'*
2749'eadirection' 'ead' string (default "both")
2750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 Tells when the 'equalalways' option applies:
2752 ver vertically, width of windows is not affected
2753 hor horizontally, height of windows is not affected
2754 both width and height of windows is affected
2755
2756 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2757'edcompatible' 'ed' boolean (default off)
2758 global
2759 Makes the 'g' and 'c' flags of the ":substitute" command to be
2760 toggled each time the flag is given. See |complex-change|. See
2761 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002762 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002763
Bram Moolenaar03413f42016-04-12 21:07:15 +02002764 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002765'emoji' 'emo' boolean (default: on)
2766 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002767 When on all Unicode emoji characters are considered to be full width.
2768
2769
Bram Moolenaar071d4272004-06-13 20:20:40 +00002770 *'encoding'* *'enc'* *E543*
2771'encoding' 'enc' string (default: "latin1" or value from $LANG)
2772 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002773 Sets the character encoding used inside Vim. It applies to text in
2774 the buffers, registers, Strings in expressions, text stored in the
2775 viminfo file, etc. It sets the kind of characters which Vim can work
2776 with. See |encoding-names| for the possible values.
2777
2778 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002779 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002780 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002781 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782
Bram Moolenaar865242e2010-07-14 21:12:05 +02002783 This option cannot be set from a |modeline|. It would most likely
2784 corrupt the text.
2785
Bram Moolenaar3df01732017-02-17 22:47:16 +01002786 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2787 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002788 'encoding', "utf-8" is the natural choice for the environment and
2789 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002790 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791 versions, and to avoid changing the encoding of newly created files
2792 without your knowledge (in case 'fileencodings' is empty).
2793
2794 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002795 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002796 iconv() or as specified with 'charconvert'.
2797
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002798 If you need to know whether 'encoding' is a multi-byte encoding, you
2799 can use: >
2800 if has("multi_byte_encoding")
2801<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802 Normally 'encoding' will be equal to your current locale. This will
2803 be the default if Vim recognizes your environment settings. If
2804 'encoding' is not set to the current locale, 'termencoding' must be
2805 set to convert typed and displayed text. See |encoding-table|.
2806
2807 When you set this option, it fires the |EncodingChanged| autocommand
2808 event so that you can set up fonts if necessary.
2809
2810 When the option is set, the value is converted to lowercase. Thus
2811 you can set it with uppercase values too. Underscores are translated
2812 to '-' signs.
2813 When the encoding is recognized, it is changed to the standard name.
2814 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2815 "iso-8859-2" and "utf8" becomes "utf-8".
2816
2817 Note: "latin1" is also used when the encoding could not be detected.
2818 This only works when editing files in the same encoding! When the
2819 actual character set is not latin1, make sure 'fileencoding' and
2820 'fileencodings' are empty. When conversion is needed, switch to using
2821 utf-8.
2822
2823 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2824 You don't notice this while editing, but it does matter for the
2825 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2826 setting 'encoding' to one of these values instead of utf-8 only has
2827 effect for encoding used for files when 'fileencoding' is empty.
2828
Bram Moolenaar661b1822005-07-28 22:36:45 +00002829 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2830 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002831
2832 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2833'endofline' 'eol' boolean (default on)
2834 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002835 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002836 is on, or 'fixeol' option is off, no <EOL> will be written for the
2837 last line in the file. This option is automatically set or reset when
2838 starting to edit a new file, depending on whether file has an <EOL>
2839 for the last line in the file. Normally you don't have to set or
2840 reset this option.
2841 When 'binary' is off and 'fixeol' is on the value is not used when
2842 writing the file. When 'binary' is on or 'fixeol' is off it is used
2843 to remember the presence of a <EOL> for the last line in the file, so
2844 that when you write the file the situation from the original file can
2845 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002846
2847 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2848'equalalways' 'ea' boolean (default on)
2849 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002850 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002851 splitting or closing a window. This also happens the moment the
2852 option is switched on. When off, splitting a window will reduce the
2853 size of the current window and leave the other windows the same. When
2854 closing a window the extra lines are given to the window next to it
2855 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002856 When mixing vertically and horizontally split windows, a minimal size
2857 is computed and some windows may be larger if there is room. The
2858 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002859 Changing the height and width of a window can be avoided by setting
2860 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002861 If a window size is specified when creating a new window sizes are
2862 currently not equalized (it's complicated, but may be implemented in
2863 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002864
2865 *'equalprg'* *'ep'*
2866'equalprg' 'ep' string (default "")
2867 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002868 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002869 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002870 or 'indentexpr'. When Vim was compiled without internal formatting,
2871 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002872 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873 about including spaces and backslashes.
2874 This option cannot be set from a |modeline| or in the |sandbox|, for
2875 security reasons.
2876
2877 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2878'errorbells' 'eb' boolean (default off)
2879 global
2880 Ring the bell (beep or screen flash) for error messages. This only
2881 makes a difference for error messages, the bell will be used always
2882 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002883 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002884 screen flash or do nothing. See 'belloff' to finetune when to ring the
2885 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886
2887 *'errorfile'* *'ef'*
2888'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2889 others: "errors.err")
2890 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002891 {not available when compiled without the |+quickfix|
2892 feature}
2893 Name of the errorfile for the QuickFix mode (see |:cf|).
2894 When the "-q" command-line argument is used, 'errorfile' is set to the
2895 following argument. See |-q|.
2896 NOT used for the ":make" command. See 'makeef' for that.
2897 Environment variables are expanded |:set_env|.
2898 See |option-backslash| about including spaces and backslashes.
2899 This option cannot be set from a |modeline| or in the |sandbox|, for
2900 security reasons.
2901
2902 *'errorformat'* *'efm'*
2903'errorformat' 'efm' string (default is very long)
2904 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002905 {not available when compiled without the |+quickfix|
2906 feature}
2907 Scanf-like description of the format for the lines in the error file
2908 (see |errorformat|).
2909
2910 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2911'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2912 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002913 Function keys that start with an <Esc> are recognized in Insert
2914 mode. When this option is off, the cursor and function keys cannot be
2915 used in Insert mode if they start with an <Esc>. The advantage of
2916 this is that the single <Esc> is recognized immediately, instead of
2917 after one second. Instead of resetting this option, you might want to
2918 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2919 when 'esckeys' is off, you can still map anything, but the cursor keys
2920 won't work by default.
2921 NOTE: This option is set to the Vi default value when 'compatible' is
2922 set and to the Vim default value when 'compatible' is reset.
2923
2924 *'eventignore'* *'ei'*
2925'eventignore' 'ei' string (default "")
2926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002927 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002928 When set to "all" or when "all" is one of the items, all autocommand
2929 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002930 Otherwise this is a comma separated list of event names. Example: >
2931 :set ei=WinEnter,WinLeave
2932<
2933 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2934'expandtab' 'et' boolean (default off)
2935 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002937 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002938 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2939 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002940 This option is reset when the 'paste' option is set and restored when
2941 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002942 NOTE: This option is reset when 'compatible' is set.
2943
2944 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2945'exrc' 'ex' boolean (default off)
2946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002948 directory.
2949
2950 Setting this option is a potential security leak. E.g., consider
2951 unpacking a package or fetching files from github, a .vimrc in there
2952 might be a trojan horse. BETTER NOT SET THIS OPTION!
2953 Instead, define an autocommand in your .vimrc to set options for a
2954 matching directory.
2955
2956 If you do switch this option on you should also consider setting the
2957 'secure' option (see |initialization|).
2958 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 This option cannot be set from a |modeline| or in the |sandbox|, for
2960 security reasons.
2961
2962 *'fileencoding'* *'fenc'* *E213*
2963'fileencoding' 'fenc' string (default: "")
2964 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002966
Bram Moolenaar071d4272004-06-13 20:20:40 +00002967 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002968 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002969 When 'fileencoding' is empty, the same value as 'encoding' will be
2970 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002971 No error will be given when the value is set, only when it is used,
2972 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002973 Conversion will also be done when 'encoding' and 'fileencoding' are
2974 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2975 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002977 'encoding' is "utf-8" or another Unicode encoding, conversion
2978 is most likely done in a way that the reverse conversion
2979 results in the same text. When 'encoding' is not "utf-8" some
2980 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002981
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 See 'encoding' for the possible values. Additionally, values may be
2983 specified that can be handled by the converter, see
2984 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002985
Bram Moolenaar071d4272004-06-13 20:20:40 +00002986 When reading a file 'fileencoding' will be set from 'fileencodings'.
2987 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002988 'fileencoding', use the |++enc| argument. One exception: when
2989 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002990 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002991
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
2993 When the option is set, the value is converted to lowercase. Thus
2994 you can set it with uppercase values too. '_' characters are
2995 replaced with '-'. If a name is recognized from the list for
2996 'encoding', it is replaced by the standard name. For example
2997 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02002998
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 When this option is set, after starting to edit a file, the 'modified'
3000 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003001
3002 Keep in mind that changing 'fenc' from a modeline happens
3003 AFTER the text has been read, thus it applies to when the file will be
3004 written. If you do set 'fenc' in a modeline, you might want to set
3005 'nomodified' to avoid not being able to ":q".
3006
Bram Moolenaar071d4272004-06-13 20:20:40 +00003007 This option can not be changed when 'modifiable' is off.
3008
3009 *'fe'*
3010 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003011 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 old short name was 'fe', which is no longer used.
3013
3014 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003015'fileencodings' 'fencs' string (default: "ucs-bom",
3016 "ucs-bom,utf-8,default,latin1" when
3017 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003019 This is a list of character encodings considered when starting to edit
3020 an existing file. When a file is read, Vim tries to use the first
3021 mentioned character encoding. If an error is detected, the next one
3022 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003023 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003024 an empty string, which means the value of 'encoding' is used.
3025 WARNING: Conversion can cause loss of information! When
3026 'encoding' is "utf-8" (or one of the other Unicode variants)
3027 conversion is most likely done in a way that the reverse
3028 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003029 "utf-8" some non-ASCII characters may be lost! You can use
3030 the |++bad| argument to specify what is done with characters
3031 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 For an empty file or a file with only ASCII characters most encodings
3033 will work and the first entry of 'fileencodings' will be used (except
3034 "ucs-bom", which requires the BOM to be present). If you prefer
3035 another encoding use an BufReadPost autocommand event to test if your
3036 preferred encoding is to be used. Example: >
3037 au BufReadPost * if search('\S', 'w') == 0 |
3038 \ set fenc=iso-2022-jp | endif
3039< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3040 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003041 When the |++enc| argument is used then the value of 'fileencodings' is
3042 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003043 Note that 'fileencodings' is not used for a new file, the global value
3044 of 'fileencoding' is used instead. You can set it with: >
3045 :setglobal fenc=iso-8859-2
3046< This means that a non-existing file may get a different encoding than
3047 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003048 The special value "ucs-bom" can be used to check for a Unicode BOM
3049 (Byte Order Mark) at the start of the file. It must not be preceded
3050 by "utf-8" or another Unicode encoding for this to work properly.
3051 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3052 because Vim cannot detect an error, thus the encoding is always
3053 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003054 The special value "default" can be used for the encoding from the
3055 environment. This is the default value for 'encoding'. It is useful
3056 when 'encoding' is set to "utf-8" and your environment uses a
3057 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003058 When 'encoding' is "utf-8" and a file contains an illegal byte
3059 sequence it won't be recognized as UTF-8. You can use the |8g8|
3060 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 WRONG VALUES: WHAT'S WRONG:
3062 latin1,utf-8 "latin1" will always be used
3063 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3064 file
3065 cp1250,latin1 "cp1250" will always be used
3066 If 'fileencodings' is empty, 'fileencoding' is not modified.
3067 See 'fileencoding' for the possible values.
3068 Setting this option does not have an effect until the next time a file
3069 is read.
3070
3071 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003072'fileformat' 'ff' string (MS-Windows default: "dos",
3073 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003075 This gives the <EOL> of the current buffer, which is used for
3076 reading/writing the buffer from/to a file:
3077 dos <CR> <NL>
3078 unix <NL>
3079 mac <CR>
3080 When "dos" is used, CTRL-Z at the end of a file is ignored.
3081 See |file-formats| and |file-read|.
3082 For the character encoding of the file see 'fileencoding'.
3083 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003084 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003085 This option is set automatically when starting to edit a file and
3086 'fileformats' is not empty and 'binary' is off.
3087 When this option is set, after starting to edit a file, the 'modified'
3088 option is set, because the file would be different when written.
3089 This option can not be changed when 'modifiable' is off.
3090 For backwards compatibility: When this option is set to "dos",
3091 'textmode' is set, otherwise 'textmode' is reset.
3092
3093 *'fileformats'* *'ffs'*
3094'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003095 Vim+Vi MS-Windows: "dos,unix",
3096 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 Vi Cygwin: "unix,dos",
3098 Vi others: "")
3099 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003100 This gives the end-of-line (<EOL>) formats that will be tried when
3101 starting to edit a new buffer and when reading a file into an existing
3102 buffer:
3103 - When empty, the format defined with 'fileformat' will be used
3104 always. It is not set automatically.
3105 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003106 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003107 'fileformats' name will be used when a file is read into an existing
3108 buffer, no matter what 'fileformat' for that buffer is set to.
3109 - When more than one name is present, separated by commas, automatic
3110 <EOL> detection will be done when reading a file. When starting to
3111 edit a file, a check is done for the <EOL>:
3112 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3113 'fileformat' is set to "dos".
3114 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003115 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003117 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3118 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003119 This means that "mac" is only chosen when:
3120 "unix" is not present or no <NL> is found in the file, and
3121 "dos" is not present or no <CR><NL> is found in the file.
3122 Except: if "unix" was chosen, but there is a <CR> before
3123 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003124 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 4. If 'fileformat' is still not set, the first name from
3126 'fileformats' is used.
3127 When reading a file into an existing buffer, the same is done, but
3128 this happens like 'fileformat' has been set appropriately for that
3129 file only, the option is not changed.
3130 When 'binary' is set, the value of 'fileformats' is not used.
3131
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003132 When Vim starts up with an empty buffer the first item is used. You
3133 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003134
Bram Moolenaar071d4272004-06-13 20:20:40 +00003135 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3136 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3137 done:
3138 - When 'fileformats' is empty, there is no automatic detection. Dos
3139 format will be used.
3140 - When 'fileformats' is set to one or more names, automatic detection
3141 is done. This is based on the first <NL> in the file: If there is a
3142 <CR> in front of it, Dos format is used, otherwise Unix format is
3143 used.
3144 Also see |file-formats|.
3145 For backwards compatibility: When this option is set to an empty
3146 string or one format (no comma is included), 'textauto' is reset,
3147 otherwise 'textauto' is set.
3148 NOTE: This option is set to the Vi default value when 'compatible' is
3149 set and to the Vim default value when 'compatible' is reset.
3150
Bram Moolenaarbf884932013-04-05 22:26:15 +02003151 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3152'fileignorecase' 'fic' boolean (default on for systems where case in file
3153 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003154 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003155 When set case is ignored when using file names and directories.
3156 See 'wildignorecase' for only ignoring case when doing completion.
3157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 *'filetype'* *'ft'*
3159'filetype' 'ft' string (default: "")
3160 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003161 When this option is set, the FileType autocommand event is triggered.
3162 All autocommands that match with the value of this option will be
3163 executed. Thus the value of 'filetype' is used in place of the file
3164 name.
3165 Otherwise this option does not always reflect the current file type.
3166 This option is normally set when the file type is detected. To enable
3167 this use the ":filetype on" command. |:filetype|
3168 Setting this option to a different value is most useful in a modeline,
3169 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003170 Example, for in an IDL file:
3171 /* vim: set filetype=idl : */ ~
3172 |FileType| |filetypes|
3173 When a dot appears in the value then this separates two filetype
3174 names. Example:
3175 /* vim: set filetype=c.doxygen : */ ~
3176 This will use the "c" filetype first, then the "doxygen" filetype.
3177 This works both for filetype plugins and for syntax files. More than
3178 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003179 This option is not copied to another buffer, independent of the 's' or
3180 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003181 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003182
3183 *'fillchars'* *'fcs'*
3184'fillchars' 'fcs' string (default "vert:|,fold:-")
3185 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003186 {not available when compiled without the |+folding|
3187 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 Characters to fill the statuslines and vertical separators.
3189 It is a comma separated list of items:
3190
3191 item default Used for ~
3192 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003193 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003194 vert:c '|' vertical separators |:vsplit|
3195 fold:c '-' filling 'foldtext'
3196 diff:c '-' deleted lines of the 'diff' option
3197
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003198 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003199 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003200 otherwise.
3201
3202 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003203 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003204< This is similar to the default, except that these characters will also
3205 be used when there is highlighting.
3206
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003207 for "stl" and "stlnc" only single-byte values are supported.
3208
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 The highlighting used for these items:
3210 item highlight group ~
3211 stl:c StatusLine |hl-StatusLine|
3212 stlnc:c StatusLineNC |hl-StatusLineNC|
3213 vert:c VertSplit |hl-VertSplit|
3214 fold:c Folded |hl-Folded|
3215 diff:c DiffDelete |hl-DiffDelete|
3216
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003217 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3218'fixendofline' 'fixeol' boolean (default on)
3219 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003220 When writing a file and this option is on, <EOL> at the end of file
3221 will be restored if missing. Turn this option off if you want to
3222 preserve the situation from the original file.
3223 When the 'binary' option is set the value of this option doesn't
3224 matter.
3225 See the 'endofline' option.
3226
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3228'fkmap' 'fk' boolean (default off) *E198*
3229 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003230 {only available when compiled with the |+rightleft|
3231 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003232 This option was for using Farsi, which has been removed. See
3233 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003234
3235 *'foldclose'* *'fcl'*
3236'foldclose' 'fcl' string (default "")
3237 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003238 {not available when compiled without the |+folding|
3239 feature}
3240 When set to "all", a fold is closed when the cursor isn't in it and
3241 its level is higher than 'foldlevel'. Useful if you want folds to
3242 automatically close when moving out of them.
3243
3244 *'foldcolumn'* *'fdc'*
3245'foldcolumn' 'fdc' number (default 0)
3246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 {not available when compiled without the |+folding|
3248 feature}
3249 When non-zero, a column with the specified width is shown at the side
3250 of the window which indicates open and closed folds. The maximum
3251 value is 12.
3252 See |folding|.
3253
3254 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3255'foldenable' 'fen' boolean (default on)
3256 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257 {not available when compiled without the |+folding|
3258 feature}
3259 When off, all folds are open. This option can be used to quickly
3260 switch between showing all text unfolded and viewing the text with
3261 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003262 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003263 'foldenable' is off.
3264 This option is set by commands that create a new fold or close a fold.
3265 See |folding|.
3266
3267 *'foldexpr'* *'fde'*
3268'foldexpr' 'fde' string (default: "0")
3269 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003271 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003273 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003274
Bram Moolenaar30b65812012-07-12 22:01:11 +02003275 The expression will be evaluated in the |sandbox| if set from a
3276 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003277 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003278 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003279
3280 It is not allowed to change text or jump to another window while
3281 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003282
3283 *'foldignore'* *'fdi'*
3284'foldignore' 'fdi' string (default: "#")
3285 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 {not available when compiled without the |+folding|
3287 feature}
3288 Used only when 'foldmethod' is "indent". Lines starting with
3289 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003290 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291 The default "#" works well for C programs. See |fold-indent|.
3292
3293 *'foldlevel'* *'fdl'*
3294'foldlevel' 'fdl' number (default: 0)
3295 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003296 {not available when compiled without the |+folding|
3297 feature}
3298 Sets the fold level: Folds with a higher level will be closed.
3299 Setting this option to zero will close all folds. Higher numbers will
3300 close fewer folds.
3301 This option is set by commands like |zm|, |zM| and |zR|.
3302 See |fold-foldlevel|.
3303
3304 *'foldlevelstart'* *'fdls'*
3305'foldlevelstart' 'fdls' number (default: -1)
3306 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003307 {not available when compiled without the |+folding|
3308 feature}
3309 Sets 'foldlevel' when starting to edit another buffer in a window.
3310 Useful to always start editing with all folds closed (value zero),
3311 some folds closed (one) or no folds closed (99).
3312 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 ignores this option and closes all folds.
3315 It is also done before BufReadPre autocommands, to allow an autocmd to
3316 overrule the 'foldlevel' value for specific files.
3317 When the value is negative, it is not used.
3318
3319 *'foldmarker'* *'fmr'* *E536*
3320'foldmarker' 'fmr' string (default: "{{{,}}}")
3321 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003322 {not available when compiled without the |+folding|
3323 feature}
3324 The start and end marker used when 'foldmethod' is "marker". There
3325 must be one comma, which separates the start and end marker. The
3326 marker is a literal string (a regular expression would be too slow).
3327 See |fold-marker|.
3328
3329 *'foldmethod'* *'fdm'*
3330'foldmethod' 'fdm' string (default: "manual")
3331 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003332 {not available when compiled without the |+folding|
3333 feature}
3334 The kind of folding used for the current window. Possible values:
3335 |fold-manual| manual Folds are created manually.
3336 |fold-indent| indent Lines with equal indent form a fold.
3337 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3338 |fold-marker| marker Markers are used to specify folds.
3339 |fold-syntax| syntax Syntax highlighting items specify folds.
3340 |fold-diff| diff Fold text that is not changed.
3341
3342 *'foldminlines'* *'fml'*
3343'foldminlines' 'fml' number (default: 1)
3344 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 {not available when compiled without the |+folding|
3346 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003347 Sets the number of screen lines above which a fold can be displayed
3348 closed. Also for manually closed folds. With the default value of
3349 one a fold can only be closed if it takes up two or more screen lines.
3350 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003351 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003352 "zc" to close a fold, which is displayed open because it's smaller
3353 than 'foldminlines', a following "zc" may close a containing fold.
3354
3355 *'foldnestmax'* *'fdn'*
3356'foldnestmax' 'fdn' number (default: 20)
3357 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 {not available when compiled without the |+folding|
3359 feature}
3360 Sets the maximum nesting of folds for the "indent" and "syntax"
3361 methods. This avoids that too many folds will be created. Using more
3362 than 20 doesn't work, because the internal limit is 20.
3363
3364 *'foldopen'* *'fdo'*
3365'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3366 search,tag,undo")
3367 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 {not available when compiled without the |+folding|
3369 feature}
3370 Specifies for which type of commands folds will be opened, if the
3371 command moves the cursor into a closed fold. It is a comma separated
3372 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003373 NOTE: When the command is part of a mapping this option is not used.
3374 Add the |zv| command to the mapping to get the same effect.
3375 (rationale: the mapping may want to control opening folds itself)
3376
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 item commands ~
3378 all any
3379 block "(", "{", "[[", "[{", etc.
3380 hor horizontal movements: "l", "w", "fx", etc.
3381 insert any command in Insert mode
3382 jump far jumps: "G", "gg", etc.
3383 mark jumping to a mark: "'m", CTRL-O, etc.
3384 percent "%"
3385 quickfix ":cn", ":crew", ":make", etc.
3386 search search for a pattern: "/", "n", "*", "gd", etc.
3387 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003388 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003389 tag jumping to a tag: ":ta", CTRL-T, etc.
3390 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 When a movement command is used for an operator (e.g., "dl" or "y%")
3392 this option is not used. This means the operator will include the
3393 whole closed fold.
3394 Note that vertical movements are not here, because it would make it
3395 very difficult to move onto a closed fold.
3396 In insert mode the folds containing the cursor will always be open
3397 when text is inserted.
3398 To close folds you can re-apply 'foldlevel' with the |zx| command or
3399 set the 'foldclose' option to "all".
3400
3401 *'foldtext'* *'fdt'*
3402'foldtext' 'fdt' string (default: "foldtext()")
3403 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 {not available when compiled without the |+folding|
3405 feature}
3406 An expression which is used to specify the text displayed for a closed
3407 fold. See |fold-foldtext|.
3408
Bram Moolenaar30b65812012-07-12 22:01:11 +02003409 The expression will be evaluated in the |sandbox| if set from a
3410 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003411 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003412
3413 It is not allowed to change text or jump to another window while
3414 evaluating 'foldtext' |textlock|.
3415
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003416 *'formatexpr'* *'fex'*
3417'formatexpr' 'fex' string (default "")
3418 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003419 {not available when compiled without the |+eval|
3420 feature}
3421 Expression which is evaluated to format a range of lines for the |gq|
3422 operator or automatic formatting (see 'formatoptions'). When this
3423 option is empty 'formatprg' is used.
3424
3425 The |v:lnum| variable holds the first line to be formatted.
3426 The |v:count| variable holds the number of lines to be formatted.
3427 The |v:char| variable holds the character that is going to be
3428 inserted if the expression is being evaluated due to
3429 automatic formatting. This can be empty. Don't insert
3430 it yet!
3431
3432 Example: >
3433 :set formatexpr=mylang#Format()
3434< This will invoke the mylang#Format() function in the
3435 autoload/mylang.vim file in 'runtimepath'. |autoload|
3436
3437 The expression is also evaluated when 'textwidth' is set and adding
3438 text beyond that limit. This happens under the same conditions as
3439 when internal formatting is used. Make sure the cursor is kept in the
3440 same spot relative to the text then! The |mode()| function will
3441 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003442
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003443 When the expression evaluates to non-zero Vim will fall back to using
3444 the internal format mechanism.
3445
3446 The expression will be evaluated in the |sandbox| when set from a
3447 modeline, see |sandbox-option|. That stops the option from working,
3448 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003449 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003450 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003451
Bram Moolenaar86b68352004-12-27 21:59:20 +00003452 *'formatlistpat'* *'flp'*
3453'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3454 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003455 A pattern that is used to recognize a list header. This is used for
3456 the "n" flag in 'formatoptions'.
3457 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003458 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003459 while still checking more characters. There must be a character
3460 following the pattern, when it matches the whole line it is handled
3461 like there is no match.
3462 The default recognizes a number, followed by an optional punctuation
3463 character and white space.
3464
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003465 *'formatoptions'* *'fo'*
3466'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3467 local to buffer
3468 This is a sequence of letters which describes how automatic
3469 formatting is to be done. See |fo-table|. When the 'paste' option is
3470 on, no formatting is done (like 'formatoptions' is empty). Commas can
3471 be inserted for readability.
3472 To avoid problems with flags that are added in the future, use the
3473 "+=" and "-=" feature of ":set" |add-option-flags|.
3474 NOTE: This option is set to the Vi default value when 'compatible' is
3475 set and to the Vim default value when 'compatible' is reset.
3476
Bram Moolenaar071d4272004-06-13 20:20:40 +00003477 *'formatprg'* *'fp'*
3478'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003479 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003480 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003481 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003482 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003483 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003484 If the 'formatexpr' option is not empty it will be used instead.
3485 Otherwise, if 'formatprg' option is an empty string, the internal
3486 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003487 Environment variables are expanded |:set_env|. See |option-backslash|
3488 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003489 This option cannot be set from a |modeline| or in the |sandbox|, for
3490 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491
Bram Moolenaard94464e2015-11-02 15:28:18 +01003492 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003493'fsync' 'fs' boolean (default on)
3494 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003495 When on, the library function fsync() will be called after writing a
3496 file. This will flush a file to disk, ensuring that it is safely
3497 written even on filesystems which do metadata-only journaling. This
3498 will force the harddrive to spin up on Linux systems running in laptop
3499 mode, so it may be undesirable in some situations. Be warned that
3500 turning this off increases the chances of data loss after a crash. On
3501 systems without an fsync() implementation, this variable is always
3502 off.
3503 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003504 'fsync' also applies to |writefile()|, unless a flag is used to
3505 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003506 This option cannot be set from a |modeline| or in the |sandbox|, for
3507 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003508
Bram Moolenaar071d4272004-06-13 20:20:40 +00003509 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3510'gdefault' 'gd' boolean (default off)
3511 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003512 When on, the ":substitute" flag 'g' is default on. This means that
3513 all matches in a line are substituted instead of one. When a 'g' flag
3514 is given to a ":substitute" command, this will toggle the substitution
3515 of all or one match. See |complex-change|.
3516
3517 command 'gdefault' on 'gdefault' off ~
3518 :s/// subst. all subst. one
3519 :s///g subst. one subst. all
3520 :s///gg subst. all subst. one
3521
3522 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003523 DEPRECATED: Setting this option may break plugins that are not aware
3524 of this option. Also, many users get confused that adding the /g flag
3525 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003526
3527 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003528'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003530 Format to recognize for the ":grep" command output.
3531 This is a scanf-like string that uses the same format as the
3532 'errorformat' option: see |errorformat|.
3533
3534 *'grepprg'* *'gp'*
3535'grepprg' 'gp' string (default "grep -n ",
3536 Unix: "grep -n $* /dev/null",
3537 Win32: "findstr /n" or "grep -n",
3538 VMS: "SEARCH/NUMBERS ")
3539 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003540 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003541 and '#' characters, which are expanded like when used in a command-
3542 line. The placeholder "$*" is allowed to specify where the arguments
3543 will be included. Environment variables are expanded |:set_env|. See
3544 |option-backslash| about including spaces and backslashes.
3545 When your "grep" accepts the "-H" argument, use this to make ":grep"
3546 also work well with a single file: >
3547 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003548< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003549 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3550 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003551 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 apply equally to 'grepprg'.
3553 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3554 otherwise it's "grep -n".
3555 This option cannot be set from a |modeline| or in the |sandbox|, for
3556 security reasons.
3557
3558 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3559'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3560 ve:ver35-Cursor,
3561 o:hor50-Cursor,
3562 i-ci:ver25-Cursor/lCursor,
3563 r-cr:hor20-Cursor/lCursor,
3564 sm:block-Cursor
3565 -blinkwait175-blinkoff150-blinkon175",
3566 for MS-DOS and Win32 console:
3567 "n-v-c:block,o:hor50,i-ci:hor15,
3568 r-cr:hor30,sm:block")
3569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003570 {only available when compiled with GUI enabled, and
3571 for MS-DOS and Win32 console}
3572 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003573 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003574 the height of the cursor can be changed. This can be done by
3575 specifying a block cursor, or a percentage for a vertical or
3576 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003577 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3578 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003580 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003581 mode-list and an argument-list:
3582 mode-list:argument-list,mode-list:argument-list,..
3583 The mode-list is a dash separated list of these modes:
3584 n Normal mode
3585 v Visual mode
3586 ve Visual mode with 'selection' "exclusive" (same as 'v',
3587 if not specified)
3588 o Operator-pending mode
3589 i Insert mode
3590 r Replace mode
3591 c Command-line Normal (append) mode
3592 ci Command-line Insert mode
3593 cr Command-line Replace mode
3594 sm showmatch in Insert mode
3595 a all modes
3596 The argument-list is a dash separated list of these arguments:
3597 hor{N} horizontal bar, {N} percent of the character height
3598 ver{N} vertical bar, {N} percent of the character width
3599 block block cursor, fills the whole character
3600 [only one of the above three should be present]
3601 blinkwait{N} *cursor-blinking*
3602 blinkon{N}
3603 blinkoff{N}
3604 blink times for cursor: blinkwait is the delay before
3605 the cursor starts blinking, blinkon is the time that
3606 the cursor is shown and blinkoff is the time that the
3607 cursor is not shown. The times are in msec. When one
3608 of the numbers is zero, there is no blinking. The
3609 default is: "blinkwait700-blinkon400-blinkoff250".
3610 These numbers are used for a missing entry. This
3611 means that blinking is enabled by default. To switch
3612 blinking off you can use "blinkon0". The cursor only
3613 blinks when Vim is waiting for input, not while
3614 executing a command.
3615 To make the cursor blink in an xterm, see
3616 |xterm-blink|.
3617 {group-name}
3618 a highlight group name, that sets the color and font
3619 for the cursor
3620 {group-name}/{group-name}
3621 Two highlight group names, the first is used when
3622 no language mappings are used, the other when they
3623 are. |language-mapping|
3624
3625 Examples of parts:
3626 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3627 block cursor with colors from the "nCursor"
3628 highlight group
3629 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3630 In Insert and Command-line Insert mode, use a
3631 30% vertical bar cursor with colors from the
3632 "iCursor" highlight group. Blink a bit
3633 faster.
3634
3635 The 'a' mode is different. It will set the given argument-list for
3636 all modes. It does not reset anything to defaults. This can be used
3637 to do a common setting for all modes. For example, to switch off
3638 blinking: "a:blinkon0"
3639
3640 Examples of cursor highlighting: >
3641 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3642 :highlight Cursor gui=NONE guifg=bg guibg=fg
3643<
3644 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003645 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003646'guifont' 'gfn' string (default "")
3647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003648 {only available when compiled with GUI enabled}
3649 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003650 In its simplest form the value is just one font name.
3651 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003652
3653 *'guifontset'* *'gfs'*
3654 *E250* *E252* *E234* *E597* *E598*
3655'guifontset' 'gfs' string (default "")
3656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 {only available when compiled with GUI enabled and
3658 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003659 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003660 When not empty, specifies two (or more) fonts to be used. The first
3661 one for normal English, the second one for your special language. See
3662 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003663
Bram Moolenaar071d4272004-06-13 20:20:40 +00003664 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3665'guifontwide' 'gfw' string (default "")
3666 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003667 {only available when compiled with GUI enabled}
3668 When not empty, specifies a comma-separated list of fonts to be used
3669 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003670 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003671
Bram Moolenaar071d4272004-06-13 20:20:40 +00003672 *'guiheadroom'* *'ghr'*
3673'guiheadroom' 'ghr' number (default 50)
3674 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003675 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 The number of pixels subtracted from the screen height when fitting
3677 the GUI window on the screen. Set this before the GUI is started,
3678 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003679 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 lines will be left for window decorations and other items on the
3681 screen. Set it to a negative value to allow windows taller than the
3682 screen.
3683
3684 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003685'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3686 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003687 "aegimrLtT" (GTK, Motif and Athena),
3688 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003691 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003692 sequence of letters which describes what components and options of the
3693 GUI should be used.
3694 To avoid problems with flags that are added in the future, use the
3695 "+=" and "-=" feature of ":set" |add-option-flags|.
3696
Bram Moolenaar13568252018-03-16 20:46:58 +01003697 Valid characters are as follows:
3698 *'go-!'*
3699 '!' External commands are executed in a terminal window. Without
3700 this flag the MS-Windows GUI will open a console window to
3701 execute the command. The Unix GUI will simulate a dumb
3702 terminal to list the command output.
3703 The terminal window will be positioned at the bottom, and grow
3704 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003705 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003706 'a' Autoselect: If present, then whenever VISUAL mode is started,
3707 or the Visual area extended, Vim tries to become the owner of
3708 the windowing system's global selection. This means that the
3709 Visually highlighted text is available for pasting into other
3710 applications as well as into Vim itself. When the Visual mode
3711 ends, possibly due to an operation on the text, or when an
3712 application wants to paste the selection, the highlighted text
3713 is automatically yanked into the "* selection register.
3714 Thus the selection is still available for pasting into other
3715 applications after the VISUAL mode has ended.
3716 If not present, then Vim won't become the owner of the
3717 windowing system's global selection unless explicitly told to
3718 by a yank or delete operation for the "* register.
3719 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003720 *'go-P'*
3721 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003722 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003723 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003724 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003725 applies to the modeless selection.
3726
3727 'guioptions' autoselect Visual autoselect modeless ~
3728 "" - -
3729 "a" yes yes
3730 "A" - yes
3731 "aA" yes yes
3732
Bram Moolenaar02467872007-05-06 13:22:01 +00003733 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 'c' Use console dialogs instead of popup dialogs for simple
3735 choices.
Bram Moolenaar02467872007-05-06 13:22:01 +00003736 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003737 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003738 'guitablabel' can be used to change the text in the labels.
3739 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003740 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003741 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003742 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 'f' Foreground: Don't use fork() to detach the GUI from the shell
3744 where it was started. Use this for programs that wait for the
3745 editor to finish (e.g., an e-mail program). Alternatively you
3746 can use "gvim -f" or ":gui -f" to start the GUI in the
3747 foreground. |gui-fork|
3748 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003749 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003750 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003751 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3752 corner of the window. It's black&white on non-GTK, because of
3753 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003754 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003756 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003757 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003758 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003759 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003760 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003761 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003762 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 'g' Grey menu items: Make menu items that are not active grey. If
3764 'g' is not included inactive menu items are not shown at all.
3765 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003766 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 't' Include tearoff menu items. Currently only works for Win32,
3768 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003769 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003770 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003771 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003772 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003773 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003774 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 'R' Right-hand scrollbar is present when there is a vertically
3776 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003777 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003778 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003779 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003780 'L' Left-hand scrollbar is present when there is a vertically
3781 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003782 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3784 the longest visible line, or on the cursor line if the 'h'
3785 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003786 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'h' Limit horizontal scrollbar size to the length of the cursor
3788 line. Reduces computations. |gui-horiz-scroll|
3789
3790 And yes, you may even have scrollbars on the left AND the right if
3791 you really want to :-). See |gui-scrollbars| for more information.
3792
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003793 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'v' Use a vertical button layout for dialogs. When not included,
3795 a horizontal layout is preferred, but when it doesn't fit a
3796 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003797 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003798 'p' Use Pointer callbacks for X11 GUI. This is required for some
3799 window managers. If the cursor is not blinking or hollow at
3800 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003801 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003802 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003803 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003804 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003805 *'go-k'*
3806 'k' Keep the GUI window size when adding/removing a scrollbar, or
3807 toolbar, tabline, etc. Instead, the behavior is similar to
3808 when the window is maximized and will adjust 'lines' and
3809 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003810 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003811 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003812
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 *'guipty'* *'noguipty'*
3814'guipty' boolean (default on)
3815 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003816 {only available when compiled with GUI enabled}
3817 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3818 I/O to/from shell commands. See |gui-pty|.
3819
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003820 *'guitablabel'* *'gtl'*
3821'guitablabel' 'gtl' string (default empty)
3822 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003823 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003824 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003825 pages line. When empty and when the result is empty Vim will use a
3826 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003827
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003828 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003829 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003830 The expression will be evaluated in the |sandbox| when set from a
3831 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003832 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003833
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003834 Only used when the GUI tab pages line is displayed. 'e' must be
3835 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3836 used.
3837
Bram Moolenaar57657d82006-04-21 22:12:41 +00003838 *'guitabtooltip'* *'gtt'*
3839'guitabtooltip' 'gtt' string (default empty)
3840 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003841 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003842 When nonempty describes the text to use in a tooltip for the GUI tab
3843 pages line. When empty Vim will use a default tooltip.
3844 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003845 You can include a line break. Simplest method is to use |:let|: >
3846 :let &guitabtooltip = "line one\nline two"
3847<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003848
Bram Moolenaar071d4272004-06-13 20:20:40 +00003849 *'helpfile'* *'hf'*
3850'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3851 (others) "$VIMRUNTIME/doc/help.txt")
3852 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003853 Name of the main help file. All distributed help files should be
3854 placed together in one directory. Additionally, all "doc" directories
3855 in 'runtimepath' will be used.
3856 Environment variables are expanded |:set_env|. For example:
3857 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003858 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003859 spaces and backslashes.
3860 This option cannot be set from a |modeline| or in the |sandbox|, for
3861 security reasons.
3862
3863 *'helpheight'* *'hh'*
3864'helpheight' 'hh' number (default 20)
3865 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003866 Minimal initial height of the help window when it is opened with the
3867 ":help" command. The initial height of the help window is half of the
3868 current window, or (when the 'ea' option is on) the same as other
3869 windows. When the height is less than 'helpheight', the height is
3870 set to 'helpheight'. Set to zero to disable.
3871
3872 *'helplang'* *'hlg'*
3873'helplang' 'hlg' string (default: messages language or empty)
3874 global
3875 {only available when compiled with the |+multi_lang|
3876 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003877 Comma separated list of languages. Vim will use the first language
3878 for which the desired help can be found. The English help will always
3879 be used as a last resort. You can add "en" to prefer English over
3880 another language, but that will only find tags that exist in that
3881 language and not in the English help.
3882 Example: >
3883 :set helplang=de,it
3884< This will first search German, then Italian and finally English help
3885 files.
3886 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3887 try to find the tag in the current language before using this option.
3888 See |help-translated|.
3889
3890 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3891'hidden' 'hid' boolean (default off)
3892 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 When off a buffer is unloaded when it is |abandon|ed. When on a
3894 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3895 displayed in another window, it does not become hidden, of course.
3896 The commands that move through the buffer list sometimes make a buffer
3897 hidden although the 'hidden' option is off: When the buffer is
3898 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003899 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003900 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003901 This option is set for one command with ":hide {command}" |:hide|.
3902 WARNING: It's easy to forget that you have changes in hidden buffers.
3903 Think twice when using ":q!" or ":qa!".
3904
3905 *'highlight'* *'hl'*
3906'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003907 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3908 d:Directory,e:ErrorMsg,i:IncSearch,
3909 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3910 N:CursorLineNr,r:Question,s:StatusLine,
3911 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003912 v:Visual,V:VisualNOS,w:WarningMsg,
3913 W:WildMenu,f:Folded,F:FoldColumn,
3914 A:DiffAdd,C:DiffChange,D:DiffDelete,
3915 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003916 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003917 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003918 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3919 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003920 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003921 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003922 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003923 This option can be used to set highlighting mode for various
3924 occasions. It is a comma separated list of character pairs. The
3925 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003926 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003928 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3929 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003930 characters from 'showbreak'
3931 |hl-Directory| d directories in CTRL-D listing and other special
3932 things in listings
3933 |hl-ErrorMsg| e error messages
3934 h (obsolete, ignored)
3935 |hl-IncSearch| i 'incsearch' highlighting
3936 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3937 |hl-MoreMsg| m |more-prompt|
3938 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003939 |hl-LineNr| n line number for ":number" and ":#" commands, and
3940 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003941 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3942 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 |hl-Question| r |hit-enter| prompt and yes/no questions
3944 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003945 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3947 |hl-VertSplit| c column used to separate vertically split windows
3948 |hl-Visual| v Visual mode
3949 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3950 Selection" Only X11 Gui's |gui-x11| and
3951 |xterm-clipboard|.
3952 |hl-WarningMsg| w warning messages
3953 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3954 |hl-Folded| f line used for closed folds
3955 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003956 |hl-DiffAdd| A added line in diff mode
3957 |hl-DiffChange| C changed line in diff mode
3958 |hl-DiffDelete| D deleted line in diff mode
3959 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003960 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003961 |hl-Conceal| - the placeholders used for concealed characters
3962 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003963 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003964 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003965 |hl-SpellRare| R rare word |spell|
3966 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003967 |hl-Pmenu| + popup menu normal line
3968 |hl-PmenuSel| = popup menu selected line
3969 |hl-PmenuSbar| x popup menu scrollbar
3970 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003971
3972 The display modes are:
3973 r reverse (termcap entry "mr" and "me")
3974 i italic (termcap entry "ZH" and "ZR")
3975 b bold (termcap entry "md" and "me")
3976 s standout (termcap entry "so" and "se")
3977 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003978 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003979 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003980 n no highlighting
3981 - no highlighting
3982 : use a highlight group
3983 The default is used for occasions that are not included.
3984 If you want to change what the display modes do, see |dos-colors|
3985 for an example.
3986 When using the ':' display mode, this must be followed by the name of
3987 a highlight group. A highlight group can be used to define any type
3988 of highlighting, including using color. See |:highlight| on how to
3989 define one. The default uses a different group for each occasion.
3990 See |highlight-default| for the default highlight groups.
3991
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003993'history' 'hi' number (Vim default: 50, Vi default: 0,
3994 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003995 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003997 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00003998 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02003999 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004000 NOTE: This option is set to the Vi default value when 'compatible' is
4001 set and to the Vim default value when 'compatible' is reset.
4002
4003 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4004'hkmap' 'hk' boolean (default off)
4005 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004006 {only available when compiled with the |+rightleft|
4007 feature}
4008 When on, the keyboard is mapped for the Hebrew character set.
4009 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4010 toggle this option. See |rileft.txt|.
4011 NOTE: This option is reset when 'compatible' is set.
4012
4013 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4014'hkmapp' 'hkp' boolean (default off)
4015 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 {only available when compiled with the |+rightleft|
4017 feature}
4018 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4019 This is useful if you have a non-Hebrew keyboard.
4020 See |rileft.txt|.
4021 NOTE: This option is reset when 'compatible' is set.
4022
Bram Moolenaar036986f2017-03-16 17:41:02 +01004023 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4024'hlsearch' 'hls' boolean (default off)
4025 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004026 {not available when compiled without the
4027 |+extra_search| feature}
4028 When there is a previous search pattern, highlight all its matches.
4029 The type of highlighting used can be set with the 'l' occasion in the
4030 'highlight' option. This uses the "Search" highlight group by
4031 default. Note that only the matching text is highlighted, any offsets
4032 are not applied.
4033 See also: 'incsearch' and |:match|.
4034 When you get bored looking at the highlighted matches, you can turn it
4035 off with |:nohlsearch|. This does not change the option value, as
4036 soon as you use a search command, the highlighting comes back.
4037 'redrawtime' specifies the maximum time spent on finding matches.
4038 When the search pattern can match an end-of-line, Vim will try to
4039 highlight all of the matched text. However, this depends on where the
4040 search starts. This will be the first line in the window or the first
4041 line below a closed fold. A match in a previous line which is not
4042 drawn may not continue in a newly drawn line.
4043 You can specify whether the highlight status is restored on startup
4044 with the 'h' flag in 'viminfo' |viminfo-h|.
4045 NOTE: This option is reset when 'compatible' is set.
4046
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 *'icon'* *'noicon'*
4048'icon' boolean (default off, on when title can be restored)
4049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004050 {not available when compiled without the |+title|
4051 feature}
4052 When on, the icon text of the window will be set to the value of
4053 'iconstring' (if it is not empty), or to the name of the file
4054 currently being edited. Only the last part of the name is used.
4055 Overridden by the 'iconstring' option.
4056 Only works if the terminal supports setting window icons (currently
4057 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4058 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4059 builtin termcap).
4060 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004061 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004063 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004064
4065 *'iconstring'*
4066'iconstring' string (default "")
4067 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004068 {not available when compiled without the |+title|
4069 feature}
4070 When this option is not empty, it will be used for the icon text of
4071 the window. This happens only when the 'icon' option is on.
4072 Only works if the terminal supports setting window icon text
4073 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4074 Does not work for MS Windows.
4075 When Vim was compiled with HAVE_X11 defined, the original icon will be
4076 restored if possible |X11|.
4077 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004078 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004079 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004080 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 {not available when compiled without the |+statusline| feature}
4082
4083 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4084'ignorecase' 'ic' boolean (default off)
4085 global
4086 Ignore case in search patterns. Also used when searching in the tags
4087 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004088 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004089 Can be overruled by using "\c" or "\C" in the pattern, see
4090 |/ignorecase|.
4091
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004092 *'imactivatefunc'* *'imaf'*
4093'imactivatefunc' 'imaf' string (default "")
4094 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004095 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004096 activate or deactivate the Input Method.
4097 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004098 The expression will be evaluated in the |sandbox| when set from a
4099 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004100
4101 Example: >
4102 function ImActivateFunc(active)
4103 if a:active
4104 ... do something
4105 else
4106 ... do something
4107 endif
4108 " return value is not used
4109 endfunction
4110 set imactivatefunc=ImActivateFunc
4111<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 *'imactivatekey'* *'imak'*
4113'imactivatekey' 'imak' string (default "")
4114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004115 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004116 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004117 Specifies the key that your Input Method in X-Windows uses for
4118 activation. When this is specified correctly, vim can fully control
4119 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4120 You can't use this option to change the activation key, the option
4121 tells Vim what the key is.
4122 Format:
4123 [MODIFIER_FLAG-]KEY_STRING
4124
4125 These characters can be used for MODIFIER_FLAG (case is ignored):
4126 S Shift key
4127 L Lock key
4128 C Control key
4129 1 Mod1 key
4130 2 Mod2 key
4131 3 Mod3 key
4132 4 Mod4 key
4133 5 Mod5 key
4134 Combinations are allowed, for example "S-C-space" or "SC-space" are
4135 both shift+ctrl+space.
4136 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4137
4138 Example: >
4139 :set imactivatekey=S-space
4140< "S-space" means shift+space. This is the activation key for kinput2 +
4141 canna (Japanese), and ami (Korean).
4142
4143 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4144'imcmdline' 'imc' boolean (default off)
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 When set the Input Method is always on when starting to edit a command
4147 line, unless entering a search pattern (see 'imsearch' for that).
4148 Setting this option is useful when your input method allows entering
4149 English characters directly, e.g., when it's used to type accented
4150 characters with dead keys.
4151
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004152 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004153'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4154 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004155 When set the Input Method is never used. This is useful to disable
4156 the IM when it doesn't work properly.
4157 Currently this option is on by default for SGI/IRIX machines. This
4158 may change in later releases.
4159
4160 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004161'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004163 Specifies whether :lmap or an Input Method (IM) is to be used in
4164 Insert mode. Valid values:
4165 0 :lmap is off and IM is off
4166 1 :lmap is ON and IM is off
4167 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004168 To always reset the option to zero when leaving Insert mode with <Esc>
4169 this can be used: >
4170 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4171< This makes :lmap and IM turn off automatically when leaving Insert
4172 mode.
4173 Note that this option changes when using CTRL-^ in Insert mode
4174 |i_CTRL-^|.
4175 The value is set to 1 when setting 'keymap' to a valid keymap name.
4176 It is also used for the argument of commands like "r" and "f".
4177 The value 0 may not work correctly with Athena and Motif with some XIM
4178 methods. Use 'imdisable' to disable XIM then.
4179
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004180 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004181 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004182 |+multi_byte_ime| or |global-ime|.
4183
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004185'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004187 Specifies whether :lmap or an Input Method (IM) is to be used when
4188 entering a search pattern. Valid values:
4189 -1 the value of 'iminsert' is used, makes it look like
4190 'iminsert' is also used when typing a search pattern
4191 0 :lmap is off and IM is off
4192 1 :lmap is ON and IM is off
4193 2 :lmap is off and IM is ON
4194 Note that this option changes when using CTRL-^ in Command-line mode
4195 |c_CTRL-^|.
4196 The value is set to 1 when it is not -1 and setting the 'keymap'
4197 option to a valid keymap name.
4198 The value 0 may not work correctly with Athena and Motif with some XIM
4199 methods. Use 'imdisable' to disable XIM then.
4200
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004201 *'imstatusfunc'* *'imsf'*
4202'imstatusfunc' 'imsf' string (default "")
4203 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004204 This option specifies a function that is called to obtain the status
4205 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004206 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004207
4208 Example: >
4209 function ImStatusFunc()
4210 let is_active = ...do something
4211 return is_active ? 1 : 0
4212 endfunction
4213 set imstatusfunc=ImStatusFunc
4214<
4215 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004216 The expression will be evaluated in the |sandbox| when set from a
4217 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004218
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004219 *'imstyle'* *'imst'*
4220'imstyle' 'imst' number (default 1)
4221 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004222 {only available when compiled with |+xim| and
4223 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004224 This option specifies the input style of Input Method:
4225 0 use on-the-spot style
4226 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004227 See: |xim-input-style|
4228
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004229 For a long time on-the-spot style had been used in the GTK version of
4230 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004231 |single-repeat|, etc. Therefore over-the-spot style becomes the
4232 default now. This should work fine for most people, however if you
4233 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004234 The expression will be evaluated in the |sandbox| when set from a
4235 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004236
Bram Moolenaar071d4272004-06-13 20:20:40 +00004237 *'include'* *'inc'*
4238'include' 'inc' string (default "^\s*#\s*include")
4239 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004240 {not available when compiled without the
4241 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004242 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004243 pattern, just like for the "/" command (See |pattern|). The default
4244 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004245 "]I", "[d", etc.
4246 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004247 comes after the matched pattern. But if "\zs" appears in the pattern
4248 then the text matched from "\zs" to the end, or until "\ze" if it
4249 appears, is used as the file name. Use this to include characters
4250 that are not in 'isfname', such as a space. You can then use
4251 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004252 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253
4254 *'includeexpr'* *'inex'*
4255'includeexpr' 'inex' string (default "")
4256 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004257 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004258 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004260 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004261 :set includeexpr=substitute(v:fname,'\\.','/','g')
4262< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004263
Bram Moolenaar071d4272004-06-13 20:20:40 +00004264 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004265 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004266 Also used for |<cfile>|.
4267
Bram Moolenaar30b65812012-07-12 22:01:11 +02004268 The expression will be evaluated in the |sandbox| when set from a
4269 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004270 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004271
4272 It is not allowed to change text or jump to another window while
4273 evaluating 'includeexpr' |textlock|.
4274
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004276'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4277 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004279 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004280 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004281 While typing a search command, show where the pattern, as it was typed
4282 so far, matches. The matched string is highlighted. If the pattern
4283 is invalid or not found, nothing is shown. The screen will be updated
4284 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004285 Also applies to the pattern in commands: >
4286 :global
4287 :lvimgrep
4288 :lvimgrepadd
4289 :smagic
4290 :snomagic
4291 :sort
4292 :substitute
4293 :vglobal
4294 :vimgrep
4295 :vimgrepadd
4296< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004297 original position when no match is found and when pressing <Esc>. You
4298 still need to finish the search command with <Enter> to move the
4299 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004300 You can use the CTRL-G and CTRL-T keys to move to the next and
4301 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004302 When compiled with the |+reltime| feature Vim only searches for about
4303 half a second. With a complicated pattern and/or a lot of text the
4304 match may not be found. This is to avoid that Vim hangs while you
4305 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004306 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004307 When 'hlsearch' is on, all matched strings are highlighted too while
4308 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004309 If you don't want to turn 'hlsearch' on, but want to highlight all
4310 matches while searching, you can turn on and off 'hlsearch' with
4311 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004312 augroup vimrc-incsearch-highlight
4313 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004314 autocmd CmdlineEnter /,\? :set hlsearch
4315 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004316 augroup END
4317<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004318 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004319 to the command line. If 'ignorecase' and 'smartcase' are set and the
4320 command line has no uppercase characters, the added character is
4321 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004322 CTRL-R CTRL-W can be used to add the word at the end of the current
4323 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004324 NOTE: This option is reset when 'compatible' is set.
4325
4326 *'indentexpr'* *'inde'*
4327'indentexpr' 'inde' string (default "")
4328 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004329 {not available when compiled without the |+cindent|
4330 or |+eval| features}
4331 Expression which is evaluated to obtain the proper indent for a line.
4332 It is used when a new line is created, for the |=| operator and
4333 in Insert mode as specified with the 'indentkeys' option.
4334 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004335 'smartindent' indenting. When 'lisp' is set, this option is
4336 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004337 When 'paste' is set this option is not used for indenting.
4338 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004339 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 when the expression is evaluated (but it may be moved around).
4341 The expression must return the number of spaces worth of indent. It
4342 can return "-1" to keep the current indent (this means 'autoindent' is
4343 used for the indent).
4344 Functions useful for computing the indent are |indent()|, |cindent()|
4345 and |lispindent()|.
4346 The evaluation of the expression must not have side effects! It must
4347 not change the text, jump to another window, etc. Afterwards the
4348 cursor position is always restored, thus the cursor may be moved.
4349 Normally this option would be set to call a function: >
4350 :set indentexpr=GetMyIndent()
4351< Error messages will be suppressed, unless the 'debug' option contains
4352 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004353 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004354 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355
Bram Moolenaar30b65812012-07-12 22:01:11 +02004356 The expression will be evaluated in the |sandbox| when set from a
4357 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004358 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004359
4360 It is not allowed to change text or jump to another window while
4361 evaluating 'indentexpr' |textlock|.
4362
4363
Bram Moolenaar071d4272004-06-13 20:20:40 +00004364 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004365'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004366 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367 {not available when compiled without the |+cindent|
4368 feature}
4369 A list of keys that, when typed in Insert mode, cause reindenting of
4370 the current line. Only happens if 'indentexpr' isn't empty.
4371 The format is identical to 'cinkeys', see |indentkeys-format|.
4372 See |C-indenting| and |indent-expression|.
4373
4374 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4375'infercase' 'inf' boolean (default off)
4376 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004377 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004378 'ignorecase' is also on, the case of the match is adjusted depending
4379 on the typed text. If the typed text contains a lowercase letter
4380 where the match has an upper case letter, the completed part is made
4381 lowercase. If the typed text has no lowercase letters and the match
4382 has a lowercase letter where the typed text has an uppercase letter,
4383 and there is a letter before it, the completed part is made uppercase.
4384 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004385
4386 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4387'insertmode' 'im' boolean (default off)
4388 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 Makes Vim work in a way that Insert mode is the default mode. Useful
4390 if you want to use Vim as a modeless editor. Used for |evim|.
4391 These Insert mode commands will be useful:
4392 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004393 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004394 this is a mapping, it is executed as if 'insertmode' was off.
4395 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004396 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004397 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4398 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004399
4400 These items change when 'insertmode' is set:
4401 - when starting to edit of a file, Vim goes to Insert mode.
4402 - <Esc> in Insert mode is a no-op and beeps.
4403 - <Esc> in Normal mode makes Vim go to Insert mode.
4404 - CTRL-L in Insert mode is a command, it is not inserted.
4405 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4406 However, when <Esc> is used inside a mapping, it behaves like
4407 'insertmode' was not set. This was done to be able to use the same
4408 mappings with 'insertmode' set or not set.
4409 When executing commands with |:normal| 'insertmode' is not used.
4410
4411 NOTE: This option is reset when 'compatible' is set.
4412
4413 *'isfname'* *'isf'*
4414'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4415 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4416 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4417 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4418 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4419 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4420 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004421 The characters specified by this option are included in file names and
4422 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004423 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004424 Multi-byte characters 256 and above are always included, only the
4425 characters up to 255 are specified with this option.
4426 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004427 Think twice before adding white space to this option. Although a
4428 space may appear inside a file name, the effect will be that Vim
4429 doesn't know where a file name starts or ends when doing completion.
4430 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004431
4432 Note that on systems using a backslash as path separator, Vim tries to
4433 do its best to make it work as you would expect. That is a bit
4434 tricky, since Vi originally used the backslash to escape special
4435 characters. Vim will not remove a backslash in front of a normal file
4436 name character on these systems, but it will on Unix and alikes. The
4437 '&' and '^' are not included by default, because these are special for
4438 cmd.exe.
4439
4440 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004441 Each part can be a single character number or a range. A range is two
4442 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443 decimal number between 0 and 255 or the ASCII character itself (does
4444 not work for digits). Example:
4445 "_,-,128-140,#-43" (include '_' and '-' and the range
4446 128 to 140 and '#' to 43)
4447 If a part starts with '^', the following character number or range
4448 will be excluded from the option. The option is interpreted from left
4449 to right. Put the excluded character after the range where it is
4450 included. To include '^' itself use it as the last character of the
4451 option or the end of a range. Example:
4452 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4453 If the character is '@', all characters where isalpha() returns TRUE
4454 are included. Normally these are the characters a to z and A to Z,
4455 plus accented characters. To include '@' itself use "@-@". Examples:
4456 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004457 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004458 "a-z,A-Z,@-@" All letters plus the '@' character.
4459 A comma can be included by using it where a character number is
4460 expected. Example:
4461 "48-57,,,_" Digits, comma and underscore.
4462 A comma can be excluded by prepending a '^'. Example:
4463 " -~,^,,9" All characters from space to '~', excluding
4464 comma, plus <Tab>.
4465 See |option-backslash| about including spaces and backslashes.
4466
4467 *'isident'* *'isi'*
4468'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4469 "@,48-57,_,128-167,224-235"
4470 otherwise: "@,48-57,_,192-255")
4471 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004472 The characters given by this option are included in identifiers.
4473 Identifiers are used in recognizing environment variables and after a
4474 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004475 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004476 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004477 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004478 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004479 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4480
4481 *'iskeyword'* *'isk'*
4482'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4483 "@,48-57,_,128-167,224-235"
4484 otherwise: "@,48-57,_,192-255"
4485 Vi default: "@,48-57,_")
4486 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004487 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004488 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004489 'isfname' for a description of the format of this option. For '@'
4490 characters above 255 check the "word" character class.
4491 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004492 For a help file it is set to all non-blank printable characters except
4493 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4494 command).
4495 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004496 This option also influences syntax highlighting, unless the syntax
4497 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004498 NOTE: This option is set to the Vi default value when 'compatible' is
4499 set and to the Vim default value when 'compatible' is reset.
4500
4501 *'isprint'* *'isp'*
4502'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4503 "@,~-255"; otherwise: "@,161-255")
4504 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004505 The characters given by this option are displayed directly on the
4506 screen. It is also used for "\p" in a |pattern|. The characters from
4507 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4508 even when they are not included in 'isprint' or excluded. See
4509 'isfname' for a description of the format of this option.
4510
4511 Non-printable characters are displayed with two characters:
4512 0 - 31 "^@" - "^_"
4513 32 - 126 always single characters
4514 127 "^?"
4515 128 - 159 "~@" - "~_"
4516 160 - 254 "| " - "|~"
4517 255 "~?"
4518 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4519 displayed as <xx>, with the hexadecimal value of the byte.
4520 When 'display' contains "uhex" all unprintable characters are
4521 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004522 The SpecialKey highlighting will be used for unprintable characters.
4523 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004524
4525 Multi-byte characters 256 and above are always included, only the
4526 characters up to 255 are specified with this option. When a character
4527 is printable but it is not available in the current font, a
4528 replacement character will be shown.
4529 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4530 There is no option to specify these characters.
4531
4532 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4533'joinspaces' 'js' boolean (default on)
4534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004535 Insert two spaces after a '.', '?' and '!' with a join command.
4536 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4537 Otherwise only one space is inserted.
4538 NOTE: This option is set when 'compatible' is set.
4539
4540 *'key'*
4541'key' string (default "")
4542 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004543 {only available when compiled with the |+cryptv|
4544 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004545 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004546 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 Careful: Do not set the key value by hand, someone might see the typed
4548 key. Use the |:X| command. But you can make 'key' empty: >
4549 :set key=
4550< It is not possible to get the value of this option with ":set key" or
4551 "echo &key". This is to avoid showing it to someone who shouldn't
4552 know. It also means you cannot see it yourself once you have set it,
4553 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004554 You can use "&key" in an expression to detect whether encryption is
4555 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004556
4557 *'keymap'* *'kmp'* *E544*
4558'keymap' 'kmp' string (default "")
4559 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004560 {only available when compiled with the |+keymap|
4561 feature}
4562 Name of a keyboard mapping. See |mbyte-keymap|.
4563 Setting this option to a valid keymap name has the side effect of
4564 setting 'iminsert' to one, so that the keymap becomes effective.
4565 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004566 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004567
4568 *'keymodel'* *'km'*
4569'keymodel' 'km' string (default "")
4570 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004571 List of comma separated words, which enable special things that keys
4572 can do. These values can be used:
4573 startsel Using a shifted special key starts selection (either
4574 Select mode or Visual mode, depending on "key" being
4575 present in 'selectmode').
4576 stopsel Using a not-shifted special key stops selection.
4577 Special keys in this context are the cursor keys, <End>, <Home>,
4578 <PageUp> and <PageDown>.
4579 The 'keymodel' option is set by the |:behave| command.
4580
4581 *'keywordprg'* *'kp'*
4582'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004583 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004584 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004585 Program to use for the |K| command. Environment variables are
4586 expanded |:set_env|. ":help" may be used to access the Vim internal
4587 help. (Note that previously setting the global option to the empty
4588 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004589 When the first character is ":", the command is invoked as a Vim
4590 Ex command prefixed with [count].
4591 When "man", "man -s" or an Ex command is used, Vim will automatically
4592 translate a count for the "K" command and pass it as the first
4593 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004594 See |option-backslash| about including spaces and backslashes.
4595 Example: >
4596 :set keywordprg=man\ -s
4597< This option cannot be set from a |modeline| or in the |sandbox|, for
4598 security reasons.
4599
4600 *'langmap'* *'lmap'* *E357* *E358*
4601'langmap' 'lmap' string (default "")
4602 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004603 {only available when compiled with the |+langmap|
4604 feature}
4605 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004606 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004607 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004608 care of translating these special characters to the original meaning
4609 of the key. This means you don't have to change the keyboard mode to
4610 be able to execute Normal mode commands.
4611 This is the opposite of the 'keymap' option, where characters are
4612 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004613 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004614 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004615 This option cannot be set from a |modeline| or in the |sandbox|, for
4616 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004617
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004618 Example (for Greek, in UTF-8): *greek* >
4619 :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 +00004620< Example (exchanges meaning of z and y for commands): >
4621 :set langmap=zy,yz,ZY,YZ
4622<
4623 The 'langmap' option is a list of parts, separated with commas. Each
4624 part can be in one of two forms:
4625 1. A list of pairs. Each pair is a "from" character immediately
4626 followed by the "to" character. Examples: "aA", "aAbBcC".
4627 2. A list of "from" characters, a semi-colon and a list of "to"
4628 characters. Example: "abc;ABC"
4629 Example: "aA,fgh;FGH,cCdDeE"
4630 Special characters need to be preceded with a backslash. These are
4631 ";", ',' and backslash itself.
4632
4633 This will allow you to activate vim actions without having to switch
4634 back and forth between the languages. Your language characters will
4635 be understood as normal vim English characters (according to the
4636 langmap mappings) in the following cases:
4637 o Normal/Visual mode (commands, buffer/register names, user mappings)
4638 o Insert/Replace Mode: Register names after CTRL-R
4639 o Insert/Replace Mode: Mappings
4640 Characters entered in Command-line mode will NOT be affected by
4641 this option. Note that this option can be changed at any time
4642 allowing to switch between mappings for different languages/encodings.
4643 Use a mapping to avoid having to type it each time!
4644
4645 *'langmenu'* *'lm'*
4646'langmenu' 'lm' string (default "")
4647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648 {only available when compiled with the |+menu| and
4649 |+multi_lang| features}
4650 Language to use for menu translation. Tells which file is loaded
4651 from the "lang" directory in 'runtimepath': >
4652 "lang/menu_" . &langmenu . ".vim"
4653< (without the spaces). For example, to always use the Dutch menus, no
4654 matter what $LANG is set to: >
4655 :set langmenu=nl_NL.ISO_8859-1
4656< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004657 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004658 If your $LANG is set to a non-English language but you do want to use
4659 the English menus: >
4660 :set langmenu=none
4661< This option must be set before loading menus, switching on filetype
4662 detection or syntax highlighting. Once the menus are defined setting
4663 this option has no effect. But you could do this: >
4664 :source $VIMRUNTIME/delmenu.vim
4665 :set langmenu=de_DE.ISO_8859-1
4666 :source $VIMRUNTIME/menu.vim
4667< Warning: This deletes all menus that you defined yourself!
4668
Bram Moolenaard94464e2015-11-02 15:28:18 +01004669 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004670'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004671 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004672 {only available when compiled with the |+langmap|
4673 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004674 This is just like 'langremap' but with the value inverted. It only
4675 exists for backwards compatibility. When setting 'langremap' then
4676 'langnoremap' is set to the inverted value, and the other way around.
4677
4678 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4679'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4680 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004681 {only available when compiled with the |+langmap|
4682 feature}
4683 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004684 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004685 'langmap' disables some of your mappings, try resetting this option.
4686 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004687 that works for you to avoid mappings to break.
4688
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 *'laststatus'* *'ls'*
4690'laststatus' 'ls' number (default 1)
4691 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004692 The value of this option influences when the last window will have a
4693 status line:
4694 0: never
4695 1: only if there are at least two windows
4696 2: always
4697 The screen looks nicer with a status line if you have several
4698 windows, but it takes another screen line. |status-line|
4699
4700 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4701'lazyredraw' 'lz' boolean (default off)
4702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004703 When this option is set, the screen will not be redrawn while
4704 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004705 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004706 update use |:redraw|.
4707
4708 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4709'linebreak' 'lbr' boolean (default off)
4710 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004711 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004712 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004713 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004714 than at the last character that fits on the screen. Unlike
4715 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004716 it only affects the way the file is displayed, not its contents.
4717 If 'breakindent' is set, line is visually indented. Then, the value
4718 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004719 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 Note that <Tab> characters after an <EOL> are mostly not displayed
4721 with the right amount of white space.
4722
4723 *'lines'* *E593*
4724'lines' number (default 24 or terminal height)
4725 global
4726 Number of lines of the Vim window.
4727 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004728 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004729 When Vim is running in the GUI or in a resizable window, setting this
4730 option will cause the window size to be changed. When you only want
4731 to use the size for the GUI, put the command in your |gvimrc| file.
4732 Vim limits the number of lines to what fits on the screen. You can
4733 use this command to get the tallest window possible: >
4734 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004735< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004736 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 When you set this option and Vim is unable to change the physical
4738 number of lines of the display, the display may be messed up.
4739
4740 *'linespace'* *'lsp'*
4741'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 {only in the GUI}
4744 Number of pixel lines inserted between characters. Useful if the font
4745 uses the full character cell height, making lines touch each other.
4746 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004747 With some fonts there can be too much room between lines (to have
4748 space for ascents and descents). Then it makes sense to set
4749 'linespace' to a negative value. This may cause display problems
4750 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751
4752 *'lisp'* *'nolisp'*
4753'lisp' boolean (default off)
4754 local to buffer
4755 {not available when compiled without the |+lispindent|
4756 feature}
4757 Lisp mode: When <Enter> is typed in insert mode set the indent for
4758 the next line to Lisp standards (well, sort of). Also happens with
4759 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4760 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4761 better. Also see 'lispwords'.
4762 The '-' character is included in keyword characters. Redefines the
4763 "=" operator to use this same indentation algorithm rather than
4764 calling an external program if 'equalprg' is empty.
4765 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004766
4767 *'lispwords'* *'lw'*
4768'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004769 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004770 {not available when compiled without the |+lispindent|
4771 feature}
4772 Comma separated list of words that influence the Lisp indenting.
4773 |'lisp'|
4774
4775 *'list'* *'nolist'*
4776'list' boolean (default off)
4777 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004778 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4779 line. Useful to see the difference between tabs and spaces and for
4780 trailing blanks. Further changed by the 'listchars' option.
4781
4782 The cursor is displayed at the start of the space a Tab character
4783 occupies, not at the end as usual in Normal mode. To get this cursor
4784 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004785 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004786<
4787 Note that list mode will also affect formatting (set with 'textwidth'
4788 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004789 changing the way tabs are displayed.
4790
4791 *'listchars'* *'lcs'*
4792'listchars' 'lcs' string (default "eol:$")
4793 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004794 Strings to use in 'list' mode and for the |:list| command. It is a
4795 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004796 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797 eol:c Character to show at the end of each line. When
4798 omitted, there is no extra character at the end of the
4799 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004800 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004801 tab:xy[z] Two or three characters to be used to show a tab.
4802 The third character is optional.
4803
4804 tab:xy The 'x' is always used, then 'y' as many times as will
4805 fit. Thus "tab:>-" displays:
4806 >
4807 >-
4808 >--
4809 etc.
4810
4811 tab:xyz The 'z' is always used, then 'x' is prepended, and
4812 then 'y' is used as many times as will fit. Thus
4813 "tab:<->" displays:
4814 >
4815 <>
4816 <->
4817 <-->
4818 etc.
4819
4820 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004821 *lcs-space*
4822 space:c Character to show for a space. When omitted, spaces
4823 are left blank.
4824 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004825 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004826 trailing spaces are blank. Overrides the "space"
4827 setting for trailing spaces.
4828 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004829 extends:c Character to show in the last column, when 'wrap' is
4830 off and the line continues beyond the right of the
4831 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004832 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004833 precedes:c Character to show in the first column, when 'wrap'
4834 is off and there is text preceding the character
4835 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004836 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004837 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004838 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004839 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004840 nbsp:c Character to show for a non-breakable space character
4841 (0xA0 (160 decimal) and U+202F). Left blank when
4842 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004843
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004844 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004846 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004847
4848 Examples: >
4849 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004850 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004851 :set lcs=extends:>,precedes:<
4852< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004853 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004854 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
4856 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4857'loadplugins' 'lpl' boolean (default on)
4858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859 When on the plugin scripts are loaded when starting up |load-plugins|.
4860 This option can be reset in your |vimrc| file to disable the loading
4861 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004862 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4863 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004864
Bram Moolenaard94464e2015-11-02 15:28:18 +01004865 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004866'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004867 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004868 {only available when compiled with the |+lua/dyn|
4869 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004870 Specifies the name of the Lua shared library. The default is
4871 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004872 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004873 This option cannot be set from a |modeline| or in the |sandbox|, for
4874 security reasons.
4875
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004876 *'macatsui'* *'nomacatsui'*
4877'macatsui' boolean (default on)
4878 global
4879 {only available in Mac GUI version}
4880 This is a workaround for when drawing doesn't work properly. When set
4881 and compiled with multi-byte support ATSUI text drawing is used. When
4882 not set ATSUI text drawing is not used. Switch this option off when
4883 you experience drawing problems. In a future version the problems may
4884 be solved and this option becomes obsolete. Therefore use this method
4885 to unset it: >
4886 if exists('&macatsui')
4887 set nomacatsui
4888 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004889< Another option to check if you have drawing problems is
4890 'termencoding'.
4891
Bram Moolenaar071d4272004-06-13 20:20:40 +00004892 *'magic'* *'nomagic'*
4893'magic' boolean (default on)
4894 global
4895 Changes the special characters that can be used in search patterns.
4896 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004897 WARNING: Switching this option off most likely breaks plugins! That
4898 is because many patterns assume it's on and will fail when it's off.
4899 Only switch it off when working with old Vi scripts. In any other
4900 situation write patterns that work when 'magic' is on. Include "\M"
4901 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004902
4903 *'makeef'* *'mef'*
4904'makeef' 'mef' string (default: "")
4905 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004906 {not available when compiled without the |+quickfix|
4907 feature}
4908 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4909 and the |:grep| command.
4910 When it is empty, an internally generated temp file will be used.
4911 When "##" is included, it is replaced by a number to make the name
4912 unique. This makes sure that the ":make" command doesn't overwrite an
4913 existing file.
4914 NOT used for the ":cf" command. See 'errorfile' for that.
4915 Environment variables are expanded |:set_env|.
4916 See |option-backslash| about including spaces and backslashes.
4917 This option cannot be set from a |modeline| or in the |sandbox|, for
4918 security reasons.
4919
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004920 *'makeencoding'* *'menc'*
4921'makeencoding' 'menc' string (default "")
4922 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004923 Encoding used for reading the output of external commands. When empty,
4924 encoding is not converted.
4925 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4926 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4927 and `:laddfile`.
4928
4929 This would be mostly useful when you use MS-Windows and set 'encoding'
4930 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4931 'makeencoding' to "char" has the same effect as setting to the system
4932 locale encoding. Example: >
4933 :set encoding=utf-8
4934 :set makeencoding=char " system locale is used
4935<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004936 *'makeprg'* *'mp'*
4937'makeprg' 'mp' string (default "make", VMS: "MMS")
4938 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004939 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004940 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4941 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004942 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004943 Environment variables are expanded |:set_env|. See |option-backslash|
4944 about including spaces and backslashes.
4945 Note that a '|' must be escaped twice: once for ":set" and once for
4946 the interpretation of a command. When you use a filter called
4947 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 :set makeprg=gmake\ \\\|\ myfilter
4949< The placeholder "$*" can be given (even multiple times) to specify
4950 where the arguments will be included, for example: >
4951 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4952< This option cannot be set from a |modeline| or in the |sandbox|, for
4953 security reasons.
4954
4955 *'matchpairs'* *'mps'*
4956'matchpairs' 'mps' string (default "(:),{:},[:]")
4957 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004958 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004959 other.
4960 Only character pairs are allowed that are different, thus you cannot
4961 jump between two double quotes.
4962 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004963 The pairs must be separated by a comma. Example for including '<' and
4964 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004965 :set mps+=<:>
4966
4967< A more exotic example, to jump between the '=' and ';' in an
4968 assignment, useful for languages like C and Java: >
4969 :au FileType c,cpp,java set mps+==:;
4970
4971< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004972 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004973
4974 *'matchtime'* *'mat'*
4975'matchtime' 'mat' number (default 5)
4976 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 Tenths of a second to show the matching paren, when 'showmatch' is
4978 set. Note that this is not in milliseconds, like other options that
4979 set a time. This is to be compatible with Nvi.
4980
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004981 *'maxcombine'* *'mco'*
4982'maxcombine' 'mco' number (default 2)
4983 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004984 The maximum number of combining characters supported for displaying.
4985 Only used when 'encoding' is "utf-8".
4986 The default is OK for most languages. Hebrew may require 4.
4987 Maximum value is 6.
4988 Even when this option is set to 2 you can still edit text with more
4989 combining characters, you just can't see them. Use |g8| or |ga|.
4990 See |mbyte-combining|.
4991
Bram Moolenaar071d4272004-06-13 20:20:40 +00004992 *'maxfuncdepth'* *'mfd'*
4993'maxfuncdepth' 'mfd' number (default 100)
4994 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02004995 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00004996 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004997 Maximum depth of function calls for user functions. This normally
4998 catches endless recursion. When using a recursive function with
4999 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5000 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005001 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005002 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005003 See also |:function|.
5004
5005 *'maxmapdepth'* *'mmd'* *E223*
5006'maxmapdepth' 'mmd' number (default 1000)
5007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 Maximum number of times a mapping is done without resulting in a
5009 character to be used. This normally catches endless mappings, like
5010 ":map x y" with ":map y x". It still does not catch ":map g wg",
5011 because the 'w' is used before the next mapping is done. See also
5012 |key-mapping|.
5013
5014 *'maxmem'* *'mm'*
5015'maxmem' 'mm' number (default between 256 to 5120 (system
5016 dependent) or half the amount of memory
5017 available)
5018 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5020 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005021 other memory to be freed.
5022 The maximum usable value is about 2000000. Use this to work without a
5023 limit.
5024 The value is ignored when 'swapfile' is off.
5025 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005026
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005027 *'maxmempattern'* *'mmp'*
5028'maxmempattern' 'mmp' number (default 1000)
5029 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005030 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005031 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005032 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005033 When Vim runs into the limit it gives an error message and mostly
5034 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005035 Running into the limit often means that the pattern is very
5036 inefficient or too complex. This may already happen with the pattern
5037 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005038 Might also happen on redraw, when syntax rules try to match a complex
5039 text structure.
5040 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5041 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005042
Bram Moolenaar071d4272004-06-13 20:20:40 +00005043 *'maxmemtot'* *'mmt'*
5044'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5045 dependent) or half the amount of memory
5046 available)
5047 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005048 Maximum amount of memory in Kbyte to use for all buffers together.
5049 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005050 without a limit.
5051 On 64 bit machines higher values might work. But hey, do you really
5052 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005053 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005054 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005055 Buffers with 'swapfile' off still count to the total amount of memory
5056 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005057 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005058
5059 *'menuitems'* *'mis'*
5060'menuitems' 'mis' number (default 25)
5061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005062 {not available when compiled without the |+menu|
5063 feature}
5064 Maximum number of items to use in a menu. Used for menus that are
5065 generated from a list of items, e.g., the Buffers menu. Changing this
5066 option has no direct effect, the menu must be refreshed first.
5067
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005068 *'mkspellmem'* *'msm'*
5069'mkspellmem' 'msm' string (default "460000,2000,500")
5070 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005071 {not available when compiled without the |+syntax|
5072 feature}
5073 Parameters for |:mkspell|. This tunes when to start compressing the
5074 word tree. Compression can be slow when there are many words, but
5075 it's needed to avoid running out of memory. The amount of memory used
5076 per word depends very much on how similar the words are, that's why
5077 this tuning is complicated.
5078
5079 There are three numbers, separated by commas:
5080 {start},{inc},{added}
5081
5082 For most languages the uncompressed word tree fits in memory. {start}
5083 gives the amount of memory in Kbyte that can be used before any
5084 compression is done. It should be a bit smaller than the amount of
5085 memory that is available to Vim.
5086
5087 When going over the {start} limit the {inc} number specifies the
5088 amount of memory in Kbyte that can be allocated before another
5089 compression is done. A low number means compression is done after
5090 less words are added, which is slow. A high number means more memory
5091 will be allocated.
5092
5093 After doing compression, {added} times 1024 words can be added before
5094 the {inc} limit is ignored and compression is done when any extra
5095 amount of memory is needed. A low number means there is a smaller
5096 chance of hitting the {inc} limit, less memory is used but it's
5097 slower.
5098
5099 The languages for which these numbers are important are Italian and
5100 Hungarian. The default works for when you have about 512 Mbyte. If
5101 you have 1 Gbyte you could use: >
5102 :set mkspellmem=900000,3000,800
5103< If you have less than 512 Mbyte |:mkspell| may fail for some
5104 languages, no matter what you set 'mkspellmem' to.
5105
Bram Moolenaar07607392019-05-26 19:20:43 +02005106 This option cannot be set from a |modeline| or in the |sandbox|.
5107
Bram Moolenaar071d4272004-06-13 20:20:40 +00005108 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005109'modeline' 'ml' boolean (Vim default: on (off for root),
5110 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005111 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005112 If 'modeline' is on 'modelines' gives the number of lines that is
5113 checked for set commands. If 'modeline' is off or 'modelines' is zero
5114 no lines are checked. See |modeline|.
5115
5116 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5117'modelineexpr' 'mle' boolean (default: off)
5118 global
5119 When on allow some options that are an expression to be set in the
5120 modeline. Check the option for whether it is affected by
5121 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005122 This option cannot be set from a |modeline| or in the |sandbox|, for
5123 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005124
Bram Moolenaar071d4272004-06-13 20:20:40 +00005125 *'modelines'* *'mls'*
5126'modelines' 'mls' number (default 5)
5127 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005128 If 'modeline' is on 'modelines' gives the number of lines that is
5129 checked for set commands. If 'modeline' is off or 'modelines' is zero
5130 no lines are checked. See |modeline|.
5131 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5132 set and to the Vim default value when 'compatible' is reset.
5133
5134 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005135 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005136'modifiable' 'ma' boolean (default on)
5137 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005138 When off the buffer contents cannot be changed. The 'fileformat' and
5139 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005140 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141
5142 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5143'modified' 'mod' boolean (default off)
5144 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005145 When on, the buffer is considered to be modified. This option is set
5146 when:
5147 1. A change was made to the text since it was last written. Using the
5148 |undo| command to go back to the original text will reset the
5149 option. But undoing changes that were made before writing the
5150 buffer will set the option again, since the text is different from
5151 when it was written.
5152 2. 'fileformat' or 'fileencoding' is different from its original
5153 value. The original value is set when the buffer is read or
5154 written. A ":set nomodified" command also resets the original
5155 values to the current values and the 'modified' option will be
5156 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005157 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005158 This option is not set when a change is made to the buffer as the
5159 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5160 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5161 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005162 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5163 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005164 Note that the text may actually be the same, e.g. 'modified' is set
5165 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005166
5167 *'more'* *'nomore'*
5168'more' boolean (Vim default: on, Vi default: off)
5169 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005170 When on, listings pause when the whole screen is filled. You will get
5171 the |more-prompt|. When this option is off there are no pauses, the
5172 listing continues until finished.
5173 NOTE: This option is set to the Vi default value when 'compatible' is
5174 set and to the Vim default value when 'compatible' is reset.
5175
5176 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005177'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5178 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005179 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005180 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005181 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5182 sysmouse and Linux console with gpm). For using the mouse in the
5183 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005184 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005185 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 v Visual mode
5187 i Insert mode
5188 c Command-line mode
5189 h all previous modes when editing a help file
5190 a all previous modes
5191 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005192 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 :set mouse=a
5194< When the mouse is not enabled, the GUI will still use the mouse for
5195 modeless selection. This doesn't move the text cursor.
5196
5197 See |mouse-using|. Also see |'clipboard'|.
5198
5199 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005200 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 the mouse buttons can still be used by keeping the shift key pressed.
5202 Also see the 'clipboard' option.
5203
5204 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5205'mousefocus' 'mousef' boolean (default off)
5206 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005207 {only works in the GUI}
5208 The window that the mouse pointer is on is automatically activated.
5209 When changing the window layout or window focus in another way, the
5210 mouse pointer is moved to the window with keyboard focus. Off is the
5211 default because it makes using the pull down menus a little goofy, as
5212 a pointer transit may activate a window unintentionally.
5213
5214 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5215'mousehide' 'mh' boolean (default on)
5216 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 {only works in the GUI}
5218 When on, the mouse pointer is hidden when characters are typed.
5219 The mouse pointer is restored when the mouse is moved.
5220
5221 *'mousemodel'* *'mousem'*
5222'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5223 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005224 Sets the model to use for the mouse. The name mostly specifies what
5225 the right mouse button is used for:
5226 extend Right mouse button extends a selection. This works
5227 like in an xterm.
5228 popup Right mouse button pops up a menu. The shifted left
5229 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005230 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005231 popup_setpos Like "popup", but the cursor will be moved to the
5232 position where the mouse was clicked, and thus the
5233 selected operation will act upon the clicked object.
5234 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005235 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 course, that right clicking outside a selection will
5237 end Visual mode.
5238 Overview of what button does what for each model:
5239 mouse extend popup(_setpos) ~
5240 left click place cursor place cursor
5241 left drag start selection start selection
5242 shift-left search word extend selection
5243 right click extend selection popup menu (place cursor)
5244 right drag extend selection -
5245 middle click paste paste
5246
5247 In the "popup" model the right mouse button produces a pop-up menu.
5248 You need to define this first, see |popup-menu|.
5249
5250 Note that you can further refine the meaning of buttons with mappings.
5251 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5252 selection (because that's handled in the GUI code directly).
5253
5254 The 'mousemodel' option is set by the |:behave| command.
5255
5256 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005257'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5258 vs:leftright,vd:lrsizing,m:no,
5259 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005261 {only available when compiled with the |+mouseshape|
5262 feature}
5263 This option tells Vim what the mouse pointer should look like in
5264 different modes. The option is a comma separated list of parts, much
5265 like used for 'guicursor'. Each part consist of a mode/location-list
5266 and an argument-list:
5267 mode-list:shape,mode-list:shape,..
5268 The mode-list is a dash separated list of these modes/locations:
5269 In a normal window: ~
5270 n Normal mode
5271 v Visual mode
5272 ve Visual mode with 'selection' "exclusive" (same as 'v',
5273 if not specified)
5274 o Operator-pending mode
5275 i Insert mode
5276 r Replace mode
5277
5278 Others: ~
5279 c appending to the command-line
5280 ci inserting in the command-line
5281 cr replacing in the command-line
5282 m at the 'Hit ENTER' or 'More' prompts
5283 ml idem, but cursor in the last line
5284 e any mode, pointer below last window
5285 s any mode, pointer on a status line
5286 sd any mode, while dragging a status line
5287 vs any mode, pointer on a vertical separator line
5288 vd any mode, while dragging a vertical separator line
5289 a everywhere
5290
5291 The shape is one of the following:
5292 avail name looks like ~
5293 w x arrow Normal mouse pointer
5294 w x blank no pointer at all (use with care!)
5295 w x beam I-beam
5296 w x updown up-down sizing arrows
5297 w x leftright left-right sizing arrows
5298 w x busy The system's usual busy pointer
5299 w x no The system's usual 'no input' pointer
5300 x udsizing indicates up-down resizing
5301 x lrsizing indicates left-right resizing
5302 x crosshair like a big thin +
5303 x hand1 black hand
5304 x hand2 white hand
5305 x pencil what you write with
5306 x question big ?
5307 x rightup-arrow arrow pointing right-up
5308 w x up-arrow arrow pointing up
5309 x <number> any X11 pointer number (see X11/cursorfont.h)
5310
5311 The "avail" column contains a 'w' if the shape is available for Win32,
5312 x for X11.
5313 Any modes not specified or shapes not available use the normal mouse
5314 pointer.
5315
5316 Example: >
5317 :set mouseshape=s:udsizing,m:no
5318< will make the mouse turn to a sizing arrow over the status lines and
5319 indicate no input when the hit-enter prompt is displayed (since
5320 clicking the mouse has no effect in this state.)
5321
5322 *'mousetime'* *'mouset'*
5323'mousetime' 'mouset' number (default 500)
5324 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005325 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5326 time in msec between two mouse clicks for the second click to be
5327 recognized as a multi click.
5328
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005329 *'mzschemedll'*
5330'mzschemedll' string (default depends on the build)
5331 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005332 {only available when compiled with the |+mzscheme/dyn|
5333 feature}
5334 Specifies the name of the MzScheme shared library. The default is
5335 DYNAMIC_MZSCH_DLL which was specified at compile time.
5336 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005337 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005338 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005339 This option cannot be set from a |modeline| or in the |sandbox|, for
5340 security reasons.
5341
5342 *'mzschemegcdll'*
5343'mzschemegcdll' string (default depends on the build)
5344 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005345 {only available when compiled with the |+mzscheme/dyn|
5346 feature}
5347 Specifies the name of the MzScheme GC shared library. The default is
5348 DYNAMIC_MZGC_DLL which was specified at compile time.
5349 The value can be equal to 'mzschemedll' if it includes the GC code.
5350 Environment variables are expanded |:set_env|.
5351 This option cannot be set from a |modeline| or in the |sandbox|, for
5352 security reasons.
5353
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005354 *'mzquantum'* *'mzq'*
5355'mzquantum' 'mzq' number (default 100)
5356 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005357 {not available when compiled without the |+mzscheme|
5358 feature}
5359 The number of milliseconds between polls for MzScheme threads.
5360 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005361 NOTE: This option is set to the Vim default value when 'compatible'
5362 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005363
Bram Moolenaar071d4272004-06-13 20:20:40 +00005364 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005365'nrformats' 'nf' string (default "bin,octal,hex",
5366 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005367 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005368 This defines what bases Vim will consider for numbers when using the
5369 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5370 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005371 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005372 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005373 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005374 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005375 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005376 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005377 considered to be hexadecimal. Example: Using CTRL-X on
5378 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005379 bin If included, numbers starting with "0b" or "0B" will be
5380 considered to be binary. Example: Using CTRL-X on
5381 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005382 Numbers which simply begin with a digit in the range 1-9 are always
5383 considered decimal. This also happens for numbers that are not
5384 recognized as octal or hex.
5385
5386 *'number'* *'nu'* *'nonumber'* *'nonu'*
5387'number' 'nu' boolean (default off)
5388 local to window
5389 Print the line number in front of each line. When the 'n' option is
5390 excluded from 'cpoptions' a wrapped line will not use the column of
5391 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005392 The 'numberwidth' option can be used to set the room used for the line
5393 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 When a long, wrapped line doesn't start with the first character, '-'
5395 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005396 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5397 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005398 *number_relativenumber*
5399 The 'relativenumber' option changes the displayed number to be
5400 relative to the cursor. Together with 'number' there are these
5401 four combinations (cursor in line 3):
5402
Bram Moolenaar3848e002016-03-19 18:42:29 +01005403 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005404 'nornu' 'nornu' 'rnu' 'rnu'
5405
5406 |apple | 1 apple | 2 apple | 2 apple
5407 |pear | 2 pear | 1 pear | 1 pear
5408 |nobody | 3 nobody | 0 nobody |3 nobody
5409 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005411 *'numberwidth'* *'nuw'*
5412'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5413 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005414 {only available when compiled with the |+linebreak|
5415 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005416 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005417 when the 'number' or 'relativenumber' option is set or printing lines
5418 with a line number. Since one space is always between the number and
5419 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005420 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005421 fit the highest line number in the buffer respectively the number of
5422 rows in the window, depending on whether 'number' or 'relativenumber'
5423 is set. Thus with the Vim default of 4 there is room for a line number
5424 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005425 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005426 NOTE: This option is set to the Vi default value when 'compatible' is
5427 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005428
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005429 *'omnifunc'* *'ofu'*
5430'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005431 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005432 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005433 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005434 This option specifies a function to be used for Insert mode omni
5435 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005436 See |complete-functions| for an explanation of how the function is
5437 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005438 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005439 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005440 This option cannot be set from a |modeline| or in the |sandbox|, for
5441 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005442
5443
Bram Moolenaar02467872007-05-06 13:22:01 +00005444 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005445'opendevice' 'odev' boolean (default off)
5446 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005447 {only for MS-DOS, MS-Windows and OS/2}
5448 Enable reading and writing from devices. This may get Vim stuck on a
5449 device that can be opened but doesn't actually do the I/O. Therefore
5450 it is off by default.
5451 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5452 result in editing a device.
5453
5454
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005455 *'operatorfunc'* *'opfunc'*
5456'operatorfunc' 'opfunc' string (default: empty)
5457 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005458 This option specifies a function to be called by the |g@| operator.
5459 See |:map-operator| for more info and an example.
5460
5461 This option cannot be set from a |modeline| or in the |sandbox|, for
5462 security reasons.
5463
5464
Bram Moolenaar251e1912011-06-19 05:09:16 +02005465 *'osfiletype'* *'oft'*
5466'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005467 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005468 This option was supported on RISC OS, which has been removed.
5469
Bram Moolenaar071d4272004-06-13 20:20:40 +00005470
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005471 *'packpath'* *'pp'*
5472'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005473 Directories used to find packages. See |packages|.
5474
5475
Bram Moolenaar071d4272004-06-13 20:20:40 +00005476 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005477'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005478 global
5479 Specifies the nroff macros that separate paragraphs. These are pairs
5480 of two letters (see |object-motions|).
5481
5482 *'paste'* *'nopaste'*
5483'paste' boolean (default off)
5484 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005485 Put Vim in Paste mode. This is useful if you want to cut or copy
5486 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005487 unexpected effects.
5488 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005489 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 knows about pasting and will mostly do the right thing without 'paste'
5491 being set. The same is true for a terminal where Vim handles the
5492 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005493 This option is reset when starting the GUI. Thus if you set it in
5494 your .vimrc it will work in a terminal, but not in the GUI. Setting
5495 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5496 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005497 When the 'paste' option is switched on (also when it was already on):
5498 - mapping in Insert mode and Command-line mode is disabled
5499 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005500 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005501 - 'expandtab' is reset
5502 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 - 'revins' is reset
5504 - 'ruler' is reset
5505 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005506 - 'smartindent' is reset
5507 - 'smarttab' is reset
5508 - 'softtabstop' is set to 0
5509 - 'textwidth' is set to 0
5510 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005511 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005513 - 'indentexpr'
5514 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 NOTE: When you start editing another file while the 'paste' option is
5516 on, settings from the modelines or autocommands may change the
5517 settings again, causing trouble when pasting text. You might want to
5518 set the 'paste' option again.
5519 When the 'paste' option is reset the mentioned options are restored to
5520 the value before the moment 'paste' was switched from off to on.
5521 Resetting 'paste' before ever setting it does not have any effect.
5522 Since mapping doesn't work while 'paste' is active, you need to use
5523 the 'pastetoggle' option to toggle the 'paste' option with some key.
5524
5525 *'pastetoggle'* *'pt'*
5526'pastetoggle' 'pt' string (default "")
5527 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 When non-empty, specifies the key sequence that toggles the 'paste'
5529 option. This is like specifying a mapping: >
5530 :map {keys} :set invpaste<CR>
5531< Where {keys} is the value of 'pastetoggle'.
5532 The difference is that it will work even when 'paste' is set.
5533 'pastetoggle' works in Insert mode and Normal mode, but not in
5534 Command-line mode.
5535 Mappings are checked first, thus overrule 'pastetoggle'. However,
5536 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5537 this: >
5538 :map <F10> :set paste<CR>
5539 :map <F11> :set nopaste<CR>
5540 :imap <F10> <C-O>:set paste<CR>
5541 :imap <F11> <nop>
5542 :set pastetoggle=<F11>
5543< This will make <F10> start paste mode and <F11> stop paste mode.
5544 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5545 mode everything is inserted literally, except the 'pastetoggle' key
5546 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005547 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005548
5549 *'pex'* *'patchexpr'*
5550'patchexpr' 'pex' string (default "")
5551 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 {not available when compiled without the |+diff|
5553 feature}
5554 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005555 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005556
Bram Moolenaardbc28022014-07-26 13:40:44 +02005557 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005558'patchmode' 'pm' string (default "")
5559 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560 When non-empty the oldest version of a file is kept. This can be used
5561 to keep the original version of a file if you are changing files in a
5562 source distribution. Only the first time that a file is written a
5563 copy of the original file will be kept. The name of the copy is the
5564 name of the original file with the string in the 'patchmode' option
5565 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005566 ".orig" or ".org". 'backupdir' must not be empty for this to work
5567 (Detail: The backup file is renamed to the patchmode file after the
5568 new file has been successfully written, that's why it must be possible
5569 to write a backup file). If there was no file to be backed up, an
5570 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005571 When the 'backupskip' pattern matches, a patchmode file is not made.
5572 Using 'patchmode' for compressed files appends the extension at the
5573 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5574 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005575 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005577 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005578'path' 'pa' string (default on Unix: ".,/usr/include,,"
5579 on OS/2: ".,/emx/include,,"
5580 other systems: ".,,")
5581 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005582 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005583 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5584 provided that the file being searched for has a relative path (not
5585 starting with "/", "./" or "../"). The directories in the 'path'
5586 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 - Use commas to separate directory names: >
5588 :set path=.,/usr/local/include,/usr/include
5589< - Spaces can also be used to separate directory names (for backwards
5590 compatibility with version 3.0). To have a space in a directory
5591 name, precede it with an extra backslash, and escape the space: >
5592 :set path=.,/dir/with\\\ space
5593< - To include a comma in a directory name precede it with an extra
5594 backslash: >
5595 :set path=.,/dir/with\\,comma
5596< - To search relative to the directory of the current file, use: >
5597 :set path=.
5598< - To search in the current directory use an empty string between two
5599 commas: >
5600 :set path=,,
5601< - A directory name may end in a ':' or '/'.
5602 - Environment variables are expanded |:set_env|.
5603 - When using |netrw.vim| URLs can be used. For example, adding
5604 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005605 - Search upwards and downwards in a directory tree using "*", "**" and
5606 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005607 {not available when compiled without the |+path_extra| feature}
5608 - Careful with '\' characters, type two to get one in the option: >
5609 :set path=.,c:\\include
5610< Or just use '/' instead: >
5611 :set path=.,c:/include
5612< Don't forget "." or files won't even be found in the same directory as
5613 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005614 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005615 it is something like 256 or 1024 characters.
5616 You can check if all the include files are found, using the value of
5617 'path', see |:checkpath|.
5618 The use of |:set+=| and |:set-=| is preferred when adding or removing
5619 directories from the list. This avoids problems when a future version
5620 uses another default. To remove the current directory use: >
5621 :set path-=
5622< To add the current directory use: >
5623 :set path+=
5624< To use an environment variable, you probably need to replace the
5625 separator. Here is an example to append $INCL, in which directory
5626 names are separated with a semi-colon: >
5627 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5628< Replace the ';' with a ':' or whatever separator is used. Note that
5629 this doesn't work when $INCL contains a comma or white space.
5630
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005631 *'perldll'*
5632'perldll' string (default depends on the build)
5633 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005634 {only available when compiled with the |+perl/dyn|
5635 feature}
5636 Specifies the name of the Perl shared library. The default is
5637 DYNAMIC_PERL_DLL, which was specified at compile time.
5638 Environment variables are expanded |:set_env|.
5639 This option cannot be set from a |modeline| or in the |sandbox|, for
5640 security reasons.
5641
Bram Moolenaar071d4272004-06-13 20:20:40 +00005642 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5643'preserveindent' 'pi' boolean (default off)
5644 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005645 When changing the indent of the current line, preserve as much of the
5646 indent structure as possible. Normally the indent is replaced by a
5647 series of tabs followed by spaces as required (unless |'expandtab'| is
5648 enabled, in which case only spaces are used). Enabling this option
5649 means the indent will preserve as many existing characters as possible
5650 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005651 'expandtab' does not apply to the preserved white space, a Tab remains
5652 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005653 NOTE: When using ">>" multiple times the resulting indent is a mix of
5654 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005655 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005656 Also see 'copyindent'.
5657 Use |:retab| to clean up white space.
5658
5659 *'previewheight'* *'pvh'*
5660'previewheight' 'pvh' number (default 12)
5661 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005662 {not available when compiled without the |+quickfix|
5663 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005664 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005665 commands. Used for |CTRL-W_}| when no count is given. Not used when
5666 'previewpopup' is set.
5667
5668 *'previewpopup'* *'pvp'*
5669'previewpopup' 'pvp' string (default empty)
5670 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005671 {not available when compiled without the |+textprop|
5672 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005673 When not empty a popup window is used for commands that would open a
5674 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005675 Not used for the insert completion info, add "popup" to
5676 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005677
5678 *'previewwindow'* *'nopreviewwindow'*
5679 *'pvw'* *'nopvw'* *E590*
5680'previewwindow' 'pvw' boolean (default off)
5681 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005682 {not available when compiled without the |+quickfix|
5683 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005684 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 set. It's normally not set directly, but by using one of the commands
5686 |:ptag|, |:pedit|, etc.
5687
5688 *'printdevice'* *'pdev'*
5689'printdevice' 'pdev' string (default empty)
5690 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005691 {only available when compiled with the |+printer|
5692 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005693 The name of the printer to be used for |:hardcopy|.
5694 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005695 This option cannot be set from a |modeline| or in the |sandbox|, for
5696 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697
Bram Moolenaar8299df92004-07-10 09:47:34 +00005698 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005699'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005700 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 {only available when compiled with the |+printer|
5702 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005703 Sets the character encoding used when printing.
5704 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005705
5706 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005707'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005708 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709 {only available when compiled with the |+printer|
5710 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005711 Expression used to print the PostScript produced with |:hardcopy|.
5712 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005713 This option cannot be set from a |modeline| or in the |sandbox|, for
5714 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005715
Bram Moolenaar8299df92004-07-10 09:47:34 +00005716 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717'printfont' 'pfn' string (default "courier")
5718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005719 {only available when compiled with the |+printer|
5720 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005721 The name of the font that will be used for |:hardcopy|.
5722 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005723
5724 *'printheader'* *'pheader'*
5725'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5726 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727 {only available when compiled with the |+printer|
5728 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005729 The format of the header produced in |:hardcopy| output.
5730 See |pheader-option|.
5731
5732 *'printmbcharset'* *'pmbcs'*
5733'printmbcharset' 'pmbcs' string (default "")
5734 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005735 {only available when compiled with the |+printer|
5736 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005737 The CJK character set to be used for CJK output from |:hardcopy|.
5738 See |pmbcs-option|.
5739
5740 *'printmbfont'* *'pmbfn'*
5741'printmbfont' 'pmbfn' string (default "")
5742 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005743 {only available when compiled with the |+printer|
5744 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005745 List of font names to be used for CJK output from |:hardcopy|.
5746 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005747
5748 *'printoptions'* *'popt'*
5749'printoptions' 'popt' string (default "")
5750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005751 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005752 List of items that control the format of the output of |:hardcopy|.
5753 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005754
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005755 *'prompt'* *'noprompt'*
5756'prompt' boolean (default on)
5757 global
5758 When on a ":" prompt is used in Ex mode.
5759
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005760 *'pumheight'* *'ph'*
5761'pumheight' 'ph' number (default 0)
5762 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005763 Determines the maximum number of items to show in the popup menu for
5764 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005765 |ins-completion-menu|.
5766
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005767 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005768'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005769 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005770 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005771 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005772
Bram Moolenaard94464e2015-11-02 15:28:18 +01005773 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005774'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005775 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005776 {only available when compiled with the |+python/dyn|
5777 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005778 Specifies the name of the Python 2.x shared library. The default is
5779 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005780 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005781 This option cannot be set from a |modeline| or in the |sandbox|, for
5782 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005783
Bram Moolenaar94073162018-01-31 21:49:05 +01005784 *'pythonhome'*
5785'pythonhome' string (default "")
5786 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005787 {only available when compiled with the |+python/dyn|
5788 feature}
5789 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5790 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5791 which was specified at compile time, will be used for the Python 2.x
5792 home directory.
5793 Environment variables are expanded |:set_env|.
5794 This option cannot be set from a |modeline| or in the |sandbox|, for
5795 security reasons.
5796
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005797 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005798'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005799 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005800 {only available when compiled with the |+python3/dyn|
5801 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005802 Specifies the name of the Python 3 shared library. The default is
5803 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005804 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005805 This option cannot be set from a |modeline| or in the |sandbox|, for
5806 security reasons.
5807
Bram Moolenaar94073162018-01-31 21:49:05 +01005808 *'pythonthreehome'*
5809'pythonthreehome' string (default "")
5810 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005811 {only available when compiled with the |+python3/dyn|
5812 feature}
5813 Specifies the name of the Python 3 home directory. When
5814 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5815 PYTHON3_HOME, which was specified at compile time, will be used for
5816 the Python 3 home directory.
5817 Environment variables are expanded |:set_env|.
5818 This option cannot be set from a |modeline| or in the |sandbox|, for
5819 security reasons.
5820
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005821 *'pyxversion'* *'pyx'*
5822'pyxversion' 'pyx' number (default depends on the build)
5823 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005824 {only available when compiled with the |+python| or
5825 the |+python3| feature}
5826 Specifies the python version used for pyx* functions and commands
5827 |python_x|. The default value is as follows:
5828
5829 Compiled with Default ~
5830 |+python| and |+python3| 0
5831 only |+python| 2
5832 only |+python3| 3
5833
5834 Available values are 0, 2 and 3.
5835 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5836 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5837 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5838 to 2 if Python 2 is available.
5839 See also: |has-pythonx|
5840
5841 If Vim is compiled with only |+python| or |+python3| setting
5842 'pyxversion' has no effect. The pyx* functions and commands are
5843 always the same as the compiled version.
5844
5845 This option cannot be set from a |modeline| or in the |sandbox|, for
5846 security reasons.
5847
Bram Moolenaar677ee682005-01-27 14:41:15 +00005848 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005849'quoteescape' 'qe' string (default "\")
5850 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005851 The characters that are used to escape quotes in a string. Used for
5852 objects like a', a" and a` |a'|.
5853 When one of the characters in this option is found inside a string,
5854 the following character will be skipped. The default value makes the
5855 text "foo\"bar\\" considered to be one string.
5856
Bram Moolenaar071d4272004-06-13 20:20:40 +00005857 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5858'readonly' 'ro' boolean (default off)
5859 local to buffer
5860 If on, writes fail unless you use a '!'. Protects you from
5861 accidentally overwriting a file. Default on when Vim is started
5862 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005863 When using ":w!" the 'readonly' option is reset for the current
5864 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005865 When using the ":view" command the 'readonly' option is set for the
5866 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005867 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005868
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005869 *'redrawtime'* *'rdt'*
5870'redrawtime' 'rdt' number (default 2000)
5871 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005872 {only available when compiled with the |+reltime|
5873 feature}
5874 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005875 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005876 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005877 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005878 matches will be highlighted.
5879 For syntax highlighting the time applies per window. When over the
5880 limit syntax highlighting is disabled until |CTRL-L| is used.
5881 This is used to avoid that Vim hangs when using a very complicated
5882 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005883
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005884 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005885'regexpengine' 're' number (default 0)
5886 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005887 This selects the default regexp engine. |two-engines|
5888 The possible values are:
5889 0 automatic selection
5890 1 old engine
5891 2 NFA engine
5892 Note that when using the NFA engine and the pattern contains something
5893 that is not supported the pattern will not match. This is only useful
5894 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005895 Using automatic selection enables Vim to switch the engine, if the
5896 default engine becomes too costly. E.g., when the NFA engine uses too
5897 many states. This should prevent Vim from hanging on a combination of
5898 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005899
Bram Moolenaar64486672010-05-16 15:46:46 +02005900 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5901'relativenumber' 'rnu' boolean (default off)
5902 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005903 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005904 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005905 precede some vertical motion commands (e.g. j k + -) with, without
5906 having to calculate it yourself. Especially useful in combination with
5907 other commands (e.g. y d c < > gq gw =).
5908 When the 'n' option is excluded from 'cpoptions' a wrapped
5909 line will not use the column of line numbers (this is the default when
5910 'compatible' isn't set).
5911 The 'numberwidth' option can be used to set the room used for the line
5912 number.
5913 When a long, wrapped line doesn't start with the first character, '-'
5914 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005915 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5916 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005917
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005918 The number in front of the cursor line also depends on the value of
5919 'number', see |number_relativenumber| for all combinations of the two
5920 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005921
Bram Moolenaar071d4272004-06-13 20:20:40 +00005922 *'remap'* *'noremap'*
5923'remap' boolean (default on)
5924 global
5925 Allows for mappings to work recursively. If you do not want this for
5926 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005927 NOTE: To avoid portability problems with Vim scripts, always keep
5928 this option at the default "on". Only switch it off when working with
5929 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005930
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005931 *'renderoptions'* *'rop'*
5932'renderoptions' 'rop' string (default: empty)
5933 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005934 {only available when compiled with GUI and DIRECTX on
5935 MS-Windows}
5936 Select a text renderer and set its options. The options depend on the
5937 renderer.
5938
5939 Syntax: >
5940 set rop=type:{renderer}(,{name}:{value})*
5941<
5942 Currently, only one optional renderer is available.
5943
5944 render behavior ~
5945 directx Vim will draw text using DirectX (DirectWrite). It makes
5946 drawn glyphs more beautiful than default GDI.
5947 It requires 'encoding' is "utf-8", and only works on
5948 MS-Windows Vista or newer version.
5949
5950 Options:
5951 name meaning type value ~
5952 gamma gamma float 1.0 - 2.2 (maybe)
5953 contrast enhancedContrast float (unknown)
5954 level clearTypeLevel float (unknown)
5955 geom pixelGeometry int 0 - 2 (see below)
5956 renmode renderingMode int 0 - 6 (see below)
5957 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005958 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005959
Bram Moolenaar92467d32017-12-05 13:22:16 +01005960 See this URL for detail (except for scrlines):
5961 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005962
5963 For geom: structure of a device pixel.
5964 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5965 1 - DWRITE_PIXEL_GEOMETRY_RGB
5966 2 - DWRITE_PIXEL_GEOMETRY_BGR
5967
5968 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005969 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005970
5971 For renmode: method of rendering glyphs.
5972 0 - DWRITE_RENDERING_MODE_DEFAULT
5973 1 - DWRITE_RENDERING_MODE_ALIASED
5974 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5975 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5976 4 - DWRITE_RENDERING_MODE_NATURAL
5977 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5978 6 - DWRITE_RENDERING_MODE_OUTLINE
5979
5980 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005981 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005982
5983 For taamode: antialiasing mode used for drawing text.
5984 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5985 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5986 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5987 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
5988
5989 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005990 https://msdn.microsoft.com/en-us/library/dd368170.aspx
5991
Bram Moolenaara338adc2018-01-31 20:51:47 +01005992 For scrlines:
5993 This was used for optimizing scrolling behavior, however this
5994 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005995
5996 Example: >
5997 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01005998 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005999 set rop=type:directx
6000<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006001 If select a raster font (Courier, Terminal or FixedSys which
6002 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006003 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006004
6005 NOTE: It is known that some fonts and options combination
6006 causes trouble on drawing glyphs.
6007
Bram Moolenaar92467d32017-12-05 13:22:16 +01006008 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006009 special made fonts (True-Type fonts which includes only
6010 bitmap glyphs).
6011 - 'taamode:3' will not work with some vector fonts.
6012
6013 NOTE: With this option, you can display colored emoji
6014 (emoticon) in Windows 8.1 or later. To display colored emoji,
6015 there are some conditions which you should notice.
6016
6017 - If your font includes non-colored emoji already, it will
6018 be used.
6019 - If your font doesn't have emoji, the system chooses an
6020 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6021 will be used.
6022 - When this alternative font didn't have fixed width glyph,
6023 emoji might be rendered beyond the bounding box of drawing
6024 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006025
6026 Other render types are currently not supported.
6027
Bram Moolenaar071d4272004-06-13 20:20:40 +00006028 *'report'*
6029'report' number (default 2)
6030 global
6031 Threshold for reporting number of lines changed. When the number of
6032 changed lines is more than 'report' a message will be given for most
6033 ":" commands. If you want it always, set 'report' to 0.
6034 For the ":substitute" command the number of substitutions is used
6035 instead of the number of lines.
6036
6037 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6038'restorescreen' 'rs' boolean (default on)
6039 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006040 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006041 When set, the screen contents is restored when exiting Vim. This also
6042 happens when executing external commands.
6043
6044 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6045 options in your .vimrc. To disable restoring:
6046 set t_ti= t_te=
6047 To enable restoring (for an xterm):
6048 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6049 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6050
6051 *'revins'* *'ri'* *'norevins'* *'nori'*
6052'revins' 'ri' boolean (default off)
6053 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006054 {only available when compiled with the |+rightleft|
6055 feature}
6056 Inserting characters in Insert mode will work backwards. See "typing
6057 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6058 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006059 NOTE: This option is reset when 'compatible' is set.
6060 This option is reset when 'paste' is set and restored when 'paste' is
6061 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006062
6063 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6064'rightleft' 'rl' boolean (default off)
6065 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 {only available when compiled with the |+rightleft|
6067 feature}
6068 When on, display orientation becomes right-to-left, i.e., characters
6069 that are stored in the file appear from the right to the left.
6070 Using this option, it is possible to edit files for languages that
6071 are written from the right to the left such as Hebrew and Arabic.
6072 This option is per window, so it is possible to edit mixed files
6073 simultaneously, or to view the same file in both ways (this is
6074 useful whenever you have a mixed text file with both right-to-left
6075 and left-to-right strings so that both sets are displayed properly
6076 in different windows). Also see |rileft.txt|.
6077
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006078 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006079'rightleftcmd' 'rlc' string (default "search")
6080 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 {only available when compiled with the |+rightleft|
6082 feature}
6083 Each word in this option enables the command line editing to work in
6084 right-to-left mode for a group of commands:
6085
6086 search "/" and "?" commands
6087
6088 This is useful for languages such as Hebrew, Arabic and Farsi.
6089 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6090
Bram Moolenaard94464e2015-11-02 15:28:18 +01006091 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006092'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006093 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006094 {only available when compiled with the |+ruby/dyn|
6095 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006096 Specifies the name of the Ruby shared library. The default is
6097 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006098 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006099 This option cannot be set from a |modeline| or in the |sandbox|, for
6100 security reasons.
6101
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006103'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006105 {not available when compiled without the
6106 |+cmdline_info| feature}
6107 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006108 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006109 text in the file is shown on the far right:
6110 Top first line is visible
6111 Bot last line is visible
6112 All first and last line are visible
6113 45% relative position in the file
6114 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006115 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006117 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 this option takes precedence over 'ruler' and 'rulerformat'
6119 If the number of characters displayed is different from the number of
6120 bytes in the text (e.g., for a TAB or a multi-byte character), both
6121 the text column (byte number) and the screen column are shown,
6122 separated with a dash.
6123 For an empty line "0-1" is shown.
6124 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006125 This option is reset when 'paste' is set and restored when 'paste' is
6126 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006127 If you don't want to see the ruler all the time but want to know where
6128 you are, use "g CTRL-G" |g_CTRL-G|.
6129 NOTE: This option is reset when 'compatible' is set.
6130
6131 *'rulerformat'* *'ruf'*
6132'rulerformat' 'ruf' string (default empty)
6133 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 {not available when compiled without the |+statusline|
6135 feature}
6136 When this option is not empty, it determines the content of the ruler
6137 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006138 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006139 This option cannot be set in a modeline when 'modelineexpr' is off.
6140
Bram Moolenaar071d4272004-06-13 20:20:40 +00006141 The default ruler width is 17 characters. To make the ruler 15
6142 characters wide, put "%15(" at the start and "%)" at the end.
6143 Example: >
6144 :set rulerformat=%15(%c%V\ %p%%%)
6145<
6146 *'runtimepath'* *'rtp'* *vimfiles*
6147'runtimepath' 'rtp' string (default:
6148 Unix: "$HOME/.vim,
6149 $VIM/vimfiles,
6150 $VIMRUNTIME,
6151 $VIM/vimfiles/after,
6152 $HOME/.vim/after"
6153 Amiga: "home:vimfiles,
6154 $VIM/vimfiles,
6155 $VIMRUNTIME,
6156 $VIM/vimfiles/after,
6157 home:vimfiles/after"
6158 PC, OS/2: "$HOME/vimfiles,
6159 $VIM/vimfiles,
6160 $VIMRUNTIME,
6161 $VIM/vimfiles/after,
6162 $HOME/vimfiles/after"
6163 Macintosh: "$VIM:vimfiles,
6164 $VIMRUNTIME,
6165 $VIM:vimfiles:after"
6166 RISC-OS: "Choices:vimfiles,
6167 $VIMRUNTIME,
6168 Choices:vimfiles/after"
6169 VMS: "sys$login:vimfiles,
6170 $VIM/vimfiles,
6171 $VIMRUNTIME,
6172 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006173 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006175 This is a list of directories which will be searched for runtime
6176 files:
6177 filetype.vim filetypes by file name |new-filetype|
6178 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006179 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006180 colors/ color scheme files |:colorscheme|
6181 compiler/ compiler files |:compiler|
6182 doc/ documentation |write-local-help|
6183 ftplugin/ filetype plugins |write-filetype-plugin|
6184 indent/ indent scripts |indent-expression|
6185 keymap/ key mapping files |mbyte-keymap|
6186 lang/ menu translations |:menutrans|
6187 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006188 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006189 plugin/ plugin scripts |write-plugin|
6190 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006191 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 syntax/ syntax files |mysyntaxfile|
6193 tutor/ files for vimtutor |tutor|
6194
6195 And any other file searched for with the |:runtime| command.
6196
6197 The defaults for most systems are setup to search five locations:
6198 1. In your home directory, for your personal preferences.
6199 2. In a system-wide Vim directory, for preferences from the system
6200 administrator.
6201 3. In $VIMRUNTIME, for files distributed with Vim.
6202 *after-directory*
6203 4. In the "after" directory in the system-wide Vim directory. This is
6204 for the system administrator to overrule or add to the distributed
6205 defaults (rarely needed)
6206 5. In the "after" directory in your home directory. This is for
6207 personal preferences to overrule or add to the distributed defaults
6208 or system-wide settings (rarely needed).
6209
Bram Moolenaard0796902016-09-16 20:02:31 +02006210 More entries are added when using |packages|. If it gets very long
6211 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6212 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006213
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6215 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006216 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006217 wildcards.
6218 See |:runtime|.
6219 Example: >
6220 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6221< This will use the directory "~/vimruntime" first (containing your
6222 personal Vim runtime files), then "/mygroup/vim" (shared between a
6223 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6224 files).
6225 You probably should always include $VIMRUNTIME somewhere, to use the
6226 distributed runtime files. You can put a directory before $VIMRUNTIME
6227 to find files which replace a distributed runtime files. You can put
6228 a directory after $VIMRUNTIME to find files which add to distributed
6229 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006230 When Vim is started with |--clean| the home directory entries are not
6231 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 This option cannot be set from a |modeline| or in the |sandbox|, for
6233 security reasons.
6234
6235 *'scroll'* *'scr'*
6236'scroll' 'scr' number (default: half the window height)
6237 local to window
6238 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6239 set to half the number of lines in the window when the window size
6240 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006241 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006242 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006243
6244 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6245'scrollbind' 'scb' boolean (default off)
6246 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006247 See also |scroll-binding|. When this option is set, the current
6248 window scrolls as other scrollbind windows (windows that also have
6249 this option set) scroll. This option is useful for viewing the
6250 differences between two versions of a file, see 'diff'.
6251 See |'scrollopt'| for options that determine how this option should be
6252 interpreted.
6253 This option is mostly reset when splitting a window to edit another
6254 file. This means that ":split | edit file" results in two windows
6255 with scroll-binding, but ":split file" does not.
6256
6257 *'scrolljump'* *'sj'*
6258'scrolljump' 'sj' number (default 1)
6259 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006260 Minimal number of lines to scroll when the cursor gets off the
6261 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6262 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006263 When set to a negative number from -1 to -100 this is used as the
6264 percentage of the window height. Thus -50 scrolls half the window
6265 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006266 NOTE: This option is set to 1 when 'compatible' is set.
6267
6268 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006269'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006270 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006271 Minimal number of screen lines to keep above and below the cursor.
6272 This will make some context visible around where you are working. If
6273 you set it to a very large value (999) the cursor line will always be
6274 in the middle of the window (except at the start or end of the file or
6275 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006276 After using the local value, go back the global value with one of
6277 these two: >
6278 setlocal scrolloff<
6279 setlocal scrolloff=-1
6280< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006281 NOTE: This option is set to 0 when 'compatible' is set.
6282
6283 *'scrollopt'* *'sbo'*
6284'scrollopt' 'sbo' string (default "ver,jump")
6285 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006286 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006287 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6288 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006289 The following words are available:
6290 ver Bind vertical scrolling for 'scrollbind' windows
6291 hor Bind horizontal scrolling for 'scrollbind' windows
6292 jump Applies to the offset between two windows for vertical
6293 scrolling. This offset is the difference in the first
6294 displayed line of the bound windows. When moving
6295 around in a window, another 'scrollbind' window may
6296 reach a position before the start or after the end of
6297 the buffer. The offset is not changed though, when
6298 moving back the 'scrollbind' window will try to scroll
6299 to the desired position when possible.
6300 When now making that window the current one, two
6301 things can be done with the relative offset:
6302 1. When "jump" is not included, the relative offset is
6303 adjusted for the scroll position in the new current
6304 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006305 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 2. When "jump" is included, the other windows are
6307 scrolled to keep the same relative offset. When
6308 going back to the other window, it still uses the
6309 same relative offset.
6310 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006311 When 'diff' mode is active there always is vertical scroll binding,
6312 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006313
6314 *'sections'* *'sect'*
6315'sections' 'sect' string (default "SHNHH HUnhsh")
6316 global
6317 Specifies the nroff macros that separate sections. These are pairs of
6318 two letters (See |object-motions|). The default makes a section start
6319 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6320
6321 *'secure'* *'nosecure'* *E523*
6322'secure' boolean (default off)
6323 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006324 When on, ":autocmd", shell and write commands are not allowed in
6325 ".vimrc" and ".exrc" in the current directory and map commands are
6326 displayed. Switch it off only if you know that you will not run into
6327 problems, or when the 'exrc' option is off. On Unix this option is
6328 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006329 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 'secure' at the end of your ~/.vimrc then.
6331 This option cannot be set from a |modeline| or in the |sandbox|, for
6332 security reasons.
6333
6334 *'selection'* *'sel'*
6335'selection' 'sel' string (default "inclusive")
6336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006337 This option defines the behavior of the selection. It is only used
6338 in Visual and Select mode.
6339 Possible values:
6340 value past line inclusive ~
6341 old no yes
6342 inclusive yes yes
6343 exclusive yes no
6344 "past line" means that the cursor is allowed to be positioned one
6345 character past the line.
6346 "inclusive" means that the last character of the selection is included
6347 in an operation. For example, when "x" is used to delete the
6348 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006349 When "old" is used and 'virtualedit' allows the cursor to move past
6350 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006351 Note that when "exclusive" is used and selecting from the end
6352 backwards, you cannot include the last character of a line, when
6353 starting in Normal mode and 'virtualedit' empty.
6354
6355 The 'selection' option is set by the |:behave| command.
6356
6357 *'selectmode'* *'slm'*
6358'selectmode' 'slm' string (default "")
6359 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006360 This is a comma separated list of words, which specifies when to start
6361 Select mode instead of Visual mode, when a selection is started.
6362 Possible values:
6363 mouse when using the mouse
6364 key when using shifted special keys
6365 cmd when using "v", "V" or CTRL-V
6366 See |Select-mode|.
6367 The 'selectmode' option is set by the |:behave| command.
6368
6369 *'sessionoptions'* *'ssop'*
6370'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006371 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006373 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006374 feature}
6375 Changes the effect of the |:mksession| command. It is a comma
6376 separated list of words. Each word enables saving and restoring
6377 something:
6378 word save and restore ~
6379 blank empty windows
6380 buffers hidden and unloaded buffers, not just those in windows
6381 curdir the current directory
6382 folds manually created folds, opened/closed folds and local
6383 fold options
6384 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006385 and contain at least one lowercase letter. Only
6386 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006387 help the help window
6388 localoptions options and mappings local to a window or buffer (not
6389 global values for local options)
6390 options all options and mappings (also global values for local
6391 options)
6392 resize size of the Vim window: 'lines' and 'columns'
6393 sesdir the directory in which the session file is located
6394 will become the current directory (useful with
6395 projects accessed over a network from different
6396 systems)
6397 slash backslashes in file names replaced with forward
6398 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006399 tabpages all tab pages; without this only the current tab page
6400 is restored, so that you can make a session for each
6401 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006402 terminal include terminal windows where the command can be
6403 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006404 unix with Unix end-of-line format (single <NL>), even when
6405 on Windows or DOS
6406 winpos position of the whole Vim window
6407 winsize window sizes
6408
6409 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006410 When neither "curdir" nor "sesdir" is included, file names are stored
6411 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006412 "slash" and "unix" are useful on Windows when sharing session files
6413 with Unix. The Unix version of Vim cannot source dos format scripts,
6414 but the Windows version of Vim can source unix format scripts.
6415
6416 *'shell'* *'sh'* *E91*
6417'shell' 'sh' string (default $SHELL or "sh",
6418 MS-DOS and Win32: "command.com" or
6419 "cmd.exe", OS/2: "cmd")
6420 global
6421 Name of the shell to use for ! and :! commands. When changing the
6422 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6423 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006424 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006425 See |option-backslash| about including spaces and backslashes.
6426 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006427
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006429 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006430 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6431< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006432 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006433 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006434 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006435 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006436 Example with escaped space (Vim will do this when initializing the
6437 option from $SHELL): >
6438 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006439< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006440 backslashes are consumed by `:set`.
6441
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 Under MS-Windows, when the executable ends in ".com" it must be
6443 included. Thus setting the shell to "command.com" or "4dos.com"
6444 works, but "command" and "4dos" do not work for all commands (e.g.,
6445 filtering).
6446 For unknown reasons, when using "4dos.com" the current directory is
6447 changed to "C:\". To avoid this set 'shell' like this: >
6448 :set shell=command.com\ /c\ 4dos
6449< This option cannot be set from a |modeline| or in the |sandbox|, for
6450 security reasons.
6451
6452 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006453'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006454 MS-DOS and Win32, when 'shell' does not
6455 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006456 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006457 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6458 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6459 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006460 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006461 On Unix it can have more than one flag. Each white space separated
6462 part is passed as an argument to the shell command.
6463 See |option-backslash| about including spaces and backslashes.
6464 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006465 This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'shellpipe'* *'sp'*
6469'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6470 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006471 {not available when compiled without the |+quickfix|
6472 feature}
6473 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006474 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006475 including spaces and backslashes.
6476 The name of the temporary file can be represented by "%s" if necessary
6477 (the file name is appended automatically if no %s appears in the value
6478 of this option).
6479 For the Amiga and MS-DOS the default is ">". The output is directly
6480 saved in a file and not echoed to the screen.
6481 For Unix the default it "| tee". The stdout of the compiler is saved
6482 in a file and echoed to the screen. If the 'shell' option is "csh" or
6483 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006484 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6485 default becomes "2>&1| tee". This means that stderr is also included.
6486 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6487 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006488 The initialization of this option is done after reading the ".vimrc"
6489 and the other initializations, so that when the 'shell' option is set
6490 there, the 'shellpipe' option changes automatically, unless it was
6491 explicitly set before.
6492 When 'shellpipe' is set to an empty string, no redirection of the
6493 ":make" output will be done. This is useful if you use a 'makeprg'
6494 that writes to 'makeef' by itself. If you want no piping, but do
6495 want to include the 'makeef', set 'shellpipe' to a single space.
6496 Don't forget to precede the space with a backslash: ":set sp=\ ".
6497 In the future pipes may be used for filtering and this option will
6498 become obsolete (at least for Unix).
6499 This option cannot be set from a |modeline| or in the |sandbox|, for
6500 security reasons.
6501
6502 *'shellquote'* *'shq'*
6503'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6504 contains "sh" somewhere: "\"")
6505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 Quoting character(s), put around the command passed to the shell, for
6507 the "!" and ":!" commands. The redirection is kept outside of the
6508 quoting. See 'shellxquote' to include the redirection. It's
6509 probably not useful to set both options.
6510 This is an empty string by default. Only known to be useful for
6511 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6512 or bash, where it should be "\"". The default is adjusted according
6513 the value of 'shell', to reduce the need to set this option by the
6514 user. See |dos-shell|.
6515 This option cannot be set from a |modeline| or in the |sandbox|, for
6516 security reasons.
6517
6518 *'shellredir'* *'srr'*
6519'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006521 String to be used to put the output of a filter command in a temporary
6522 file. See also |:!|. See |option-backslash| about including spaces
6523 and backslashes.
6524 The name of the temporary file can be represented by "%s" if necessary
6525 (the file name is appended automatically if no %s appears in the value
6526 of this option).
6527 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6528 or "zsh" during initializations, the default becomes ">&". If the
6529 'shell' option is "sh", "ksh" or "bash" the default becomes
6530 ">%s 2>&1". This means that stderr is also included.
6531 For Win32, the Unix checks are done and additionally "cmd" is checked
6532 for, which makes the default ">%s 2>&1". Also, the same names with
6533 ".exe" appended are checked for.
6534 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 'shellredir' option changes automatically unless it was
6537 explicitly set before.
6538 In the future pipes may be used for filtering and this option will
6539 become obsolete (at least for Unix).
6540 This option cannot be set from a |modeline| or in the |sandbox|, for
6541 security reasons.
6542
6543 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6544'shellslash' 'ssl' boolean (default off)
6545 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006546 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006547 When set, a forward slash is used when expanding file names. This is
6548 useful when a Unix-like shell is used instead of command.com or
6549 cmd.exe. Backward slashes can still be typed, but they are changed to
6550 forward slashes by Vim.
6551 Note that setting or resetting this option has no effect for some
6552 existing file names, thus this option needs to be set before opening
6553 any file for best results. This might change in the future.
6554 'shellslash' only works when a backslash can be used as a path
6555 separator. To test if this is so use: >
6556 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006557< Also see 'completeslash'.
6558
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006559 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6560'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6561 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006562 When on, use temp files for shell commands. When off use a pipe.
6563 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006564 Currently a pipe is only supported on Unix and MS-Windows 2K and
6565 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006566 :if has("filterpipe")
6567< The advantage of using a pipe is that nobody can read the temp file
6568 and the 'shell' command does not need to support redirection.
6569 The advantage of using a temp file is that the file type and encoding
6570 can be detected.
6571 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6572 |FilterWritePost| autocommands event are not triggered when
6573 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006574 The `system()` function does not respect this option and always uses
6575 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006576 NOTE: This option is set to the Vim default value when 'compatible'
6577 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006578
Bram Moolenaar071d4272004-06-13 20:20:40 +00006579 *'shelltype'* *'st'*
6580'shelltype' 'st' number (default 0)
6581 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006582 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 On the Amiga this option influences the way how the commands work
6584 which use a shell.
6585 0 and 1: always use the shell
6586 2 and 3: use the shell only to filter lines
6587 4 and 5: use shell only for ':sh' command
6588 When not using the shell, the command is executed directly.
6589
6590 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6591 1 and 3: use "shell cmd" to start external commands
6592
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006593 *'shellxescape'* *'sxe'*
6594'shellxescape' 'sxe' string (default: "";
6595 for MS-DOS and MS-Windows: "\"&|<>()@^")
6596 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006597 When 'shellxquote' is set to "(" then the characters listed in this
6598 option will be escaped with a '^' character. This makes it possible
6599 to execute most external commands with cmd.exe.
6600
Bram Moolenaar071d4272004-06-13 20:20:40 +00006601 *'shellxquote'* *'sxq'*
6602'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006603 for Win32, when 'shell' is cmd.exe: "("
6604 for Win32, when 'shell' contains "sh"
6605 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006606 for Unix, when using system(): "\"")
6607 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006608 Quoting character(s), put around the command passed to the shell, for
6609 the "!" and ":!" commands. Includes the redirection. See
6610 'shellquote' to exclude the redirection. It's probably not useful
6611 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006612 When the value is '(' then ')' is appended. When the value is '"('
6613 then ')"' is appended.
6614 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006615 This is an empty string by default on most systems, but is known to be
6616 useful for on Win32 version, either for cmd.exe which automatically
6617 strips off the first and last quote on a command, or 3rd-party shells
6618 such as the MKS Korn Shell or bash, where it should be "\"". The
6619 default is adjusted according the value of 'shell', to reduce the need
6620 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006621 This option cannot be set from a |modeline| or in the |sandbox|, for
6622 security reasons.
6623
6624 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6625'shiftround' 'sr' boolean (default off)
6626 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006627 Round indent to multiple of 'shiftwidth'. Applies to > and <
6628 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6629 a multiple of 'shiftwidth' (this is Vi compatible).
6630 NOTE: This option is reset when 'compatible' is set.
6631
6632 *'shiftwidth'* *'sw'*
6633'shiftwidth' 'sw' number (default 8)
6634 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006635 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006636 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006637 When zero the 'ts' value will be used. Use the |shiftwidth()|
6638 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639
6640 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006641'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6642 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006644 This option helps to avoid all the |hit-enter| prompts caused by file
6645 messages, for example with CTRL-G, and to avoid some other messages.
6646 It is a list of flags:
6647 flag meaning when present ~
6648 f use "(3 of 5)" instead of "(file 3 of 5)"
6649 i use "[noeol]" instead of "[Incomplete last line]"
6650 l use "999L, 888C" instead of "999 lines, 888 characters"
6651 m use "[+]" instead of "[Modified]"
6652 n use "[New]" instead of "[New File]"
6653 r use "[RO]" instead of "[readonly]"
6654 w use "[w]" instead of "written" for file write message
6655 and "[a]" instead of "appended" for ':w >> file' command
6656 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6657 "[unix format]" and "[mac]" instead of "[mac format]".
6658 a all of the above abbreviations
6659
6660 o overwrite message for writing a file with subsequent message
6661 for reading a file (useful for ":wn" or when 'autowrite' on)
6662 O message for reading a file overwrites any previous message.
6663 Also for quickfix message (e.g., ":cn").
6664 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006665 hit TOP, continuing at BOTTOM" messages; when using the search
6666 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006667 t truncate file message at the start if it is too long to fit
6668 on the command-line, "<" will appear in the left most column.
6669 Ignored in Ex mode.
6670 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006671 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006672 Ignored in Ex mode.
6673 W don't give "written" or "[w]" when writing a file
6674 A don't give the "ATTENTION" message when an existing swap file
6675 is found.
6676 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006677 c don't give |ins-completion-menu| messages. For example,
6678 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6679 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006680 q use "recording" instead of "recording @a"
6681 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006682 was used for the command; note that this also affects messages
6683 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006684 S do not show search count message when searching, e.g.
6685 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006686
6687 This gives you the opportunity to avoid that a change between buffers
6688 requires you to hit <Enter>, but still gives as useful a message as
6689 possible for the space available. To get the whole message that you
6690 would have got with 'shm' empty, use ":file!"
6691 Useful values:
6692 shm= No abbreviation of message.
6693 shm=a Abbreviation, but no loss of information.
6694 shm=at Abbreviation, and truncate message when necessary.
6695
6696 NOTE: This option is set to the Vi default value when 'compatible' is
6697 set and to the Vim default value when 'compatible' is reset.
6698
6699 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6700'shortname' 'sn' boolean (default off)
6701 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702 Filenames are assumed to be 8 characters plus one extension of 3
6703 characters. Multiple dots in file names are not allowed. When this
6704 option is on, dots in file names are replaced with underscores when
6705 adding an extension (".~" or ".swp"). This option is not available
6706 for MS-DOS, because then it would always be on. This option is useful
6707 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6708 or crossdos. When running the Win32 GUI version under Win32s, this
6709 option is always on by default.
6710
6711 *'showbreak'* *'sbr'* *E595*
6712'showbreak' 'sbr' string (default "")
6713 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006714 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006715 feature}
6716 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006717 values are "> " or "+++ ": >
6718 :set showbreak=>\
6719< Note the backslash to escape the trailing space. It's easier like
6720 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006721 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006722< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006723 comma (in a future version the comma might be used to separate the
6724 part that is shown at the end and at the start of a line).
6725 The characters are highlighted according to the '@' flag in
6726 'highlight'.
6727 Note that tabs after the showbreak will be displayed differently.
6728 If you want the 'showbreak' to appear in between line numbers, add the
6729 "n" flag to 'cpoptions'.
6730
6731 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006732'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6733 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 {not available when compiled without the
6736 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006737 Show (partial) command in the last line of the screen. Set this
6738 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 In Visual mode the size of the selected area is shown:
6740 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006741 If the number of bytes is different it is also displayed: "2-6"
6742 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006743 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006744 - When selecting a block, the size in screen characters:
6745 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 NOTE: This option is set to the Vi default value when 'compatible' is
6747 set and to the Vim default value when 'compatible' is reset.
6748
6749 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6750'showfulltag' 'sft' boolean (default off)
6751 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006752 When completing a word in insert mode (see |ins-completion|) from the
6753 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006754 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 matched a C function, you can see a template for what arguments are
6756 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006757 Note that this doesn't work well together with having "longest" in
6758 'completeopt', because the completion from the search pattern may not
6759 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006760
6761 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6762'showmatch' 'sm' boolean (default off)
6763 global
6764 When a bracket is inserted, briefly jump to the matching one. The
6765 jump is only done if the match can be seen on the screen. The time to
6766 show the match can be set with 'matchtime'.
6767 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006768 seen or not).
6769 This option is reset when 'paste' is set and restored when 'paste' is
6770 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 When the 'm' flag is not included in 'cpoptions', typing a character
6772 will immediately move the cursor back to where it belongs.
6773 See the "sm" field in 'guicursor' for setting the cursor shape and
6774 blinking when showing the match.
6775 The 'matchpairs' option can be used to specify the characters to show
6776 matches for. 'rightleft' and 'revins' are used to look for opposite
6777 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006778 Also see the matchparen plugin for highlighting the match when moving
6779 around |pi_paren.txt|.
6780 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006781
6782 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6783'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6784 global
6785 If in Insert, Replace or Visual mode put a message on the last line.
6786 Use the 'M' flag in 'highlight' to set the type of highlighting for
6787 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006788 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006789 doesn't mean XIM is really active, especially when 'imactivatekey' is
6790 not set.
6791 NOTE: This option is set to the Vi default value when 'compatible' is
6792 set and to the Vim default value when 'compatible' is reset.
6793
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006794 *'showtabline'* *'stal'*
6795'showtabline' 'stal' number (default 1)
6796 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006797 The value of this option specifies when the line with tab page labels
6798 will be displayed:
6799 0: never
6800 1: only if there are at least two tab pages
6801 2: always
6802 This is both for the GUI and non-GUI implementation of the tab pages
6803 line.
6804 See |tab-page| for more information about tab pages.
6805
Bram Moolenaar071d4272004-06-13 20:20:40 +00006806 *'sidescroll'* *'ss'*
6807'sidescroll' 'ss' number (default 0)
6808 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006809 The minimal number of columns to scroll horizontally. Used only when
6810 the 'wrap' option is off and the cursor is moved off of the screen.
6811 When it is zero the cursor will be put in the middle of the screen.
6812 When using a slow terminal set it to a large number or 0. When using
6813 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6814 commands.
6815
6816 *'sidescrolloff'* *'siso'*
6817'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006818 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006819 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006820 right of the cursor if 'nowrap' is set. Setting this option to a
6821 value greater than 0 while having |'sidescroll'| also at a non-zero
6822 value makes some context visible in the line you are scrolling in
6823 horizontally (except at beginning of the line). Setting this option
6824 to a large value (like 999) has the effect of keeping the cursor
6825 horizontally centered in the window, as long as one does not come too
6826 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006827 After using the local value, go back the global value with one of
6828 these two: >
6829 setlocal sidescrolloff<
6830 setlocal sidescrolloff=-1
6831< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006832
6833 Example: Try this together with 'sidescroll' and 'listchars' as
6834 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006835 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006836
6837 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6838 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006839<
6840 *'signcolumn'* *'scl'*
6841'signcolumn' 'scl' string (default "auto")
6842 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006843 {not available when compiled without the |+signs|
6844 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006845 Whether or not to draw the signcolumn. Valid values are:
6846 "auto" only when there is a sign to display
6847 "no" never
6848 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006849 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006850 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006851
6852
6853 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6854'smartcase' 'scs' boolean (default off)
6855 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006856 Override the 'ignorecase' option if the search pattern contains upper
6857 case characters. Only used when the search pattern is typed and
6858 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006859 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006860 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6861 recalling the search pattern from history and hitting <Enter>.
6862 NOTE: This option is reset when 'compatible' is set.
6863
6864 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6865'smartindent' 'si' boolean (default off)
6866 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867 {not available when compiled without the
6868 |+smartindent| feature}
6869 Do smart autoindenting when starting a new line. Works for C-like
6870 programs, but can also be used for other languages. 'cindent' does
6871 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006872 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006873 setting 'si' has no effect. 'indentexpr' is a more advanced
6874 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006875 Normally 'autoindent' should also be on when using 'smartindent'.
6876 An indent is automatically inserted:
6877 - After a line ending in '{'.
6878 - After a line starting with a keyword from 'cinwords'.
6879 - Before a line starting with '}' (only with the "O" command).
6880 When typing '}' as the first character in a new line, that line is
6881 given the same indent as the matching '{'.
6882 When typing '#' as the first character in a new line, the indent for
6883 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006884 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006885 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6886 When using the ">>" command, lines starting with '#' are not shifted
6887 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006888 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006889 This option is reset when 'paste' is set and restored when 'paste' is
6890 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891
6892 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6893'smarttab' 'sta' boolean (default off)
6894 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006895 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006896 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6897 <BS> will delete a 'shiftwidth' worth of space at the start of the
6898 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006899 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006900 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6901 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006902 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006904 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006905 This option is reset when 'paste' is set and restored when 'paste' is
6906 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 NOTE: This option is reset when 'compatible' is set.
6908
6909 *'softtabstop'* *'sts'*
6910'softtabstop' 'sts' number (default 0)
6911 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 Number of spaces that a <Tab> counts for while performing editing
6913 operations, like inserting a <Tab> or using <BS>. It "feels" like
6914 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6915 used. This is useful to keep the 'ts' setting at its standard value
6916 of 8, while being able to edit like it is set to 'sts'. However,
6917 commands like "x" still work on the actual characters.
6918 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006919 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006920 'softtabstop' is set to 0 when the 'paste' option is set and restored
6921 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006922 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6923 spaces is minimized by using <Tab>s.
6924 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6925 set.
6926 NOTE: This option is set to 0 when 'compatible' is set.
6927
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006928 If Vim is compiled with the |+vartabs| feature then the value of
6929 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6930 anything other than an empty string.
6931
Bram Moolenaar217ad922005-03-20 22:37:15 +00006932 *'spell'* *'nospell'*
6933'spell' boolean (default off)
6934 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006935 {not available when compiled without the |+syntax|
6936 feature}
6937 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006938 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006939
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006940 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006941'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006942 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006943 {not available when compiled without the |+syntax|
6944 feature}
6945 Pattern to locate the end of a sentence. The following word will be
6946 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006947 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006948 When this check is not wanted make this option empty.
6949 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006950 Be careful with special characters, see |option-backslash| about
6951 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006952 To set this option automatically depending on the language, see
6953 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006954
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006955 *'spellfile'* *'spf'*
6956'spellfile' 'spf' string (default empty)
6957 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006958 {not available when compiled without the |+syntax|
6959 feature}
6960 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006961 commands. It must end in ".{encoding}.add". You need to include the
6962 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006963 *E765*
6964 It may also be a comma separated list of names. A count before the
6965 |zg| and |zw| commands can be used to access each. This allows using
6966 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006967 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006968 you: Using the first directory in 'runtimepath' that is writable. If
6969 there is no "spell" directory yet it will be created. For the file
6970 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006971 ignoring the region.
6972 The resulting ".spl" file will be used for spell checking, it does not
6973 have to appear in 'spelllang'.
6974 Normally one file is used for all regions, but you can add the region
6975 name if you want to. However, it will then only be used when
6976 'spellfile' is set to it, for entries in 'spelllang' only files
6977 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006978 This option cannot be set from a |modeline| or in the |sandbox|, for
6979 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006980
Bram Moolenaar217ad922005-03-20 22:37:15 +00006981 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006982'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006983 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006984 {not available when compiled without the |+syntax|
6985 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006986 A comma separated list of word list names. When the 'spell' option is
6987 on spellchecking will be done for these languages. Example: >
6988 set spelllang=en_us,nl,medical
6989< This means US English, Dutch and medical words are recognized. Words
6990 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02006991 The word list name must consist of alphanumeric characters, a dash or
6992 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00006993 recommended to separate the two letter language name from a
6994 specification. Thus "en-rare" is used for rare English words.
6995 A region name must come last and have the form "_xx", where "xx" is
6996 the two-letter, lower case region name. You can use more than one
6997 region by listing them: "en_us,en_ca" supports both US and Canadian
6998 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01006999 Britain. (Note: currently en_au and en_nz dictionaries are older than
7000 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007001 If the name "cjk" is included East Asian characters are excluded from
7002 spell checking. This is useful when editing text that also has Asian
7003 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007004 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007005 As a special case the name of a .spl file can be given as-is. The
7006 first "_xx" in the name is removed and used as the region name
7007 (_xx is an underscore, two letters and followed by a non-letter).
7008 This is mainly for testing purposes. You must make sure the correct
7009 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007010 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007011 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7012 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007013 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007014
Bram Moolenaar98692072006-02-04 00:57:42 +00007015 If the |spellfile.vim| plugin is active and you use a language name
7016 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7017 will ask you if you want to download the file.
7018
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007019 After this option has been set successfully, Vim will source the files
7020 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007021 up to the first character that is not an ASCII letter or number and
7022 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007023
7024
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007025 *'spellsuggest'* *'sps'*
7026'spellsuggest' 'sps' string (default "best")
7027 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007028 {not available when compiled without the |+syntax|
7029 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007030 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007031 the |spellsuggest()| function. This is a comma-separated list of
7032 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007033
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007034 best Internal method that works best for English. Finds
7035 changes like "fast" and uses a bit of sound-a-like
7036 scoring to improve the ordering.
7037
7038 double Internal method that uses two methods and mixes the
7039 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007040 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007041 word. That only works when the language specifies
7042 sound folding. Can be slow and doesn't always give
7043 better results.
7044
7045 fast Internal method that only checks for simple changes:
7046 character inserts/deletes/swaps. Works well for
7047 simple typing mistakes.
7048
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007049 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007050 Not used for |spellsuggest()|. The number of
7051 suggestions is never more than the value of 'lines'
7052 minus two.
7053
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007054 file:{filename} Read file {filename}, which must have two columns,
7055 separated by a slash. The first column contains the
7056 bad word, the second column the suggested good word.
7057 Example:
7058 theribal/terrible ~
7059 Use this for common mistakes that do not appear at the
7060 top of the suggestion list with the internal methods.
7061 Lines without a slash are ignored, use this for
7062 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007063 The word in the second column must be correct,
7064 otherwise it will not be used. Add the word to an
7065 ".add" file if it is currently flagged as a spelling
7066 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007067 The file is used for all languages.
7068
7069 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7070 trouble with spaces. |v:val| holds the badly spelled
7071 word. The expression must evaluate to a List of
7072 Lists, each with a suggestion and a score.
7073 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007074 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007075 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007076 internal methods use. A lower score is better.
7077 This may invoke |spellsuggest()| if you temporarily
7078 set 'spellsuggest' to exclude the "expr:" part.
7079 Errors are silently ignored, unless you set the
7080 'verbose' option to a non-zero value.
7081
7082 Only one of "best", "double" or "fast" may be used. The others may
7083 appear several times in any order. Example: >
7084 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7085<
7086 This option cannot be set from a |modeline| or in the |sandbox|, for
7087 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007088
7089
Bram Moolenaar071d4272004-06-13 20:20:40 +00007090 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7091'splitbelow' 'sb' boolean (default off)
7092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007093 When on, splitting a window will put the new window below the current
7094 one. |:split|
7095
7096 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7097'splitright' 'spr' boolean (default off)
7098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007099 When on, splitting a window will put the new window right of the
7100 current one. |:vsplit|
7101
7102 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7103'startofline' 'sol' boolean (default on)
7104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007106 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007107 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007108 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 with a linewise operator, with "%" with a count and to buffer changing
7110 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7111 only has a line number, e.g., ":25" or ":+".
7112 In case of buffer changing commands the cursor is placed at the column
7113 where it was the last time the buffer was edited.
7114 NOTE: This option is set when 'compatible' is set.
7115
Bram Moolenaar00654022011-02-25 14:42:19 +01007116 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007118 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007119 {not available when compiled without the |+statusline|
7120 feature}
7121 When nonempty, this option determines the content of the status line.
7122 Also see |status-line|.
7123
7124 The option consists of printf style '%' items interspersed with
7125 normal text. Each status line item is of the form:
7126 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007127 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007128 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129
Bram Moolenaar238a5642006-02-21 22:12:05 +00007130 When the option starts with "%!" then it is used as an expression,
7131 evaluated and the result is used as the option value. Example: >
7132 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007133< The *g:statusline_winid* variable will be set to the |window-ID| of the
7134 window that the status line belongs to.
7135 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007136 Note that the "%!" expression is evaluated in the context of the
7137 current window and buffer, while %{} items are evaluated in the
7138 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007139
7140 When there is error while evaluating the option then it will be made
7141 empty to avoid further errors. Otherwise screen updating would loop.
7142
Bram Moolenaar071d4272004-06-13 20:20:40 +00007143 Note that the only effect of 'ruler' when this option is set (and
7144 'laststatus' is 2) is controlling the output of |CTRL-G|.
7145
7146 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007147 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007148 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007149 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007150 minwid Minimum width of the item, padding as set by '-' & '0'.
7151 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007152 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007153 on the left for text items. Numeric items will be
7154 shifted down to maxwid-2 digits followed by '>'number
7155 where number is the amount of missing digits, much like
7156 an exponential notation.
7157 item A one letter code as described below.
7158
7159 Following is a description of the possible statusline items. The
7160 second character in "item" is the type:
7161 N for number
7162 S for string
7163 F for flags as described below
7164 - not applicable
7165
7166 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007167 f S Path to the file in the buffer, as typed or relative to current
7168 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 F S Full path to the file in the buffer.
7170 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007171 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007172 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007173 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007174 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007175 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007176 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007177 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007178 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007179 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007180 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007181 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007182 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7183 being used: "<keymap>"
7184 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007185 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 B N As above, in hexadecimal.
7187 o N Byte number in file of byte under cursor, first byte is 1.
7188 Mnemonic: Offset from start of file (with one added)
7189 {not available when compiled without |+byte_offset| feature}
7190 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007191 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 l N Line number.
7193 L N Number of lines in buffer.
7194 c N Column number.
7195 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007196 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007197 p N Percentage through file in lines as in |CTRL-G|.
7198 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007199 percentage described for 'ruler'. Always 3 in length, unless
7200 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007201 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007203 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007204 Note that there is no '%' before the closing '}'. The
7205 expression cannot contain a '}' character, call a function to
7206 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007207 ( - Start of item group. Can be used for setting the width and
7208 alignment of a section. Must be followed by %) somewhere.
7209 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007210 T N For 'tabline': start of tab page N label. Use %T after the last
7211 label. This information is used for mouse clicks.
7212 X N For 'tabline': start of close tab N label. Use %X after the
7213 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7214 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007215 < - Where to truncate line if too long. Default is at the start.
7216 No width fields allowed.
7217 = - Separation point between left and right aligned items.
7218 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007219 # - Set highlight group. The name must follow and then a # again.
7220 Thus use %#HLname# for highlight group HLname. The same
7221 highlighting is used, also for the statusline of non-current
7222 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007224 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007225 The difference between User{N} and StatusLine will be applied
7226 to StatusLineNC for the statusline of non-current windows.
7227 The number N must be between 1 and 9. See |hl-User1..9|
7228
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007229 When displaying a flag, Vim removes the leading comma, if any, when
7230 that flag comes right after plaintext. This will make a nice display
7231 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232
Bram Moolenaar582fd852005-03-28 20:58:01 +00007233 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 not set) and a minwid is not set for the group, the whole group will
7235 become empty. This will make a group like the following disappear
7236 completely from the statusline when none of the flags are set. >
7237 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007238< Beware that an expression is evaluated each and every time the status
7239 line is displayed.
7240 *g:actual_curbuf* *g:actual_curwin*
7241 The current buffer and current window will be set temporarily to that
7242 of the window (and buffer) whose statusline is currently being drawn.
7243 The expression will evaluate in this context. The variable
7244 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7245 buffer and "g:actual_curwin" to the |window-ID| of the real current
7246 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007247
Bram Moolenaar30b65812012-07-12 22:01:11 +02007248 The 'statusline' option will be evaluated in the |sandbox| if set from
7249 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007250 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007251
7252 It is not allowed to change text or jump to another window while
7253 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254
7255 If the statusline is not updated when you want it (e.g., after setting
7256 a variable that's used in an expression), you can force an update by
7257 setting an option without changing its value. Example: >
7258 :let &ro = &ro
7259
7260< A result of all digits is regarded a number for display purposes.
7261 Otherwise the result is taken as flag text and applied to the rules
7262 described above.
7263
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007264 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007265 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007266 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267
7268 Examples:
7269 Emulate standard status line with 'ruler' set >
7270 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7271< Similar, but add ASCII value of char under the cursor (like "ga") >
7272 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7273< Display byte count and byte value, modified flag in red. >
7274 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7275 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7276< Display a ,GZ flag if a compressed file is loaded >
7277 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7278< In the |:autocmd|'s: >
7279 :let b:gzflag = 1
7280< And: >
7281 :unlet b:gzflag
7282< And define this function: >
7283 :function VarExists(var, val)
7284 : if exists(a:var) | return a:val | else | return '' | endif
7285 :endfunction
7286<
7287 *'suffixes'* *'su'*
7288'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7289 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007290 Files with these suffixes get a lower priority when multiple files
7291 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007292 suffixes. Spaces after the comma are ignored. A dot is also seen as
7293 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007294 separator, precede it with a backslash (see |option-backslash| about
7295 including spaces and backslashes).
7296 See 'wildignore' for completely ignoring files.
7297 The use of |:set+=| and |:set-=| is preferred when adding or removing
7298 suffixes from the list. This avoids problems when a future version
7299 uses another default.
7300
7301 *'suffixesadd'* *'sua'*
7302'suffixesadd' 'sua' string (default "")
7303 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007304 {not available when compiled without the
7305 |+file_in_path| feature}
7306 Comma separated list of suffixes, which are used when searching for a
7307 file for the "gf", "[I", etc. commands. Example: >
7308 :set suffixesadd=.java
7309<
7310 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7311'swapfile' 'swf' boolean (default on)
7312 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007313 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007314 swapfile is not wanted for a specific buffer. For example, with
7315 confidential information that even root must not be able to access.
7316 Careful: All text will be in memory:
7317 - Don't use this for big files.
7318 - Recovery will be impossible!
7319 A swapfile will only be present when |'updatecount'| is non-zero and
7320 'swapfile' is set.
7321 When 'swapfile' is reset, the swap file for the current buffer is
7322 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7323 non-zero, a swap file is immediately created.
7324 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007325 If you want to open a new buffer without creating a swap file for it,
7326 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007327 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007328
7329 This option is used together with 'bufhidden' and 'buftype' to
7330 specify special kinds of buffers. See |special-buffers|.
7331
7332 *'swapsync'* *'sws'*
7333'swapsync' 'sws' string (default "fsync")
7334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007335 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007336 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007337 When this option is empty parts of the swap file may be in memory and
7338 not written to disk. When the system crashes you may lose more work.
7339 On Unix the system does a sync now and then without Vim asking for it,
7340 so the disadvantage of setting this option off is small. On some
7341 systems the swap file will not be written at all. For a unix system
7342 setting it to "sync" will use the sync() call instead of the default
7343 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007344 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007345
7346 *'switchbuf'* *'swb'*
7347'switchbuf' 'swb' string (default "")
7348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 This option controls the behavior when switching between buffers.
7350 Possible values (comma separated list):
7351 useopen If included, jump to the first open window that
7352 contains the specified buffer (if there is one).
7353 Otherwise: Do not examine other windows.
7354 This setting is checked with |quickfix| commands, when
7355 jumping to errors (":cc", ":cn", "cp", etc.). It is
7356 also used in all buffer related split commands, for
7357 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007358 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007359 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007360 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007361 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007362 Otherwise: do not split, use current window (when used
7363 in the quickfix window: the previously used window or
7364 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007365 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007366 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007367 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007368
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007369 *'synmaxcol'* *'smc'*
7370'synmaxcol' 'smc' number (default 3000)
7371 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007372 {not available when compiled without the |+syntax|
7373 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007374 Maximum column in which to search for syntax items. In long lines the
7375 text after this column is not highlighted and following lines may not
7376 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007377 This helps to avoid very slow redrawing for an XML file that is one
7378 long line.
7379 Set to zero to remove the limit.
7380
Bram Moolenaar071d4272004-06-13 20:20:40 +00007381 *'syntax'* *'syn'*
7382'syntax' 'syn' string (default empty)
7383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384 {not available when compiled without the |+syntax|
7385 feature}
7386 When this option is set, the syntax with this name is loaded, unless
7387 syntax highlighting has been switched off with ":syntax off".
7388 Otherwise this option does not always reflect the current syntax (the
7389 b:current_syntax variable does).
7390 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007391 not automatically recognized. Example, in an IDL file:
7392 /* vim: set syntax=idl : */ ~
7393 When a dot appears in the value then this separates two filetype
7394 names. Example:
7395 /* vim: set syntax=c.doxygen : */ ~
7396 This will use the "c" syntax first, then the "doxygen" syntax.
7397 Note that the second one must be prepared to be loaded as an addition,
7398 otherwise it will be skipped. More than one dot may appear.
7399 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 :set syntax=OFF
7401< To switch syntax highlighting on according to the current value of the
7402 'filetype' option: >
7403 :set syntax=ON
7404< What actually happens when setting the 'syntax' option is that the
7405 Syntax autocommand event is triggered with the value as argument.
7406 This option is not copied to another buffer, independent of the 's' or
7407 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007408 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007409
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007410 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007411'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007412 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007413 When nonempty, this option determines the content of the tab pages
7414 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007415 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007416
7417 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007418 option and only when there is no GUI tab line. When 'e' is in
7419 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007420 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007421
7422 The value is evaluated like with 'statusline'. You can use
7423 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007424 the text to be displayed. Use "%1T" for the first label, "%2T" for
7425 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007426
Bram Moolenaare12bab32019-01-08 22:02:56 +01007427 When changing something that is used in 'tabline' that does not
7428 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007429 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007430
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007431 Keep in mind that only one of the tab pages is the current one, others
7432 are invisible and you can't jump to their windows.
7433
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007434
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007435 *'tabpagemax'* *'tpm'*
7436'tabpagemax' 'tpm' number (default 10)
7437 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007438 Maximum number of tab pages to be opened by the |-p| command line
7439 argument or the ":tab all" command. |tabpage|
7440
7441
7442 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007443'tabstop' 'ts' number (default 8)
7444 local to buffer
7445 Number of spaces that a <Tab> in the file counts for. Also see
7446 |:retab| command, and 'softtabstop' option.
7447
7448 Note: Setting 'tabstop' to any other value than 8 can make your file
7449 appear wrong in many places (e.g., when printing it).
7450
7451 There are four main ways to use tabs in Vim:
7452 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7453 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007454 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455 behave like a tab appears every 4 (or 3) characters.
7456 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7457 'expandtab'. This way you will always insert spaces. The
7458 formatting will never be messed up when 'tabstop' is changed.
7459 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007460 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007461 works when using Vim to edit the file.
7462 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7463 'noexpandtab'. This should then work (for initial indents only)
7464 for any tabstop setting that people use. It might be nice to have
7465 tabs after the first non-blank inserted as spaces if you do this
7466 though. Otherwise aligned comments will be wrong when 'tabstop' is
7467 changed.
7468
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007469 If Vim is compiled with the |+vartabs| feature then the value of
7470 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7471 than an empty string.
7472
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7474'tagbsearch' 'tbs' boolean (default on)
7475 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007476 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007477 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007478 searching makes searching for a tag a LOT faster, but a linear search
7479 will find more tags if the tags file wasn't properly sorted.
7480 Vim normally assumes that your tags files are sorted, or indicate that
7481 they are not sorted. Only when this is not the case does the
7482 'tagbsearch' option need to be switched off.
7483
7484 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007485 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007486 certain files, or retry all files with a linear search. When
7487 'tagbsearch' is off, only a linear search is done.
7488
7489 Linear searching is done anyway, for one file, when Vim finds a line
7490 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007491 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492< [The whitespace before and after the '0' must be a single <Tab>]
7493
7494 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007495 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007496 instead of a normal tag name, a retry is done with a linear search.
7497 Tags in unsorted tags files, and matches with different case will only
7498 be found in the retry.
7499
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007500 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007501 linear search can be avoided when case is ignored. Use a value of '2'
7502 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7503 sorted with the -f switch to "sort" in most unices, as in the command:
7504 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7505 (at least 5.5) the --sort=foldcase switch can be used for this as
7506 well. Note that case must be folded to uppercase for this to work.
7507
7508 By default, tag searches are case-sensitive. Case is ignored when
7509 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7510 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007511 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7512 'tagcase' is "smart", and the pattern contains only lowercase
7513 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007514
7515 When 'tagbsearch' is off, tags searching is slower when a full match
7516 exists, but faster when no full match exists. Tags in unsorted tags
7517 files may only be found with 'tagbsearch' off.
7518 When the tags file is not sorted, or sorted in a wrong way (not on
7519 ASCII byte value), 'tagbsearch' should be off, or the line given above
7520 must be included in the tags file.
7521 This option doesn't affect commands that find all matching tags (e.g.,
7522 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007523
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007524 *'tagcase'* *'tc'*
7525'tagcase' 'tc' string (default "followic")
7526 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007527 This option specifies how case is handled when searching the tags
7528 file:
7529 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007530 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007531 ignore Ignore case
7532 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007533 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007534 NOTE: This option is set to the Vi default value when 'compatible' is
7535 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007536
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007537 *'tagfunc'* *'tfu'*
7538'tagfunc' 'tfu' string (default: empty)
7539 local to buffer
7540 {not available when compiled without the |+eval|
7541 feature}
7542 This option specifies a function to be used to perform tag searches.
7543 The function gets the tag pattern and should return a List of matching
7544 tags. See |tag-function| for an explanation of how to write the
7545 function and an example.
7546
Bram Moolenaar071d4272004-06-13 20:20:40 +00007547 *'taglength'* *'tl'*
7548'taglength' 'tl' number (default 0)
7549 global
7550 If non-zero, tags are significant up to this number of characters.
7551
7552 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7553'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7554 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007555 If on and using a tags file in another directory, file names in that
7556 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007557 NOTE: This option is set to the Vi default value when 'compatible' is
7558 set and to the Vim default value when 'compatible' is reset.
7559
7560 *'tags'* *'tag'* *E433*
7561'tags' 'tag' string (default "./tags,tags", when compiled with
7562 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7563 global or local to buffer |global-local|
7564 Filenames for the tag command, separated by spaces or commas. To
7565 include a space or comma in a file name, precede it with a backslash
7566 (see |option-backslash| about including spaces and backslashes).
7567 When a file name starts with "./", the '.' is replaced with the path
7568 of the current file. But only when the 'd' flag is not included in
7569 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7570 |tags-option|.
7571 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007572 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7573 find all files named "tags" below "/lib". The filename itself cannot
7574 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7575 files called "tags?". {not available when compiled without the
7576 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007577 The |tagfiles()| function can be used to get a list of the file names
7578 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007579 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7580 files are also supported. They are automatically recognized. The
7581 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7582 differences are ignored (MS-Windows). |emacs-tags|
7583 The use of |:set+=| and |:set-=| is preferred when adding or removing
7584 file names from the list. This avoids problems when a future version
7585 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007586
7587 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7588'tagstack' 'tgst' boolean (default on)
7589 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007590 When on, the |tagstack| is used normally. When off, a ":tag" or
7591 ":tselect" command with an argument will not push the tag onto the
7592 tagstack. A following ":tag" without an argument, a ":pop" command or
7593 any other command that uses the tagstack will use the unmodified
7594 tagstack, but does change the pointer to the active entry.
7595 Resetting this option is useful when using a ":tag" command in a
7596 mapping which should not change the tagstack.
7597
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007598 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007599'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007600 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007601 {only available when compiled with the |+tcl/dyn|
7602 feature}
7603 Specifies the name of the Tcl shared library. The default is
7604 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007605 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007606 This option cannot be set from a |modeline| or in the |sandbox|, for
7607 security reasons.
7608
Bram Moolenaar071d4272004-06-13 20:20:40 +00007609 *'term'* *E529* *E530* *E531*
7610'term' string (default is $TERM, if that fails:
7611 in the GUI: "builtin_gui"
7612 on Amiga: "amiga"
7613 on BeOS: "beos-ansi"
7614 on Mac: "mac-ansi"
7615 on MiNT: "vt52"
7616 on MS-DOS: "pcterm"
7617 on OS/2: "os2ansi"
7618 on Unix: "ansi"
7619 on VMS: "ansi"
7620 on Win 32: "win32")
7621 global
7622 Name of the terminal. Used for choosing the terminal control
7623 characters. Environment variables are expanded |:set_env|.
7624 For example: >
7625 :set term=$TERM
7626< See |termcap|.
7627
7628 *'termbidi'* *'tbidi'*
7629 *'notermbidi'* *'notbidi'*
7630'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007632 {only available when compiled with the |+arabic|
7633 feature}
7634 The terminal is in charge of Bi-directionality of text (as specified
7635 by Unicode). The terminal is also expected to do the required shaping
7636 that some languages (such as Arabic) require.
7637 Setting this option implies that 'rightleft' will not be set when
7638 'arabic' is set and the value of 'arabicshape' will be ignored.
7639 Note that setting 'termbidi' has the immediate effect that
7640 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7641 This option is reset when the GUI is started.
7642 For further details see |arabic.txt|.
7643
7644 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007645'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007646 Macintosh GUI: "macroman")
7647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 Encoding used for the terminal. This specifies what character
7649 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007650 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007651 display). Except for the Mac when 'macatsui' is off, then
7652 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007653 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007654 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007655 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7656 Any attempts to set a different value will be rejected, and an error
7657 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007658 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007659 because the Win32 system always passes Unicode characters.
7660 When empty, the same encoding is used as for the 'encoding' option.
7661 This is the normal value.
7662 Not all combinations for 'termencoding' and 'encoding' are valid. See
7663 |encoding-table|.
7664 The value for this option must be supported by internal conversions or
7665 iconv(). When this is not possible no conversion will be done and you
7666 will probably experience problems with non-ASCII characters.
7667 Example: You are working with the locale set to euc-jp (Japanese) and
7668 want to edit a UTF-8 file: >
7669 :let &termencoding = &encoding
7670 :set encoding=utf-8
7671< You need to do this when your system has no locale support for UTF-8.
7672
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007673 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007674'termguicolors' 'tgc' boolean (default off)
7675 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007676 {not available when compiled without the
7677 |+termguicolors| feature}
7678 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007679 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007680
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007681 Requires a ISO-8613-3 compatible terminal. If setting this option
7682 does not work (produces a colorless UI) reading |xterm-true-color|
7683 might help.
7684
7685 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7686 is required. Use this check to find out: >
7687 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007688< This requires Vim to be built with the |+vtp| feature.
7689
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007690 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007691 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007692
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007693 *'termwinkey'* *'twk'*
7694'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007695 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007696 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007697 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007698 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007699 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007700< The string must be one key stroke but can be multiple bytes.
7701 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007702 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007703 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007704
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007705 *'termwinscroll'* *'twsl'*
7706'termwinscroll' 'twsl' number (default 10000)
7707 local to buffer
7708 {not available when compiled without the
7709 |+terminal| feature}
7710 Number of scrollback lines to keep. When going over this limit the
7711 first 10% of the scrollback lines are deleted. This is just to reduce
7712 the memory usage. See |Terminal-Normal|.
7713
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007714 *'termwinsize'* *'tws'*
7715'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007716 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007717 Size of the |terminal| window. Format: {rows}x{columns} or
7718 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007719 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007720 - When set with a "x" (e.g., "24x80") the terminal size is not
7721 adjusted to the window size. If the window is smaller only the
7722 top-left part is displayed.
7723 - When set with a "*" (e.g., "10*50") the terminal size follows the
7724 window size, but will not be smaller than the specified rows and/or
7725 columns.
7726 - When rows is zero then use the height of the window.
7727 - When columns is zero then use the width of the window.
7728 - Using "0x0" or "0*0" is the same as empty.
7729
7730 Examples:
7731 "30x0" uses 30 rows and the current window width.
7732 "20*0" uses at least 20 rows and the current window width.
7733 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007734 Note that the command running in the terminal window may still change
7735 the size of the terminal. In that case the Vim window will be
7736 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007737
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007738 *'termwintype'* *'twt'*
7739'termwintype' 'twt' string (default "")
7740 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007741 {only available when compiled with the |terminal|
7742 feature on MS-Windows}
7743 Specify the virtual console (pty) used when opening the terminal
7744 window.
7745
7746 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007747 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007748 "winpty" use winpty, fail if not supported
7749 "conpty" use |ConPTY|, fail if not supported
7750
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007751 |ConPTY| support depends on the platform. Windows 10 October 2018
7752 Update is the first version that supports ConPTY, however it is still
7753 considered unstable. ConPTY might become stable in the next release
7754 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007755 supported then you cannot open a terminal window.
7756
Bram Moolenaar071d4272004-06-13 20:20:40 +00007757 *'terse'* *'noterse'*
7758'terse' boolean (default off)
7759 global
7760 When set: Add 's' flag to 'shortmess' option (this makes the message
7761 for a search that hits the start or end of the file not being
7762 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7763 shortens a lot of messages}
7764
7765 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7766'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007768 This option is obsolete. Use 'fileformats'.
7769 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7770 set to the default value for the current system. When 'textauto' is
7771 reset, 'fileformats' is made empty.
7772 NOTE: This option is set to the Vi default value when 'compatible' is
7773 set and to the Vim default value when 'compatible' is reset.
7774
7775 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7776'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7777 others: default off)
7778 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007779 This option is obsolete. Use 'fileformat'.
7780 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7781 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7782 "unix".
7783
7784 *'textwidth'* *'tw'*
7785'textwidth' 'tw' number (default 0)
7786 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007787 Maximum width of text that is being inserted. A longer line will be
7788 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007789 this.
7790 'textwidth' is set to 0 when the 'paste' option is set and restored
7791 when 'paste' is reset.
7792 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007793 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007794 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 NOTE: This option is set to 0 when 'compatible' is set.
7796
7797 *'thesaurus'* *'tsr'*
7798'thesaurus' 'tsr' string (default "")
7799 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007800 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007801 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7802
7803 Each line in the file should contain words with similar meaning,
7804 separated by non-keyword characters (white space is preferred).
7805 Maximum line length is 510 bytes.
7806
Bram Moolenaard47d5222018-12-09 20:43:55 +01007807 An English word list was added to this github issue:
7808 https://github.com/vim/vim/issues/629#issuecomment-443293282
7809 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7810 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7811 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007812
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007813 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007814 after a comma are ignored, otherwise spaces are included in the file
7815 name. See |option-backslash| about using backslashes.
7816 The use of |:set+=| and |:set-=| is preferred when adding or removing
7817 directories from the list. This avoids problems when a future version
7818 uses another default.
7819 Backticks cannot be used in this option for security reasons.
7820
7821 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7822'tildeop' 'top' boolean (default off)
7823 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007824 When on: The tilde command "~" behaves like an operator.
7825 NOTE: This option is reset when 'compatible' is set.
7826
7827 *'timeout'* *'to'* *'notimeout'* *'noto'*
7828'timeout' 'to' boolean (default on)
7829 global
7830 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007831'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007832 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 These two options together determine the behavior when part of a
7834 mapped key sequence or keyboard code has been received:
7835
7836 'timeout' 'ttimeout' action ~
7837 off off do not time out
7838 on on or off time out on :mappings and key codes
7839 off on time out on key codes
7840
7841 If both options are off, Vim will wait until either the complete
7842 mapping or key sequence has been received, or it is clear that there
7843 is no mapping or key sequence for the received characters. For
7844 example: if you have mapped "vl" and Vim has received 'v', the next
7845 character is needed to see if the 'v' is followed by an 'l'.
7846 When one of the options is on, Vim will wait for about 1 second for
7847 the next character to arrive. After that the already received
7848 characters are interpreted as single characters. The waiting time can
7849 be changed with the 'timeoutlen' option.
7850 On slow terminals or very busy systems timing out may cause
7851 malfunctioning cursor keys. If both options are off, Vim waits
7852 forever after an entered <Esc> if there are key codes that start
7853 with <Esc>. You will have to type <Esc> twice. If you do not have
7854 problems with key codes, but would like to have :mapped key
7855 sequences not timing out in 1 second, set the 'ttimeout' option and
7856 reset the 'timeout' option.
7857
7858 NOTE: 'ttimeout' is reset when 'compatible' is set.
7859
7860 *'timeoutlen'* *'tm'*
7861'timeoutlen' 'tm' number (default 1000)
7862 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007863
Bram Moolenaar071d4272004-06-13 20:20:40 +00007864 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007865'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007866 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007867 The time in milliseconds that is waited for a key code or mapped key
7868 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7869 when part of a command has been typed.
7870 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7871 different timeout value for key codes is desired set 'ttimeoutlen' to
7872 a non-negative number.
7873
7874 ttimeoutlen mapping delay key code delay ~
7875 < 0 'timeoutlen' 'timeoutlen'
7876 >= 0 'timeoutlen' 'ttimeoutlen'
7877
7878 The timeout only happens when the 'timeout' and 'ttimeout' options
7879 tell so. A useful setting would be >
7880 :set timeout timeoutlen=3000 ttimeoutlen=100
7881< (time out on mapping after three seconds, time out on key codes after
7882 a tenth of a second).
7883
7884 *'title'* *'notitle'*
7885'title' boolean (default off, on when title can be restored)
7886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 {not available when compiled without the |+title|
7888 feature}
7889 When on, the title of the window will be set to the value of
7890 'titlestring' (if it is not empty), or to:
7891 filename [+=-] (path) - VIM
7892 Where:
7893 filename the name of the file being edited
7894 - indicates the file cannot be modified, 'ma' off
7895 + indicates the file was modified
7896 = indicates the file is read-only
7897 =+ indicates the file is read-only and modified
7898 (path) is the path of the file being edited
7899 - VIM the server name |v:servername| or "VIM"
7900 Only works if the terminal supports setting window titles
7901 (currently Amiga console, Win32 console, all GUI versions and
7902 terminals with a non- empty 't_ts' option - these are Unix xterm and
7903 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7904 *X11*
7905 When Vim was compiled with HAVE_X11 defined, the original title will
7906 be restored if possible. The output of ":version" will include "+X11"
7907 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7908 works for the icon name |'icon'|.
7909 But: When Vim was started with the |-X| argument, restoring the title
7910 will not work (except in the GUI).
7911 If the title cannot be restored, it is set to the value of 'titleold'.
7912 You might want to restore the title outside of Vim then.
7913 When using an xterm from a remote machine you can use this command:
7914 rsh machine_name xterm -display $DISPLAY &
7915 then the WINDOWID environment variable should be inherited and the
7916 title of the window should change back to what it should be after
7917 exiting Vim.
7918
7919 *'titlelen'*
7920'titlelen' number (default 85)
7921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007922 {not available when compiled without the |+title|
7923 feature}
7924 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007925 title. When the title is longer, only the end of the path name is
7926 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007927 Using a percentage makes this adapt to the width of the window. But
7928 it won't work perfectly, because the actual number of characters
7929 available also depends on the font used and other things in the title
7930 bar. When 'titlelen' is zero the full path is used. Otherwise,
7931 values from 1 to 30000 percent can be used.
7932 'titlelen' is also used for the 'titlestring' option.
7933
7934 *'titleold'*
7935'titleold' string (default "Thanks for flying Vim")
7936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007937 {only available when compiled with the |+title|
7938 feature}
7939 This option will be used for the window title when exiting Vim if the
7940 original title cannot be restored. Only happens if 'title' is on or
7941 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007942 This option cannot be set from a |modeline| or in the |sandbox|, for
7943 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007944 *'titlestring'*
7945'titlestring' string (default "")
7946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007947 {not available when compiled without the |+title|
7948 feature}
7949 When this option is not empty, it will be used for the title of the
7950 window. This happens only when the 'title' option is on.
7951 Only works if the terminal supports setting window titles (currently
7952 Amiga console, Win32 console, all GUI versions and terminals with a
7953 non-empty 't_ts' option).
7954 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007955 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007956
Bram Moolenaar071d4272004-06-13 20:20:40 +00007957 When this option contains printf-style '%' items, they will be
7958 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007959 This option cannot be set in a modeline when 'modelineexpr' is off.
7960
Bram Moolenaar071d4272004-06-13 20:20:40 +00007961 Example: >
7962 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7963 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7964< The value of 'titlelen' is used to align items in the middle or right
7965 of the available space.
7966 Some people prefer to have the file name first: >
7967 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7968< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007969 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007970 separating space only when needed.
7971 NOTE: Use of special characters in 'titlestring' may cause the display
7972 to be garbled (e.g., when it contains a CR or NL character).
7973 {not available when compiled without the |+statusline| feature}
7974
7975 *'toolbar'* *'tb'*
7976'toolbar' 'tb' string (default "icons,tooltips")
7977 global
7978 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7979 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007980 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 possible values are:
7982 icons Toolbar buttons are shown with icons.
7983 text Toolbar buttons shown with text.
7984 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007985 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 tooltips Tooltips are active for toolbar buttons.
7987 Tooltips refer to the popup help text which appears after the mouse
7988 cursor is placed over a toolbar button for a brief moment.
7989
7990 If you want the toolbar to be shown with icons as well as text, do the
7991 following: >
7992 :set tb=icons,text
7993< Motif and Athena cannot display icons and text at the same time. They
7994 will show icons if both are requested.
7995
7996 If none of the strings specified in 'toolbar' are valid or if
7997 'toolbar' is empty, this option is ignored. If you want to disable
7998 the toolbar, you need to set the 'guioptions' option. For example: >
7999 :set guioptions-=T
8000< Also see |gui-toolbar|.
8001
8002 *'toolbariconsize'* *'tbis'*
8003'toolbariconsize' 'tbis' string (default "small")
8004 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008005 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008006 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008007 tiny Use tiny icons.
8008 small Use small icons (default).
8009 medium Use medium-sized icons.
8010 large Use large icons.
8011 huge Use even larger icons.
8012 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008013 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008014 the current theme. Common dimensions are giant=48x48, huge=32x32,
8015 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008016
8017 If 'toolbariconsize' is empty, the global default size as determined
8018 by user preferences or the current theme is used.
8019
8020 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8021'ttybuiltin' 'tbi' boolean (default on)
8022 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008023 When on, the builtin termcaps are searched before the external ones.
8024 When off the builtin termcaps are searched after the external ones.
8025 When this option is changed, you should set the 'term' option next for
8026 the change to take effect, for example: >
8027 :set notbi term=$TERM
8028< See also |termcap|.
8029 Rationale: The default for this option is "on", because the builtin
8030 termcap entries are generally better (many systems contain faulty
8031 xterm entries...).
8032
8033 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8034'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8035 sun-cmd, screen, rxvt, dtterm or
8036 iris-ansi; also on when running Vim in
8037 a DOS console)
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 Indicates a fast terminal connection. More characters will be sent to
8040 the screen for redrawing, instead of using insert/delete line
8041 commands. Improves smoothness of redrawing when there are multiple
8042 windows and the terminal does not support a scrolling region.
8043 Also enables the extra writing of characters at the end of each screen
8044 line for lines that wrap. This helps when using copy/paste with the
8045 mouse in an xterm and other terminals.
8046
8047 *'ttymouse'* *'ttym'*
8048'ttymouse' 'ttym' string (default depends on 'term')
8049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008050 {only in Unix and VMS, doesn't work in the GUI; not
8051 available when compiled without |+mouse|}
8052 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008053 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008054 *xterm-mouse*
8055 xterm xterm-like mouse handling. The mouse generates
8056 "<Esc>[Mscr", where "scr" is three bytes:
8057 "s" = button state
8058 "c" = column plus 33
8059 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008060 This only works up to 223 columns! See "dec",
8061 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 xterm2 Works like "xterm", but with the xterm reporting the
8063 mouse position while the mouse is dragged. This works
8064 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008065 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 work. See below for how Vim detects this
8067 automatically.
8068 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008069 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008071 for the row and column. No other mouse events are
8072 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008073 *dec-mouse*
8074 dec DEC terminal mouse handling. The mouse generates a
8075 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008076 This is also available for an Xterm, if it was
8077 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 *jsbterm-mouse*
8079 jsbterm JSB term mouse handling.
8080 *pterm-mouse*
8081 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008082 *urxvt-mouse*
8083 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008084 The mouse works only if the terminal supports this
8085 encoding style, but it does not have 223 columns limit
8086 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008087 *sgr-mouse*
8088 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008089 mouse reporting. The mouse works even in columns
8090 beyond 223. This option is backward compatible with
8091 "xterm2" because it can also decode "xterm2" style
8092 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093
8094 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008095 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8096 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008097 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8098 recognized, if enabled at compile time. DEC terminal mouse codes
8099 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008100 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8101 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008102 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008103 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8104 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8105 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008106 Additionally, if vim is compiled with the |+termresponse| feature and
8107 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008108 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008110 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8111 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8112 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008113 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8114 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008115 :set t_RV=
8116<
8117 *'ttyscroll'* *'tsl'*
8118'ttyscroll' 'tsl' number (default 999)
8119 global
8120 Maximum number of lines to scroll the screen. If there are more lines
8121 to scroll the window is redrawn. For terminals where scrolling is
8122 very slow and redrawing is not slow this can be set to a small number,
8123 e.g., 3, to speed up displaying.
8124
8125 *'ttytype'* *'tty'*
8126'ttytype' 'tty' string (default from $TERM)
8127 global
8128 Alias for 'term', see above.
8129
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008130 *'undodir'* *'udir'*
8131'undodir' 'udir' string (default ".")
8132 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008133 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008134 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008135 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008136 "." means using the directory of the file. The undo file name for
8137 "file.txt" is ".file.txt.un~".
8138 For other directories the file name is the full path of the edited
8139 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008140 When writing: The first directory that exists is used. "." always
8141 works, no directories after "." will be used for writing.
8142 When reading all entries are tried to find an undo file. The first
8143 undo file that exists is used. When it cannot be read an error is
8144 given, no further entry is used.
8145 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008146 This option cannot be set from a |modeline| or in the |sandbox|, for
8147 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008148
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008149 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008150'undofile' 'udf' boolean (default off)
8151 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008152 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008153 When on, Vim automatically saves undo history to an undo file when
8154 writing a buffer to a file, and restores undo history from the same
8155 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008156 The directory where the undo file is stored is specified by 'undodir'.
8157 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008158 The undo file is not read when 'undoreload' causes the buffer from
8159 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008160 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008161 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008162
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 *'undolevels'* *'ul'*
8164'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8165 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008166 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008167 Maximum number of changes that can be undone. Since undo information
8168 is kept in memory, higher numbers will cause more memory to be used
8169 (nevertheless, a single change can use an unlimited amount of memory).
8170 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8171 itself: >
8172 set ul=0
8173< But you can also get Vi compatibility by including the 'u' flag in
8174 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008175 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008176 Set to -1 for no undo at all. You might want to do this only for the
8177 current buffer: >
8178 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008180
8181 The local value is set to -123456 when the global value is to be used.
8182
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008183 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008184
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008185 *'undoreload'* *'ur'*
8186'undoreload' 'ur' number (default 10000)
8187 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008188 Save the whole buffer for undo when reloading it. This applies to the
8189 ":e!" command and reloading for when the buffer changed outside of
8190 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008191 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008192 of lines is smaller than the value of this option.
8193 Set this option to zero to disable undo for a reload.
8194
8195 When saving undo for a reload, any undo file is not read.
8196
8197 Note that this causes the whole buffer to be stored in memory. Set
8198 this option to a lower value if you run out of memory.
8199
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200 *'updatecount'* *'uc'*
8201'updatecount' 'uc' number (default: 200)
8202 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008203 After typing this many characters the swap file will be written to
8204 disk. When zero, no swap file will be created at all (see chapter on
8205 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8206 Vim with the "-n" option, see |startup|. When editing in readonly
8207 mode this option will be initialized to 10000.
8208 The swapfile can be disabled per buffer with |'swapfile'|.
8209 When 'updatecount' is set from zero to non-zero, swap files are
8210 created for all buffers that have 'swapfile' set. When 'updatecount'
8211 is set to zero, existing swap files are not deleted.
8212 Also see |'swapsync'|.
8213 This option has no meaning in buffers where |'buftype'| is "nofile"
8214 or "nowrite".
8215
8216 *'updatetime'* *'ut'*
8217'updatetime' 'ut' number (default 4000)
8218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 If this many milliseconds nothing is typed the swap file will be
8220 written to disk (see |crash-recovery|). Also used for the
8221 |CursorHold| autocommand event.
8222
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008223 *'varsofttabstop'* *'vsts'*
8224'varsofttabstop' 'vsts' string (default "")
8225 local to buffer
8226 {only available when compiled with the |+vartabs|
8227 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008228 A list of the number of spaces that a <Tab> counts for while editing,
8229 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8230 width <Tab>s are being inserted, while in fact a mixture of spaces
8231 and <Tab>s is used. Tab widths are separated with commas, with the
8232 final value applying to all subsequent tabs.
8233
8234 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008235 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008236 to use the following: >
8237 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008238< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8239 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008240
8241 Note that the value of |'softtabstop'| will be ignored while
8242 'varsofttabstop' is set.
8243
8244 *'vartabstop'* *'vts'*
8245'vartabstop' 'vts' string (default "")
8246 local to buffer
8247 {only available when compiled with the |+vartabs|
8248 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008249 A list of the number of spaces that a <Tab> in the file counts for,
8250 separated by commas. Each value corresponds to one tab, with the
8251 final value applying to all subsequent tabs. For example: >
8252 :set vartabstop=4,20,10,8
8253< This will make the first tab 4 spaces wide, the second 20 spaces,
8254 the third 10 spaces, and all following tabs 8 spaces.
8255
8256 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8257 is set.
8258
Bram Moolenaar071d4272004-06-13 20:20:40 +00008259 *'verbose'* *'vbs'*
8260'verbose' 'vbs' number (default 0)
8261 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008262 When bigger than zero, Vim will give messages about what it is doing.
8263 Currently, these messages are given:
8264 >= 1 When the viminfo file is read or written.
8265 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008266 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008267 >= 8 Files for which a group of autocommands is executed.
8268 >= 9 Every executed autocommand.
8269 >= 12 Every executed function.
8270 >= 13 When an exception is thrown, caught, finished, or discarded.
8271 >= 14 Anything pending in a ":finally" clause.
8272 >= 15 Every executed Ex command (truncated at 200 characters).
8273
8274 This option can also be set with the "-V" argument. See |-V|.
8275 This option is also set by the |:verbose| command.
8276
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008277 When the 'verbosefile' option is set then the verbose messages are not
8278 displayed.
8279
8280 *'verbosefile'* *'vfile'*
8281'verbosefile' 'vfile' string (default empty)
8282 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008283 When not empty all messages are written in a file with this name.
8284 When the file exists messages are appended.
8285 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008286 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008287 Setting 'verbosefile' to a new value is like making it empty first.
8288 The difference with |:redir| is that verbose messages are not
8289 displayed when 'verbosefile' is set.
8290
Bram Moolenaar071d4272004-06-13 20:20:40 +00008291 *'viewdir'* *'vdir'*
8292'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8293 "$VIM/vimfiles/view",
8294 for Unix: "~/.vim/view",
8295 for Macintosh: "$VIM:vimfiles:view"
8296 for VMS: "sys$login:vimfiles/view"
8297 for RiscOS: "Choices:vimfiles/view")
8298 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008299 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008300 feature}
8301 Name of the directory where to store files for |:mkview|.
8302 This option cannot be set from a |modeline| or in the |sandbox|, for
8303 security reasons.
8304
8305 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008306'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008308 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008309 feature}
8310 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008311 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 word save and restore ~
8313 cursor cursor position in file and in window
8314 folds manually created folds, opened/closed folds and local
8315 fold options
8316 options options and mappings local to a window or buffer (not
8317 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008318 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 slash backslashes in file names replaced with forward
8320 slashes
8321 unix with Unix end-of-line format (single <NL>), even when
8322 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008323 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324
8325 "slash" and "unix" are useful on Windows when sharing view files
8326 with Unix. The Unix version of Vim cannot source dos format scripts,
8327 but the Windows version of Vim can source unix format scripts.
8328
8329 *'viminfo'* *'vi'* *E526* *E527* *E528*
8330'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008331 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8332 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8333 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008334 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008335 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336 feature}
8337 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008338 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8339 "NONE".
8340 The string should be a comma separated list of parameters, each
8341 consisting of a single character identifying the particular parameter,
8342 followed by a number or string which specifies the value of that
8343 parameter. If a particular character is left out, then the default
8344 value is used for that parameter. The following is a list of the
8345 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008347 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 ! When included, save and restore global variables that start
8349 with an uppercase letter, and don't contain a lowercase
8350 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008351 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008352 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008353 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 " Maximum number of lines saved for each register. Old name of
8355 the '<' item, with the disadvantage that you need to put a
8356 backslash before the ", otherwise it will be recognized as the
8357 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008358 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008359 % When included, save and restore the buffer list. If Vim is
8360 started with a file name argument, the buffer list is not
8361 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008362 buffer list is restored from the viminfo file. Quickfix
8363 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8364 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008365 When followed by a number, the number specifies the maximum
8366 number of buffers that are stored. Without a number all
8367 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008368 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008369 ' Maximum number of previously edited files for which the marks
8370 are remembered. This parameter must always be included when
8371 'viminfo' is non-empty.
8372 Including this item also means that the |jumplist| and the
8373 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008374 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008376 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008377 patterns are also saved. When not included, the value of
8378 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008379 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008380 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008381 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008382 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008383 < Maximum number of lines saved for each register. If zero then
8384 registers are not saved. When not included, all lines are
8385 saved. '"' is the old name for this item.
8386 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008387 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008389 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008390 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 c When included, convert the text in the viminfo file from the
8392 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008393 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008394 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 f Whether file marks need to be stored. If zero, file marks ('0
8396 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008397 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008398 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008399 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 h Disable the effect of 'hlsearch' when loading the viminfo
8401 file. When not included, it depends on whether ":nohlsearch"
8402 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008405 the 'n'. Must be at the end of the option! If the
8406 'viminfofile' option is set, that file name overrides the one
8407 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008408 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008409 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 r Removable media. The argument is a string (up to the next
8411 ','). This parameter can be given several times. Each
8412 specifies the start of a path for which no marks will be
8413 stored. This is to avoid removable media. For MS-DOS you
8414 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8415 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8416 ignored. Maximum length of each 'r' argument is 50
8417 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008418 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008419 s Maximum size of an item in Kbyte. If zero then registers are
8420 not saved. Currently only applies to registers. The default
8421 "s10" will exclude registers with more than 10 Kbyte of text.
8422 Also see the '<' item above: line count limit.
8423
8424 Example: >
8425 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8426<
8427 '50 Marks will be remembered for the last 50 files you
8428 edited.
8429 <1000 Contents of registers (up to 1000 lines each) will be
8430 remembered.
8431 s100 Registers with more than 100 Kbyte text are skipped.
8432 :0 Command-line history will not be saved.
8433 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8434 no / Since '/' is not specified, the default will be used,
8435 that is, save all of the search history, and also the
8436 previous search and substitute patterns.
8437 no % The buffer list will not be saved nor read back.
8438 no h 'hlsearch' highlighting will be restored.
8439
8440 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8441 load the contents of the file, this is not done automatically.
8442
8443 This option cannot be set from a |modeline| or in the |sandbox|, for
8444 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008445 NOTE: This option is set to the Vim default value when 'compatible'
8446 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008447
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008448 *'viminfofile'* *'vif'*
8449'viminfofile' 'vif' string (default: "")
8450 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008451 {not available when compiled without the |+viminfo|
8452 feature}
8453 When non-empty, overrides the file name used for viminfo.
8454 When equal to "NONE" no viminfo file will be read or written.
8455 This option can be set with the |-i| command line flag. The |--clean|
8456 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008457 This option cannot be set from a |modeline| or in the |sandbox|, for
8458 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008459
Bram Moolenaar071d4272004-06-13 20:20:40 +00008460 *'virtualedit'* *'ve'*
8461'virtualedit' 've' string (default "")
8462 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463 {not available when compiled without the
8464 |+virtualedit| feature}
8465 A comma separated list of these words:
8466 block Allow virtual editing in Visual block mode.
8467 insert Allow virtual editing in Insert mode.
8468 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008469 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008470
Bram Moolenaar071d4272004-06-13 20:20:40 +00008471 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008472 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 of the line. Useful for selecting a rectangle in Visual mode and
8474 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008475 "onemore" is not the same, it will only allow moving the cursor just
8476 after the last character of the line. This makes some commands more
8477 consistent. Previously the cursor was always past the end of the line
8478 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008479 break some plugins or Vim scripts. For example because |l| can move
8480 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008481 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008482 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008483 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008484 It doesn't make sense to combine "all" with "onemore", but you will
8485 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008486 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487
8488 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8489'visualbell' 'vb' boolean (default off)
8490 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008491 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008492 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008493 use: >
8494 :set vb t_vb=
8495< If you want a short flash, you can use this on many terminals: >
8496 :set vb t_vb=[?5h$<100>[?5l
8497< Here $<100> specifies the time, you can use a smaller or bigger value
8498 to get a shorter or longer flash.
8499
8500 Note: Vim will limit the bell to once per half a second. This avoids
8501 having to wait for the flashing to finish when there are lots of
8502 bells, e.g. on key repeat. This also happens without 'visualbell'
8503 set.
8504
Bram Moolenaar071d4272004-06-13 20:20:40 +00008505 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8506 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8507 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008508
8509 Note: When the GUI starts, 't_vb' is reset to its default value. You
8510 might want to set it again in your |gvimrc|.
8511
Bram Moolenaar071d4272004-06-13 20:20:40 +00008512 Does not work on the Amiga, you always get a screen flash.
8513 Also see 'errorbells'.
8514
8515 *'warn'* *'nowarn'*
8516'warn' boolean (default on)
8517 global
8518 Give a warning message when a shell command is used while the buffer
8519 has been changed.
8520
8521 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8522'weirdinvert' 'wiv' boolean (default off)
8523 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008524 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 It is provided for backwards compatibility with version 4.x.
8526 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8527 vice versa. Has no effect when the GUI is running.
8528
8529 *'whichwrap'* *'ww'*
8530'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8531 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008532 Allow specified keys that move the cursor left/right to move to the
8533 previous/next line when the cursor is on the first/last character in
8534 the line. Concatenate characters to allow this for these keys:
8535 char key mode ~
8536 b <BS> Normal and Visual
8537 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008538 h "h" Normal and Visual (not recommended)
8539 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008540 < <Left> Normal and Visual
8541 > <Right> Normal and Visual
8542 ~ "~" Normal
8543 [ <Left> Insert and Replace
8544 ] <Right> Insert and Replace
8545 For example: >
8546 :set ww=<,>,[,]
8547< allows wrap only when cursor keys are used.
8548 When the movement keys are used in combination with a delete or change
8549 operator, the <EOL> also counts for a character. This makes "3h"
8550 different from "3dh" when the cursor crosses the end of a line. This
8551 is also true for "x" and "X", because they do the same as "dl" and
8552 "dh". If you use this, you may also want to use the mapping
8553 ":map <BS> X" to make backspace delete the character in front of the
8554 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008555 When 'l' is included and it is used after an operator at the end of a
8556 line then it will not move to the next line. This makes "dl", "cl",
8557 "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008558 NOTE: This option is set to the Vi default value when 'compatible' is
8559 set and to the Vim default value when 'compatible' is reset.
8560
8561 *'wildchar'* *'wc'*
8562'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008564 Character you have to type to start wildcard expansion in the
8565 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008566 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008567 The character is not recognized when used inside a macro. See
8568 'wildcharm' for that.
8569 Although 'wc' is a number option, you can set it to a special key: >
8570 :set wc=<Esc>
8571< NOTE: This option is set to the Vi default value when 'compatible' is
8572 set and to the Vim default value when 'compatible' is reset.
8573
8574 *'wildcharm'* *'wcm'*
8575'wildcharm' 'wcm' number (default: none (0))
8576 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008577 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008578 recognized when used inside a macro. You can find "spare" command-line
8579 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 you'll never actually type 'wildcharm', just use it in mappings that
8581 automatically invoke completion mode, e.g.: >
8582 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008583 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008584< Then after typing :ss you can use CTRL-P & CTRL-N.
8585
8586 *'wildignore'* *'wig'*
8587'wildignore' 'wig' string (default "")
8588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 {not available when compiled without the |+wildignore|
8590 feature}
8591 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008592 patterns is ignored when expanding |wildcards|, completing file or
8593 directory names, and influences the result of |expand()|, |glob()| and
8594 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008595 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8596 Also see 'suffixes'.
8597 Example: >
8598 :set wildignore=*.o,*.obj
8599< The use of |:set+=| and |:set-=| is preferred when adding or removing
8600 a pattern from the list. This avoids problems when a future version
8601 uses another default.
8602
Bram Moolenaar94950a92010-12-02 16:01:29 +01008603
Bram Moolenaar81af9252010-12-10 20:35:50 +01008604 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008605'wildignorecase' 'wic' boolean (default off)
8606 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008607 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008608 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008609 Does not apply when the shell is used to expand wildcards, which
8610 happens when there are special characters.
8611
8612
Bram Moolenaar071d4272004-06-13 20:20:40 +00008613 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008614'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008615 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008616 {not available if compiled without the |+wildmenu|
8617 feature}
8618 When 'wildmenu' is on, command-line completion operates in an enhanced
8619 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8620 the possible matches are shown just above the command line, with the
8621 first match highlighted (overwriting the status line, if there is
8622 one). Keys that show the previous/next match, such as <Tab> or
8623 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8624 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8625 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008626 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 If there are more matches than can fit in the line, a ">" is shown on
8628 the right and/or a "<" is shown on the left. The status line scrolls
8629 as needed.
8630 The "wildmenu" mode is abandoned when a key is hit that is not used
8631 for selecting a completion.
8632 While the "wildmenu" is active the following keys have special
8633 meanings:
8634
8635 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8636 <Down> - in filename/menu name completion: move into a
8637 subdirectory or submenu.
8638 <CR> - in menu completion, when the cursor is just after a
8639 dot: move into a submenu.
8640 <Up> - in filename/menu name completion: move up into
8641 parent directory or parent menu.
8642
8643 This makes the menus accessible from the console |console-menus|.
8644
8645 If you prefer the <Left> and <Right> keys to move the cursor instead
8646 of selecting a different match, use this: >
8647 :cnoremap <Left> <Space><BS><Left>
8648 :cnoremap <Right> <Space><BS><Right>
8649<
8650 The "WildMenu" highlighting is used for displaying the current match
8651 |hl-WildMenu|.
8652
8653 *'wildmode'* *'wim'*
8654'wildmode' 'wim' string (Vim default: "full")
8655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008656 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008657 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008658 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008659 first part specifies the behavior for the first use of 'wildchar',
8660 The second part for the second use, etc.
8661 These are the possible values for each part:
8662 "" Complete only the first match.
8663 "full" Complete the next full match. After the last match,
8664 the original string is used and then the first match
8665 again.
8666 "longest" Complete till longest common string. If this doesn't
8667 result in a longer string, use the next part.
8668 "longest:full" Like "longest", but also start 'wildmenu' if it is
8669 enabled.
8670 "list" When more than one match, list all matches.
8671 "list:full" When more than one match, list all matches and
8672 complete first match.
8673 "list:longest" When more than one match, list all matches and
8674 complete till longest common string.
8675 When there is only a single match, it is fully completed in all cases.
8676
8677 Examples: >
8678 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008679< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008680 :set wildmode=longest,full
8681< Complete longest common string, then each full match >
8682 :set wildmode=list:full
8683< List all matches and complete each full match >
8684 :set wildmode=list,full
8685< List all matches without completing, then each full match >
8686 :set wildmode=longest,list
8687< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008688 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008689
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008690 *'wildoptions'* *'wop'*
8691'wildoptions' 'wop' string (default "")
8692 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008693 {not available when compiled without the |+wildignore|
8694 feature}
8695 A list of words that change how command line completion is done.
8696 Currently only one word is allowed:
8697 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008698 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008699 is displayed per line. Often used tag kinds are:
8700 d #define
8701 f function
8702 Also see |cmdline-completion|.
8703
Bram Moolenaar071d4272004-06-13 20:20:40 +00008704 *'winaltkeys'* *'wak'*
8705'winaltkeys' 'wak' string (default "menu")
8706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008707 {only used in Win32, Motif, GTK and Photon GUI}
8708 Some GUI versions allow the access to menu entries by using the ALT
8709 key in combination with a character that appears underlined in the
8710 menu. This conflicts with the use of the ALT key for mappings and
8711 entering special characters. This option tells what to do:
8712 no Don't use ALT keys for menus. ALT key combinations can be
8713 mapped, but there is no automatic handling. This can then be
8714 done with the |:simalt| command.
8715 yes ALT key handling is done by the windowing system. ALT key
8716 combinations cannot be mapped.
8717 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008718 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 keys can be mapped.
8720 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8721 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008722 This option is not used for <F10>; on Win32 and with GTK <F10> will
8723 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008724
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008725 *'wincolor'* *'wcr'*
8726'wincolor' 'wcr' string (default empty)
8727 local to window
8728 Highlight group name to use for this window instead of the Normal
8729 color |hl-Normal|.
8730
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008731 *'window'* *'wi'*
8732'window' 'wi' number (default screen height - 1)
8733 global
8734 Window height. Do not confuse this with the height of the Vim window,
8735 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008736 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8737 value is smaller than 'lines' minus one. The screen will scroll
8738 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008739 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8740 in a much smarter way, taking care of wrapping lines.
8741 When resizing the Vim window, the value is smaller than 1 or more than
8742 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008743
Bram Moolenaar071d4272004-06-13 20:20:40 +00008744 *'winheight'* *'wh'* *E591*
8745'winheight' 'wh' number (default 1)
8746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008747 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008748 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008749 focus goes to a window that is smaller, its size is increased, at the
8750 cost of the height of other windows.
8751 Set 'winheight' to a small number for normal editing.
8752 Set it to 999 to make the current window fill most of the screen.
8753 Other windows will be only 'winminheight' high. This has the drawback
8754 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8755 to create only two windows, set the option after startup is done,
8756 using the |VimEnter| event: >
8757 au VimEnter * set winheight=999
8758< Minimum value is 1.
8759 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 height of the current window.
8761 'winheight' applies to the current window. Use 'winminheight' to set
8762 the minimal height for other windows.
8763
8764 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8765'winfixheight' 'wfh' boolean (default off)
8766 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008767 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008768 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8769 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008770 The height may be changed anyway when running out of room.
8771
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008772 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8773'winfixwidth' 'wfw' boolean (default off)
8774 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008775 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008776 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008777 The width may be changed anyway when running out of room.
8778
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 *'winminheight'* *'wmh'*
8780'winminheight' 'wmh' number (default 1)
8781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 The minimal height of a window, when it's not the current window.
8783 This is a hard minimum, windows will never become smaller.
8784 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8785 status bar) if necessary. They will return to at least one line when
8786 they become active (since the cursor has to have somewhere to go.)
8787 Use 'winheight' to set the minimal height of the current window.
8788 This option is only checked when making a window smaller. Don't use a
8789 large number, it will cause errors when opening more than a few
8790 windows. A value of 0 to 3 is reasonable.
8791
8792 *'winminwidth'* *'wmw'*
8793'winminwidth' 'wmw' number (default 1)
8794 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 The minimal width of a window, when it's not the current window.
8796 This is a hard minimum, windows will never become smaller.
8797 When set to zero, windows may be "squashed" to zero columns (i.e. just
8798 a vertical separator) if necessary. They will return to at least one
8799 line when they become active (since the cursor has to have somewhere
8800 to go.)
8801 Use 'winwidth' to set the minimal width of the current window.
8802 This option is only checked when making a window smaller. Don't use a
8803 large number, it will cause errors when opening more than a few
8804 windows. A value of 0 to 12 is reasonable.
8805
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008806 *'winptydll'*
8807'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8808 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008809 {only available when compiled with the |terminal|
8810 feature on MS-Windows}
8811 Specifies the name of the winpty shared library, used for the
8812 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008813 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008814 a fallback.
8815 Environment variables are expanded |:set_env|.
8816 This option cannot be set from a |modeline| or in the |sandbox|, for
8817 security reasons.
8818
Bram Moolenaar071d4272004-06-13 20:20:40 +00008819 *'winwidth'* *'wiw'* *E592*
8820'winwidth' 'wiw' number (default 20)
8821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008822 Minimal number of columns for the current window. This is not a hard
8823 minimum, Vim will use fewer columns if there is not enough room. If
8824 the current window is smaller, its size is increased, at the cost of
8825 the width of other windows. Set it to 999 to make the current window
8826 always fill the screen. Set it to a small number for normal editing.
8827 The width is not adjusted after one of the commands to change the
8828 width of the current window.
8829 'winwidth' applies to the current window. Use 'winminwidth' to set
8830 the minimal width for other windows.
8831
8832 *'wrap'* *'nowrap'*
8833'wrap' boolean (default on)
8834 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 This option changes how text is displayed. It doesn't change the text
8836 in the buffer, see 'textwidth' for that.
8837 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008838 displaying continues on the next line. When off lines will not wrap
8839 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008840 moved to a part that is not shown, the screen will scroll
8841 horizontally.
8842 The line will be broken in the middle of a word if necessary. See
8843 'linebreak' to get the break at a word boundary.
8844 To make scrolling horizontally a bit more useful, try this: >
8845 :set sidescroll=5
8846 :set listchars+=precedes:<,extends:>
8847< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008848 This option can't be set from a |modeline| when the 'diff' option is
8849 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008850
8851 *'wrapmargin'* *'wm'*
8852'wrapmargin' 'wm' number (default 0)
8853 local to buffer
8854 Number of characters from the right window border where wrapping
8855 starts. When typing text beyond this limit, an <EOL> will be inserted
8856 and inserting continues on the next line.
8857 Options that add a margin, such as 'number' and 'foldcolumn', cause
8858 the text width to be further reduced. This is Vi compatible.
8859 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008860 This option is set to 0 when 'paste' is set and restored when 'paste'
8861 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008862 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008863
8864 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8865'wrapscan' 'ws' boolean (default on) *E384* *E385*
8866 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008867 Searches wrap around the end of the file. Also applies to |]s| and
8868 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008869
8870 *'write'* *'nowrite'*
8871'write' boolean (default on)
8872 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008873 Allows writing files. When not set, writing a file is not allowed.
8874 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008875 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008876 argument. Filtering text is still possible, even though this requires
8877 writing a temporary file.
8878
8879 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8880'writeany' 'wa' boolean (default off)
8881 global
8882 Allows writing to any file with no need for "!" override.
8883
8884 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8885'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8886 otherwise)
8887 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 Make a backup before overwriting a file. The backup is removed after
8889 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008890 also on.
8891 WARNING: Switching this option off means that when Vim fails to write
8892 your buffer correctly and then, for whatever reason, Vim exits, you
8893 lose both the original file and what you were writing. Only reset
8894 this option if your file system is almost full and it makes the write
8895 fail (and make sure not to exit Vim until the write was successful).
8896 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008897 When the 'backupskip' pattern matches, a backup is not made anyway.
8898 NOTE: This option is set to the default value when 'compatible' is
8899 set.
8900
8901 *'writedelay'* *'wd'*
8902'writedelay' 'wd' number (default 0)
8903 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008904 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008905 screen. When non-zero, characters are sent to the terminal one by
8906 one. For MS-DOS pcterm this does not work. For debugging purposes.
8907
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008908 vim:tw=78:ts=8:noet:ft=help:norl: