blob: 2fced509199f4f96b44adf8c1e40340de01c9566 [file] [log] [blame]
Bram Moolenaar98056532019-12-12 14:18:35 +01001*options.txt* For Vim version 8.2. Last change: 2019 Dec 06
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 Moolenaar664f3cf2019-12-07 16:03:51 +0100499 [text{white}]{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar664f3cf2019-12-07 16:03:51 +0100501[text{white}] empty or any text followed by at least one blank
502 character (<Space> or <Tab>); "ex:" always requires at
503 least one blank character
Bram Moolenaar14b69452013-06-29 23:05:20 +0200504{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200505[white] optional white space
506{options} a list of option settings, separated with white space
507 or ':', where each part between ':' is the argument
508 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000509
Bram Moolenaar14b69452013-06-29 23:05:20 +0200510Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000511 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200512 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000513
514The second form (this is compatible with some versions of Vi):
515
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200516 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000517
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200518[text] any text or empty
519{white} at least one blank character (<Space> or <Tab>)
520{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
521[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200522se[t] the string "set " or "se " (note the space); When
523 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200524{options} a list of options, separated with white space, which
525 is the argument for a ":set" command
526: a colon
527[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000528
Bram Moolenaar14b69452013-06-29 23:05:20 +0200529Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000530 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200531 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000532
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200533The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
534chance that a normal word like "lex:" is caught. There is one exception:
535"vi:" and "vim:" can also be at the start of the line (for compatibility with
536version 3.0). Using "ex:" at the start of the line will be ignored (this
537could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000538
539 *modeline-local*
540The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000541buffer and window that contain the file. Although it's possible to set global
542options from a modeline, this is unusual. If you have two windows open and
543the files in it set the same global option to a different value, the result
544depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000545
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000546When editing a file that was already loaded, only the window-local options
547from the modeline are used. Thus if you manually changed a buffer-local
548option after opening the file, it won't be changed if you edit the same buffer
549in another window. But window-local options will be set.
550
Bram Moolenaar071d4272004-06-13 20:20:40 +0000551 *modeline-version*
552If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200553number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000554 vim{vers}: version {vers} or later
555 vim<{vers}: version before {vers}
556 vim={vers}: version {vers}
557 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100558{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
559For example, to use a modeline only for Vim 7.0:
560 /* vim700: set foldmethod=marker */ ~
561To use a modeline for Vim after version 7.2:
562 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000563There can be no blanks between "vim" and the ":".
564
565
566The number of lines that are checked can be set with the 'modelines' option.
567If 'modeline' is off or 'modelines' is 0 no lines are checked.
568
569Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000570like:
571 /* vi:ts=4: */ ~
572will give an error message for the trailing "*/". This line is OK:
573 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000574
575If an error is detected the rest of the line is skipped.
576
577If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000578backslash in front of the ':' will be removed. Example:
579 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000580This sets the 'dir' option to "c:\tmp". Only a single backslash before the
581':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200582 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000583No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000584might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200585can be set. For some options a flag is set, so that when the value is used
586the |sandbox| is effective. Some options can only be set from the modeline
587when 'modelineexpr' is set (the default is off).
588
589Still, there is always a small risk that a modeline causes trouble. E.g.,
590when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
591So disable modelines before editing untrusted text. The mail ftplugin does
592this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000593
594Hint: If you would like to do something else than setting an option, you could
595define an autocommand that checks the file for a specific string. For
596example: >
597 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
598And define a function SetVar() that does something with the line containing
599"VAR".
600
601==============================================================================
6023. Options summary *option-summary*
603
604In the list below all the options are mentioned with their full name and with
605an abbreviation if there is one. Both forms may be used.
606
607In this document when a boolean option is "set" that means that ":set option"
608is entered. When an option is "reset", ":set nooption" is used.
609
610For some options there are two default values: The "Vim default", which is
611used when 'compatible' is not set, and the "Vi default", which is used when
612'compatible' is set.
613
614Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000615are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000616different value in each window. For example the 'list' option can be set in
617one window and reset in another for the same text, giving both types of view
618at the same time. There are a few options that are specific to a certain
619file. These can have a different value for each file or buffer. For example
620the 'textwidth' option can be 78 for a normal text file and 0 for a C
621program.
622
623 global one option for all buffers and windows
624 local to window each window has its own copy of this option
625 local to buffer each buffer has its own copy of this option
626
627When creating a new window the option values from the currently active window
628are used as a default value for the window-specific options. For the
629buffer-specific options this depends on the 's' and 'S' flags in the
630'cpoptions' option. If 's' is included (which is the default) the values for
631buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000632first entered. If 'S' is present the options are copied each time the buffer
633is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000634present, the options are copied from the currently active buffer when the
635buffer is created.
636
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000637Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000638
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000639Not all options are supported in all versions. This depends on the supported
640features and sometimes on the system. A remark about this is in curly braces
641below. When an option is not supported it may still be set without getting an
642error, this is called a hidden option. You can't get the value of a hidden
643option though, it is not stored.
644
645To test if option "foo" can be used with ":set" use something like this: >
646 if exists('&foo')
647This also returns true for a hidden option. To test if option "foo" is really
648supported use something like this: >
649 if exists('+foo')
650<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000651 *E355*
652A jump table for the options with a short description can be found at |Q_op|.
653
654 *'aleph'* *'al'* *aleph* *Aleph*
655'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000657 {only available when compiled with the |+rightleft|
658 feature}
659 The ASCII code for the first letter of the Hebrew alphabet. The
660 routine that maps the keyboard in Hebrew mode, both in Insert mode
661 (when hkmap is set) and on the command-line (when hitting CTRL-_)
662 outputs the Hebrew characters in the range [aleph..aleph+26].
663 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
664 See |rileft.txt|.
665
666 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
667'allowrevins' 'ari' boolean (default off)
668 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000669 {only available when compiled with the |+rightleft|
670 feature}
671 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
672 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
673 into reverse Insert mode, and don't know how to get out. See
674 'revins'.
675 NOTE: This option is reset when 'compatible' is set.
676
677 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
678'altkeymap' 'akm' boolean (default off)
679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000680 {only available when compiled with the |+farsi|
681 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100682 This option was for using Farsi, which has been removed. See
683 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000684
685 *'ambiwidth'* *'ambw'*
686'ambiwidth' 'ambw' string (default: "single")
687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000688 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
689 Tells Vim what to do with characters with East Asian Width Class
690 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
691 letters, Cyrillic letters).
692
693 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000694 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000695 expected by most users.
696 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200697 *E834* *E835*
698 The value "double" cannot be used if 'listchars' or 'fillchars'
699 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000700
701 There are a number of CJK fonts for which the width of glyphs for
702 those characters are solely based on how many octets they take in
703 legacy/traditional CJK encodings. In those encodings, Euro,
704 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000705 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000706 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000707 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000708 Vim is running inside a terminal (emulators) that uses a CJK font
709 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
710 this option should be set to "double" to match the width perceived
711 by Vim with the width of glyphs in the font. Perhaps it also has
712 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
713 when the system locale is set to one of CJK locales. See Unicode
714 Standard Annex #11 (http://www.unicode.org/reports/tr11).
715
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100716 Vim may set this option automatically at startup time when Vim is
717 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200718 escape sequence to request cursor position report. The response can
719 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100720
Bram Moolenaar071d4272004-06-13 20:20:40 +0000721 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
722'antialias' 'anti' boolean (default: off)
723 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000724 {only available when compiled with GUI enabled
725 on Mac OS X}
726 This option only has an effect in the GUI version of Vim on Mac OS X
727 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
728 which can be easier to read at certain sizes on certain displays.
729 Setting this option can sometimes cause problems if 'guifont' is set
730 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100731 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000732
733 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
734'autochdir' 'acd' boolean (default off)
735 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200736 {only available when compiled with it, use
737 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000738 When on, Vim will change the current working directory whenever you
739 open a file, switch buffers, delete a buffer or open/close a window.
740 It will change to the directory containing the file which was opened
741 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000742 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000743
744 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
745'arabic' 'arab' boolean (default off)
746 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000747 {only available when compiled with the |+arabic|
748 feature}
749 This option can be set to start editing Arabic text.
750 Setting this option will:
751 - Set the 'rightleft' option, unless 'termbidi' is set.
752 - Set the 'arabicshape' option, unless 'termbidi' is set.
753 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
754 between typing English and Arabic key mapping.
755 - Set the 'delcombine' option
756 Note that 'encoding' must be "utf-8" for working with Arabic text.
757
758 Resetting this option will:
759 - Reset the 'rightleft' option.
760 - Disable the use of 'keymap' (without changing its value).
761 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200762 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100763 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000764 Also see |arabic.txt|.
765
766 *'arabicshape'* *'arshape'*
767 *'noarabicshape'* *'noarshape'*
768'arabicshape' 'arshape' boolean (default on)
769 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000770 {only available when compiled with the |+arabic|
771 feature}
772 When on and 'termbidi' is off, the required visual character
773 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200774 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000775 one which encompasses:
776 a) the changing/morphing of characters based on their location
777 within a word (initial, medial, final and stand-alone).
778 b) the enabling of the ability to compose characters
779 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100780 When disabled the display shows each character's true stand-alone
781 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000782 Arabic is a complex language which requires other settings, for
783 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100784 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000785
786 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
787'autoindent' 'ai' boolean (default off)
788 local to buffer
789 Copy indent from current line when starting a new line (typing <CR>
790 in Insert mode or when using the "o" or "O" command). If you do not
791 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000792 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
793 to another line has the same effect, unless the 'I' flag is included
794 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000795 When autoindent is on, formatting (with the "gq" command or when you
796 reach 'textwidth' in Insert mode) uses the indentation of the first
797 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000798 When 'smartindent' or 'cindent' is on the indent is changed in
799 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200800 The 'autoindent' option is reset when the 'paste' option is set and
801 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000802
803 *'autoread'* *'ar'* *'noautoread'* *'noar'*
804'autoread' 'ar' boolean (default off)
805 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000806 When a file has been detected to have been changed outside of Vim and
807 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200808 When the file has been deleted this is not done, so you have the text
809 from before it was deleted. When it appears again then it is read.
810 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000811 If this option has a local value, use this command to switch back to
812 using the global value: >
813 :set autoread<
814<
815 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
816'autowrite' 'aw' boolean (default off)
817 global
818 Write the contents of the file, if it has been modified, on each
819 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000820 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000821 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
822 Note that for some commands the 'autowrite' option is not used, see
823 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200824 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200825 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000826
827 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
828'autowriteall' 'awa' boolean (default off)
829 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000830 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
831 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
832 Setting this option also implies that Vim behaves like 'autowrite' has
833 been set.
834
835 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200836'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000838 When set to "dark", Vim will try to use colors that look good on a
839 dark background. When set to "light", Vim will try to use colors that
840 look good on a light background. Any other value is illegal.
841 Vim tries to set the default value according to the terminal used.
842 This will not always be correct.
843 Setting this option does not change the background color, it tells Vim
844 what the background color looks like. For changing the background
845 color, see |:hi-normal|.
846
847 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000848 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000849 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100850 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000851 setting 'background' will cause the color scheme to be reloaded. If
852 the color scheme adjusts to the value of 'background' this will work.
853 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100854 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000855
856 When setting 'background' to the default value with: >
857 :set background&
858< Vim will guess the value. In the GUI this should work correctly,
859 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200860 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200861 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000862
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200863 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200864 color from the terminal. If the returned RGB value is dark/light and
865 'background' is not dark/light, 'background' will be set and the
866 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200867 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100868 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200869
Bram Moolenaar071d4272004-06-13 20:20:40 +0000870 When starting the GUI, the default value for 'background' will be
871 "light". When the value is not set in the .gvimrc, and Vim detects
872 that the background is actually quite dark, 'background' is set to
873 "dark". But this happens only AFTER the .gvimrc file has been read
874 (because the window needs to be opened to find the actual background
875 color). To get around this, force the GUI window to be opened by
876 putting a ":gui" command in the .gvimrc file, before where the value
877 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200878
879 For MS-DOS, Windows and OS/2 the default is "dark".
880 For other systems "dark" is used when 'term' is "linux",
881 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
882 background. Otherwise the default is "light".
883
Bram Moolenaarc572da52017-08-27 16:52:01 +0200884 The |:terminal| command and the |term_start()| function use the
885 'background' value to decide whether the terminal window will start
886 with a white or black background.
887
Bram Moolenaar071d4272004-06-13 20:20:40 +0000888 Normally this option would be set in the .vimrc file. Possibly
889 depending on the terminal name. Example: >
890 :if &term == "pcterm"
891 : set background=dark
892 :endif
893< When this option is set, the default settings for the highlight groups
894 will change. To use other settings, place ":highlight" commands AFTER
895 the setting of the 'background' option.
896 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
897 to select the colors for syntax highlighting. After changing this
898 option, you must load syntax.vim again to see the result. This can be
899 done with ":syntax on".
900
901 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200902'backspace' 'bs' string (default "", set to "indent,eol,start"
903 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000905 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
906 mode. This is a list of items, separated by commas. Each item allows
907 a way to backspace over something:
908 value effect ~
909 indent allow backspacing over autoindent
910 eol allow backspacing over line breaks (join lines)
911 start allow backspacing over the start of insert; CTRL-W and CTRL-U
912 stop once at the start of insert.
913
914 When the value is empty, Vi compatible backspacing is used.
915
916 For backwards compatibility with version 5.4 and earlier:
917 value effect ~
918 0 same as ":set backspace=" (Vi compatible)
919 1 same as ":set backspace=indent,eol"
920 2 same as ":set backspace=indent,eol,start"
921
922 See |:fixdel| if your <BS> or <Del> key does not do what you want.
923 NOTE: This option is set to "" when 'compatible' is set.
924
925 *'backup'* *'bk'* *'nobackup'* *'nobk'*
926'backup' 'bk' boolean (default off)
927 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000928 Make a backup before overwriting a file. Leave it around after the
929 file has been successfully written. If you do not want to keep the
930 backup file, but you do want a backup while the file is being
931 written, reset this option and set the 'writebackup' option (this is
932 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000933 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000934 |backup-table| for more explanations.
935 When the 'backupskip' pattern matches, a backup is not made anyway.
936 When 'patchmode' is set, the backup may be renamed to become the
937 oldest version of a file.
938 NOTE: This option is reset when 'compatible' is set.
939
940 *'backupcopy'* *'bkc'*
941'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200942 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000943 When writing a file and a backup is made, this option tells how it's
944 done. This is a comma separated list of words.
945
946 The main values are:
947 "yes" make a copy of the file and overwrite the original one
948 "no" rename the file and write a new one
949 "auto" one of the previous, what works best
950
951 Extra values that can be combined with the ones above are:
952 "breaksymlink" always break symlinks when writing
953 "breakhardlink" always break hardlinks when writing
954
955 Making a copy and overwriting the original file:
956 - Takes extra time to copy the file.
957 + When the file has special attributes, is a (hard/symbolic) link or
958 has a resource fork, all this is preserved.
959 - When the file is a link the backup will have the name of the link,
960 not of the real file.
961
962 Renaming the file and writing a new one:
963 + It's fast.
964 - Sometimes not all attributes of the file can be copied to the new
965 file.
966 - When the file is a link the new file will not be a link.
967
968 The "auto" value is the middle way: When Vim sees that renaming file
969 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000970 the file is not a link) that is used. When problems are expected, a
971 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000972
973 The "breaksymlink" and "breakhardlink" values can be used in
974 combination with any of "yes", "no" and "auto". When included, they
975 force Vim to always break either symbolic or hard links by doing
976 exactly what the "no" option does, renaming the original file to
977 become the backup and writing a new file in its place. This can be
978 useful for example in source trees where all the files are symbolic or
979 hard links and any changes should stay in the local source tree, not
980 be propagated back to the original source.
981 *crontab*
982 One situation where "no" and "auto" will cause problems: A program
983 that opens a file, invokes Vim to edit that file, and then tests if
984 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000985 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000986 example.
987
988 When a copy is made, the original file is truncated and then filled
989 with the new text. This means that protection bits, owner and
990 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000991 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000992 group of the backup is set to the group of the original file. If this
993 fails, the protection bits for the group are made the same as for
994 others.
995
996 When the file is renamed this is the other way around: The backup has
997 the same attributes of the original file, and the newly written file
998 is owned by the current user. When the file was a (hard/symbolic)
999 link, the new file will not! That's why the "auto" value doesn't
1000 rename when the file is a link. The owner and group of the newly
1001 written file will be set to the same ones as the original file, but
1002 the system may refuse to do this. In that case the "auto" value will
1003 again not rename the file.
1004
Bram Moolenaar036986f2017-03-16 17:41:02 +01001005 NOTE: This option is set to the Vi default value when 'compatible' is
1006 set and to the Vim default value when 'compatible' is reset.
1007
Bram Moolenaar071d4272004-06-13 20:20:40 +00001008 *'backupdir'* *'bdir'*
1009'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001010 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001011 for Unix: ".,~/tmp,~/")
1012 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001013 List of directories for the backup file, separated with commas.
1014 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001015 where this is possible. The directory must exist, Vim will not
1016 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001017 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001018 impossible!). Writing may fail because of this.
1019 - A directory "." means to put the backup file in the same directory
1020 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001021 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001022 put the backup file relative to where the edited file is. The
1023 leading "." is replaced with the path name of the edited file.
1024 ("." inside a directory name has no special meaning).
1025 - Spaces after the comma are ignored, other spaces are considered part
1026 of the directory name. To have a space at the start of a directory
1027 name, precede it with a backslash.
1028 - To include a comma in a directory name precede it with a backslash.
1029 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001030 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001031 the backup file name will be built from the complete path to the
1032 file with all path separators changed to percent '%' signs. This
1033 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001034 On Win32, it is also possible to end with "\\". However, When a
1035 separating comma is following, you must use "//", since "\\" will
1036 include the comma in the file name. Therefore it is recommended to
1037 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001038 - Environment variables are expanded |:set_env|.
1039 - Careful with '\' characters, type one before a space, type two to
1040 get one in the option (see |option-backslash|), for example: >
1041 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1042< - For backwards compatibility with Vim version 3.0 a '>' at the start
1043 of the option is removed.
1044 See also 'backup' and 'writebackup' options.
1045 If you want to hide your backup files on Unix, consider this value: >
1046 :set backupdir=./.backup,~/.backup,.,/tmp
1047< You must create a ".backup" directory in each directory and in your
1048 home directory for this to work properly.
1049 The use of |:set+=| and |:set-=| is preferred when adding or removing
1050 directories from the list. This avoids problems when a future version
1051 uses another default.
1052 This option cannot be set from a |modeline| or in the |sandbox|, for
1053 security reasons.
1054
1055 *'backupext'* *'bex'* *E589*
1056'backupext' 'bex' string (default "~", for VMS: "_")
1057 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001058 String which is appended to a file name to make the name of the
1059 backup file. The default is quite unusual, because this avoids
1060 accidentally overwriting existing files with a backup file. You might
1061 prefer using ".bak", but make sure that you don't have files with
1062 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001063 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001064
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001065 If you like to keep a lot of backups, you could use a BufWritePre
1066 autocommand to change 'backupext' just before writing the file to
1067 include a timestamp. >
1068 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1069< Use 'backupdir' to put the backup in a different directory.
1070
Bram Moolenaar071d4272004-06-13 20:20:40 +00001071 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001072'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1073 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1074 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001076 {not available when compiled without the |+wildignore|
1077 feature}
1078 A list of file patterns. When one of the patterns matches with the
1079 name of the file which is written, no backup file is created. Both
1080 the specified file name and the full path name of the file are used.
1081 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1082 Watch out for special characters, see |option-backslash|.
1083 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001084 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001085
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001086 WARNING: Not having a backup file means that when Vim fails to write
1087 your buffer correctly and then, for whatever reason, Vim exits, you
1088 lose both the original file and what you were writing. Only disable
1089 backups if you don't care about losing the file.
1090
Bram Moolenaar02467872007-05-06 13:22:01 +00001091 Note that environment variables are not expanded. If you want to use
1092 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001093 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001094
1095< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001096 backup would be made by renaming the original file crontab won't see
1097 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001098
1099 *'balloondelay'* *'bdlay'*
1100'balloondelay' 'bdlay' number (default: 600)
1101 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001102 {only available when compiled with the |+balloon_eval|
1103 feature}
1104 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1105
1106 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1107'ballooneval' 'beval' boolean (default off)
1108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001109 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001110 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001111 Switch on the |balloon-eval| functionality for the GUI.
1112
1113 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1114 *'nobevalterm'*
1115'balloonevalterm' 'bevalterm' boolean (default off)
1116 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001117 {only available when compiled with the
1118 |+balloon_eval_term| feature}
1119 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001120
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001121 *'balloonexpr'* *'bexpr'*
1122'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001123 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001124 {only available when compiled with the |+balloon_eval|
1125 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001126 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001127 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1128 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001129
1130 v:beval_bufnr number of the buffer in which balloon is going to show
1131 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001132 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001133 v:beval_lnum line number
1134 v:beval_col column number (byte index)
1135 v:beval_text word under or after the mouse pointer
1136
Bram Moolenaar54775062019-07-31 21:07:14 +02001137 Instead of showing a balloon, which is limited to plain text, consider
1138 using a popup window, see |popup_beval_example|. A popup window can
1139 use highlighting and show a border.
1140
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001141 The evaluation of the expression must not have side effects!
1142 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001143 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001144 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001145 \', column ' . v:beval_col .
1146 \ ' of file ' . bufname(v:beval_bufnr) .
1147 \ ' on word "' . v:beval_text . '"'
1148 endfunction
1149 set bexpr=MyBalloonExpr()
1150 set ballooneval
1151<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001152 Also see |balloon_show()|, it can be used if the content of the balloon
1153 is to be fetched asynchronously. In that case evaluating
1154 'balloonexpr' should result in an empty string. If you get a balloon
1155 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001156
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001157 NOTE: The balloon is displayed only if the cursor is on a text
1158 character. If the result of evaluating 'balloonexpr' is not empty,
1159 Vim does not try to send a message to an external debugger (Netbeans
1160 or Sun Workshop).
1161
Bram Moolenaar30b65812012-07-12 22:01:11 +02001162 The expression will be evaluated in the |sandbox| when set from a
1163 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001164 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001165
1166 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001167 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001168
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001169 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001170 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001171< When they are supported "\n" characters will start a new line. If the
1172 expression evaluates to a |List| this is equal to using each List item
1173 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001174 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001175
Bram Moolenaar165bc692015-07-21 17:53:25 +02001176 *'belloff'* *'bo'*
1177'belloff' 'bo' string (default "")
1178 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001179 Specifies for which events the bell will not be rung. It is a comma
1180 separated list of items. For each item that is present, the bell
1181 will be silenced. This is most useful to specify specific events in
1182 insert mode to be silenced.
1183
1184 item meaning when present ~
1185 all All events.
1186 backspace When hitting <BS> or <Del> and deleting results in an
1187 error.
1188 cursor Fail to move around using the cursor keys or
1189 <PageUp>/<PageDown> in |Insert-mode|.
1190 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1191 |i_CTRL-X_CTRL-T|.
1192 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1193 |i_CTRL-E|.
1194 ctrlg Unknown Char after <C-G> in Insert mode.
1195 error Other Error occurred (e.g. try to join last line)
1196 (mostly used in |Normal-mode| or |Cmdline-mode|).
1197 esc hitting <Esc> in |Normal-mode|.
1198 ex In |Visual-mode|, hitting |Q| results in an error.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001199 hangul Ignored.
Bram Moolenaar165bc692015-07-21 17:53:25 +02001200 insertmode Pressing <Esc> in 'insertmode'.
1201 lang Calling the beep module for Lua/Mzscheme/TCL.
1202 mess No output available for |g<|.
1203 showmatch Error occurred for 'showmatch' function.
1204 operator Empty region error |cpo-E|.
1205 register Unknown register after <C-R> in |Insert-mode|.
1206 shell Bell from shell output |:!|.
1207 spell Error happened on spell suggest.
1208 wildmode More matches in |cmdline-completion| available
1209 (depends on the 'wildmode' setting).
1210
Bram Moolenaar036986f2017-03-16 17:41:02 +01001211 This is most useful to fine tune when in Insert mode the bell should
1212 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001213 indicate that an error occurred. It can be silenced by adding the
1214 "error" keyword.
1215
Bram Moolenaar071d4272004-06-13 20:20:40 +00001216 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1217'binary' 'bin' boolean (default off)
1218 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001219 This option should be set before editing a binary file. You can also
1220 use the |-b| Vim argument. When this option is switched on a few
1221 options will be changed (also when it already was on):
1222 'textwidth' will be set to 0
1223 'wrapmargin' will be set to 0
1224 'modeline' will be off
1225 'expandtab' will be off
1226 Also, 'fileformat' and 'fileformats' options will not be used, the
1227 file is read and written like 'fileformat' was "unix" (a single <NL>
1228 separates lines).
1229 The 'fileencoding' and 'fileencodings' options will not be used, the
1230 file is read without conversion.
1231 NOTE: When you start editing a(nother) file while the 'bin' option is
1232 on, settings from autocommands may change the settings again (e.g.,
1233 'textwidth'), causing trouble when editing. You might want to set
1234 'bin' again when the file has been loaded.
1235 The previous values of these options are remembered and restored when
1236 'bin' is switched from on to off. Each buffer has its own set of
1237 saved option values.
1238 To edit a file with 'binary' set you can use the |++bin| argument.
1239 This avoids you have to do ":set bin", which would have effect for all
1240 files you edit.
1241 When writing a file the <EOL> for the last line is only written if
1242 there was one in the original file (normally Vim appends an <EOL> to
1243 the last line if there is none; this would make the file longer). See
1244 the 'endofline' option.
1245
1246 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1247'bioskey' 'biosk' boolean (default on)
1248 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001249 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001250 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001251
1252 *'bomb'* *'nobomb'*
1253'bomb' boolean (default off)
1254 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001255 When writing a file and the following conditions are met, a BOM (Byte
1256 Order Mark) is prepended to the file:
1257 - this option is on
1258 - the 'binary' option is off
1259 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1260 endian variants.
1261 Some applications use the BOM to recognize the encoding of the file.
1262 Often used for UCS-2 files on MS-Windows. For other applications it
1263 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001264 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001265 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1266 check for the presence of the BOM is done and 'bomb' set accordingly.
1267 Unless 'binary' is set, it is removed from the first line, so that you
1268 don't see it when editing. When you don't change the options, the BOM
1269 will be restored when writing the file.
1270
1271 *'breakat'* *'brk'*
1272'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1273 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001274 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001275 feature}
1276 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001277 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1278 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001279
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001280 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001281'breakindent' 'bri' boolean (default off)
1282 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001283 {not available when compiled without the |+linebreak|
1284 feature}
1285 Every wrapped line will continue visually indented (same amount of
1286 space as the beginning of that line), thus preserving horizontal blocks
1287 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001288 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001289
1290 *'breakindentopt'* *'briopt'*
1291'breakindentopt' 'briopt' string (default empty)
1292 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001293 {not available when compiled without the |+linebreak|
1294 feature}
1295 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001296 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001297 min:{n} Minimum text width that will be kept after
1298 applying 'breakindent', even if the resulting
1299 text should normally be narrower. This prevents
1300 text indented almost to the right window border
1301 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001302 shift:{n} After applying 'breakindent', the wrapped line's
1303 beginning will be shifted by the given number of
1304 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001305 indentation (negative) or emphasizing the line
1306 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001307 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001308 additional indent.
1309 The default value for min is 20 and shift is 0.
1310
Bram Moolenaar071d4272004-06-13 20:20:40 +00001311 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001312'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001313 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001314 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001315 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001316 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001317 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001318 buffer Use the directory of the related buffer.
1319 current Use the current directory.
1320 {path} Use the specified directory
1321
1322 *'bufhidden'* *'bh'*
1323'bufhidden' 'bh' string (default: "")
1324 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001325 This option specifies what happens when a buffer is no longer
1326 displayed in a window:
1327 <empty> follow the global 'hidden' option
1328 hide hide the buffer (don't unload it), also when 'hidden'
1329 is not set
1330 unload unload the buffer, also when 'hidden' is set or using
1331 |:hide|
1332 delete delete the buffer from the buffer list, also when
1333 'hidden' is set or using |:hide|, like using
1334 |:bdelete|
1335 wipe wipe out the buffer from the buffer list, also when
1336 'hidden' is set or using |:hide|, like using
1337 |:bwipeout|
1338
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001339 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001340 are lost without a warning. Also, these values may break autocommands
1341 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001342 This option is used together with 'buftype' and 'swapfile' to specify
1343 special kinds of buffers. See |special-buffers|.
1344
1345 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1346'buflisted' 'bl' boolean (default: on)
1347 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001348 When this option is set, the buffer shows up in the buffer list. If
1349 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1350 This option is reset by Vim for buffers that are only used to remember
1351 a file name or marks. Vim sets it when starting to edit a buffer.
1352 But not when moving to a buffer with ":buffer".
1353
1354 *'buftype'* *'bt'* *E382*
1355'buftype' 'bt' string (default: "")
1356 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001357 The value of this option specifies the type of a buffer:
1358 <empty> normal buffer
1359 nofile buffer which is not related to a file and will not be
1360 written
1361 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001362 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001363 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001364 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001365 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001366 help help buffer (you are not supposed to set this
1367 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001368 terminal buffer for a |terminal| (you are not supposed to set
1369 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001370 prompt buffer where only the last line can be edited, meant
1371 to be used by a plugin, see |prompt-buffer|
1372 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001373 popup buffer used in a popup window, see |popup|.
1374 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001375
1376 This option is used together with 'bufhidden' and 'swapfile' to
1377 specify special kinds of buffers. See |special-buffers|.
1378
1379 Be careful with changing this option, it can have many side effects!
1380
Bram Moolenaar280f1262006-01-30 00:14:18 +00001381 A "quickfix" buffer is only used for the error list and the location
1382 list. This value is set by the |:cwindow| and |:lwindow| commands and
1383 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001384
1385 "nofile" and "nowrite" buffers are similar:
1386 both: The buffer is not to be written to disk, ":w" doesn't
1387 work (":w filename" does work though).
1388 both: The buffer is never considered to be |'modified'|.
1389 There is no warning when the changes will be lost, for
1390 example when you quit Vim.
1391 both: A swap file is only created when using too much memory
1392 (when 'swapfile' has been reset there is never a swap
1393 file).
1394 nofile only: The buffer name is fixed, it is not handled like a
1395 file name. It is not modified in response to a |:cd|
1396 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001397 both: When using ":e bufname" and already editing "bufname"
1398 the buffer is made empty and autocommands are
1399 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001400 *E676*
1401 "acwrite" implies that the buffer name is not related to a file, like
1402 "nofile", but it will be written. Thus, in contrast to "nofile" and
1403 "nowrite", ":w" does work and a modified buffer can't be abandoned
1404 without saving. For writing there must be matching |BufWriteCmd|,
1405 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001406
1407 *'casemap'* *'cmp'*
1408'casemap' 'cmp' string (default: "internal,keepascii")
1409 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001410 Specifies details about changing the case of letters. It may contain
1411 these words, separated by a comma:
1412 internal Use internal case mapping functions, the current
1413 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001414 matters when 'encoding' is a Unicode encoding,
1415 "latin1" or "iso-8859-15". When "internal" is
1416 omitted, the towupper() and towlower() system library
1417 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001418 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1419 case mapping, the current locale is not effective.
1420 This probably only matters for Turkish.
1421
1422 *'cdpath'* *'cd'* *E344* *E346*
1423'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1424 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001425 {not available when compiled without the
1426 |+file_in_path| feature}
1427 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001428 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1429 searched for has a relative path, not an absolute part starting with
1430 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001431 The 'cdpath' option's value has the same form and semantics as
1432 |'path'|. Also see |file-searching|.
1433 The default value is taken from $CDPATH, with a "," prepended to look
1434 in the current directory first.
1435 If the default value taken from $CDPATH is not what you want, include
1436 a modified version of the following command in your vimrc file to
1437 override it: >
1438 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1439< This option cannot be set from a |modeline| or in the |sandbox|, for
1440 security reasons.
1441 (parts of 'cdpath' can be passed to the shell to expand file names).
1442
1443 *'cedit'*
1444'cedit' string (Vi default: "", Vim default: CTRL-F)
1445 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001446 The key used in Command-line Mode to open the command-line window.
1447 The default is CTRL-F when 'compatible' is off.
1448 Only non-printable keys are allowed.
1449 The key can be specified as a single character, but it is difficult to
1450 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001451 :exe "set cedit=\<C-Y>"
1452 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001453< |Nvi| also has this option, but it only uses the first character.
1454 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001455 NOTE: This option is set to the Vim default value when 'compatible'
1456 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001457
1458 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1459'charconvert' 'ccv' string (default "")
1460 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001461 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001462 An expression that is used for character encoding conversion. It is
1463 evaluated when a file that is to be read or has been written has a
1464 different encoding from what is desired.
1465 'charconvert' is not used when the internal iconv() function is
1466 supported and is able to do the conversion. Using iconv() is
1467 preferred, because it is much faster.
1468 'charconvert' is not used when reading stdin |--|, because there is no
1469 file to convert from. You will have to save the text in a file first.
1470 The expression must return zero or an empty string for success,
1471 non-zero for failure.
1472 The possible encoding names encountered are in 'encoding'.
1473 Additionally, names given in 'fileencodings' and 'fileencoding' are
1474 used.
1475 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1476 is done internally by Vim, 'charconvert' is not used for this.
1477 'charconvert' is also used to convert the viminfo file, if the 'c'
1478 flag is present in 'viminfo'. Also used for Unicode conversion.
1479 Example: >
1480 set charconvert=CharConvert()
1481 fun CharConvert()
1482 system("recode "
1483 \ . v:charconvert_from . ".." . v:charconvert_to
1484 \ . " <" . v:fname_in . " >" v:fname_out)
1485 return v:shell_error
1486 endfun
1487< The related Vim variables are:
1488 v:charconvert_from name of the current encoding
1489 v:charconvert_to name of the desired encoding
1490 v:fname_in name of the input file
1491 v:fname_out name of the output file
1492 Note that v:fname_in and v:fname_out will never be the same.
1493 Note that v:charconvert_from and v:charconvert_to may be different
1494 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1495 Encryption is not done by Vim when using 'charconvert'. If you want
1496 to encrypt the file after conversion, 'charconvert' should take care
1497 of this.
1498 This option cannot be set from a |modeline| or in the |sandbox|, for
1499 security reasons.
1500
1501 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1502'cindent' 'cin' boolean (default off)
1503 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001504 {not available when compiled without the |+cindent|
1505 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001506 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001507 that trigger reindenting in insert mode and 'cinoptions' to set your
1508 preferred indent style.
1509 If 'indentexpr' is not empty, it overrules 'cindent'.
1510 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1511 the "=" operator indents using this algorithm rather than calling an
1512 external program.
1513 See |C-indenting|.
1514 When you don't like the way 'cindent' works, try the 'smartindent'
1515 option or 'indentexpr'.
1516 This option is not used when 'paste' is set.
1517 NOTE: This option is reset when 'compatible' is set.
1518
1519 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001520'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001522 {not available when compiled without the |+cindent|
1523 feature}
1524 A list of keys that, when typed in Insert mode, cause reindenting of
1525 the current line. Only used if 'cindent' is on and 'indentexpr' is
1526 empty.
1527 For the format of this option see |cinkeys-format|.
1528 See |C-indenting|.
1529
1530 *'cinoptions'* *'cino'*
1531'cinoptions' 'cino' string (default "")
1532 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001533 {not available when compiled without the |+cindent|
1534 feature}
1535 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1536 program. See |cinoptions-values| for the values of this option, and
1537 |C-indenting| for info on C indenting in general.
1538
1539
1540 *'cinwords'* *'cinw'*
1541'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1542 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001543 {not available when compiled without both the
1544 |+cindent| and the |+smartindent| features}
1545 These keywords start an extra indent in the next line when
1546 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1547 an appropriate place (inside {}).
1548 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1549 matter, include the keyword both the uppercase and lowercase:
1550 "if,If,IF".
1551
1552 *'clipboard'* *'cb'*
1553'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1554 for X-windows, "" otherwise)
1555 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001556 {only in GUI versions or when the |+xterm_clipboard|
1557 feature is included}
1558 This option is a list of comma separated names.
1559 These names are recognized:
1560
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001561 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001562 unnamed When included, Vim will use the clipboard register '*'
1563 for all yank, delete, change and put operations which
1564 would normally go to the unnamed register. When a
1565 register is explicitly specified, it will always be
1566 used regardless of whether "unnamed" is in 'clipboard'
1567 or not. The clipboard register can always be
1568 explicitly accessed using the "* notation. Also see
1569 |gui-clipboard|.
1570
Bram Moolenaar30b65812012-07-12 22:01:11 +02001571 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001572 unnamedplus A variant of the "unnamed" flag which uses the
1573 clipboard register '+' (|quoteplus|) instead of
1574 register '*' for all yank, delete, change and put
1575 operations which would normally go to the unnamed
1576 register. When "unnamed" is also included to the
1577 option, yank operations (but not delete, change or
1578 put) will additionally copy the text into register
1579 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001580 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001581 Availability can be checked with: >
1582 if has('unnamedplus')
1583<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001584 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001585 autoselect Works like the 'a' flag in 'guioptions': If present,
1586 then whenever Visual mode is started, or the Visual
1587 area extended, Vim tries to become the owner of the
1588 windowing system's global selection or put the
1589 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001590 register "*. See |'go-a'| and |quotestar| for details.
1591 When the GUI is active, the 'a' flag in 'guioptions'
1592 is used, when the GUI is not active, this "autoselect"
1593 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001594 Also applies to the modeless selection.
1595
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001596 *clipboard-autoselectplus*
1597 autoselectplus Like "autoselect" but using the + register instead of
1598 the * register. Compare to the 'P' flag in
1599 'guioptions'.
1600
1601 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001602 autoselectml Like "autoselect", but for the modeless selection
1603 only. Compare to the 'A' flag in 'guioptions'.
1604
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001605 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001606 html When the clipboard contains HTML, use this when
1607 pasting. When putting text on the clipboard, mark it
1608 as HTML. This works to copy rendered HTML from
1609 Firefox, paste it as raw HTML in Vim, select the HTML
1610 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001611 You probably want to add this only temporarily,
1612 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001613 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001614
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001615 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001616 exclude:{pattern}
1617 Defines a pattern that is matched against the name of
1618 the terminal 'term'. If there is a match, no
1619 connection will be made to the X server. This is
1620 useful in this situation:
1621 - Running Vim in a console.
1622 - $DISPLAY is set to start applications on another
1623 display.
1624 - You do not want to connect to the X server in the
1625 console, but do want this in a terminal emulator.
1626 To never connect to the X server use: >
1627 exclude:.*
1628< This has the same effect as using the |-X| argument.
1629 Note that when there is no connection to the X server
1630 the window title won't be restored and the clipboard
1631 cannot be accessed.
1632 The value of 'magic' is ignored, {pattern} is
1633 interpreted as if 'magic' was on.
1634 The rest of the option value will be used for
1635 {pattern}, this must be the last entry.
1636
1637 *'cmdheight'* *'ch'*
1638'cmdheight' 'ch' number (default 1)
1639 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001640 Number of screen lines to use for the command-line. Helps avoiding
1641 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001642 The value of this option is stored with the tab page, so that each tab
1643 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001644
1645 *'cmdwinheight'* *'cwh'*
1646'cmdwinheight' 'cwh' number (default 7)
1647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001648 Number of screen lines to use for the command-line window. |cmdwin|
1649
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001650 *'colorcolumn'* *'cc'*
1651'colorcolumn' 'cc' string (default "")
1652 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001653 {not available when compiled without the |+syntax|
1654 feature}
1655 'colorcolumn' is a comma separated list of screen columns that are
1656 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1657 text. Will make screen redrawing slower.
1658 The screen column can be an absolute number, or a number preceded with
1659 '+' or '-', which is added to or subtracted from 'textwidth'. >
1660
1661 :set cc=+1 " highlight column after 'textwidth'
1662 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1663 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1664<
1665 When 'textwidth' is zero then the items with '-' and '+' are not used.
1666 A maximum of 256 columns are highlighted.
1667
Bram Moolenaar071d4272004-06-13 20:20:40 +00001668 *'columns'* *'co'* *E594*
1669'columns' 'co' number (default 80 or terminal width)
1670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001671 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001672 initialization and does not have to be set by hand. Also see
1673 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001674 When Vim is running in the GUI or in a resizable window, setting this
1675 option will cause the window size to be changed. When you only want
1676 to use the size for the GUI, put the command in your |gvimrc| file.
1677 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001678 number of columns of the display, the display may be messed up. For
1679 the GUI it is always possible and Vim limits the number of columns to
1680 what fits on the screen. You can use this command to get the widest
1681 window possible: >
1682 :set columns=9999
1683< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001684
1685 *'comments'* *'com'* *E524* *E525*
1686'comments' 'com' string (default
1687 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1688 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001689 A comma separated list of strings that can start a comment line. See
1690 |format-comments|. See |option-backslash| about using backslashes to
1691 insert a space.
1692
1693 *'commentstring'* *'cms'* *E537*
1694'commentstring' 'cms' string (default "/*%s*/")
1695 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001696 {not available when compiled without the |+folding|
1697 feature}
1698 A template for a comment. The "%s" in the value is replaced with the
1699 comment text. Currently only used to add markers for folding, see
1700 |fold-marker|.
1701
1702 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001703'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001704 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 This option has the effect of making Vim either more Vi-compatible, or
1707 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001708
Bram Moolenaar071d4272004-06-13 20:20:40 +00001709 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001710 other options are also changed as a side effect.
1711 NOTE: Setting or resetting this option can have a lot of unexpected
1712 effects: Mappings are interpreted in another way, undo behaves
1713 differently, etc. If you set this option in your vimrc file, you
1714 should probably put it at the very start.
1715
Bram Moolenaar071d4272004-06-13 20:20:40 +00001716 By default this option is on and the Vi defaults are used for the
1717 options. This default was chosen for those people who want to use Vim
1718 just like Vi, and don't even (want to) know about the 'compatible'
1719 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001720 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001721 this option is switched off, and all options that have not been
1722 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001723 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001724 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001725 happen for the system-wide vimrc or gvimrc file, nor for a file given
1726 with the |-u| argument). Also see |compatible-default| and
1727 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001728 You can also set this option with the "-C" argument, and reset it with
1729 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001730 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001731
Bram Moolenaar214641f2017-03-05 17:04:09 +01001732 When this option is set, numerous other options are set to make Vim as
1733 Vi-compatible as possible. When this option is unset, various options
1734 are set to make Vim more useful. The table below lists all the
1735 options affected.
1736 The {?} column indicates when the options are affected:
1737 + Means that the option is set to the value given in {set value} when
1738 'compatible' is set.
1739 & Means that the option is set to the value given in {set value} when
1740 'compatible' is set AND is set to its Vim default value when
1741 'compatible' is unset.
1742 - Means the option is NOT changed when setting 'compatible' but IS
1743 set to its Vim default when 'compatible' is unset.
1744 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001745
Bram Moolenaar036986f2017-03-16 17:41:02 +01001746 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001747
1748 'allowrevins' + off no CTRL-_ command
1749 'antialias' + off don't use antialiased fonts
1750 'arabic' + off reset arabic-related options
1751 'arabicshape' + on correct character shapes
1752 'backspace' + "" normal backspace
1753 'backup' + off no backup file
1754 'backupcopy' & Unix: "yes" backup file is a copy
1755 else: "auto" copy or rename backup file
1756 'balloonexpr' + "" text to show in evaluation balloon
1757 'breakindent' + off don't indent when wrapping lines
1758 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1759 'cindent' + off no C code indentation
1760 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1761 'copyindent' + off don't copy indent structure
1762 'cpoptions' & (all flags) Vi-compatible flags
1763 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001764 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001765 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001766 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001767 'cscopeverbose' + off see |cscopeverbose|
1768 'delcombine' + off unicode: delete whole char combination
1769 'digraph' + off no digraphs
1770 'esckeys' & off no <Esc>-keys in Insert mode
1771 'expandtab' + off tabs not expanded to spaces
1772 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001773 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001774 'formatexpr' + "" use 'formatprg' for auto-formatting
1775 'formatoptions' & "vt" Vi compatible formatting
1776 'gdefault' + off no default 'g' flag for ":s"
1777 'history' & 0 no commandline history
1778 'hkmap' + off no Hebrew keyboard mapping
1779 'hkmapp' + off no phonetic Hebrew keyboard mapping
1780 'hlsearch' + off no highlighting of search matches
1781 'incsearch' + off no incremental searching
1782 'indentexpr' + "" no indenting by expression
1783 'insertmode' + off do not start in Insert mode
1784 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001785 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001786 'joinspaces' + on insert 2 spaces after period
1787 'modeline' & off no modelines
1788 'more' & off no pauses in listings
1789 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1790 'numberwidth' & 8 min number of columns for line number
1791 'preserveindent'+ off don't preserve current indent structure
1792 when changing it
1793 'revins' + off no reverse insert
1794 'ruler' + off no ruler
1795 'scrolljump' + 1 no jump scroll
1796 'scrolloff' + 0 no scroll offset
1797 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1798 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001799 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001800 'showcmd' & off command characters not shown
1801 'showmode' & off current mode not shown
1802 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1803 'smartcase' + off no automatic ignore case switch
1804 'smartindent' + off no smart indentation
1805 'smarttab' + off no smart tab size
1806 'softtabstop' + 0 tabs are always 'tabstop' positions
1807 'startofline' + on goto startofline with some commands
1808 'tagcase' & "followic" 'ignorecase' when searching tags file
1809 'tagrelative' & off tag file names are not relative
1810 'termguicolors' + off don't use highlight-(guifg|guibg)
1811 'textauto' & off no automatic textmode detection
1812 'textwidth' + 0 no automatic line wrap
1813 'tildeop' + off tilde is not an operator
1814 'ttimeout' + off no terminal timeout
1815 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001816 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001817 'virtualedit' + "" cursor can only be placed on characters
1818 'whichwrap' & "" left-right movements don't wrap
1819 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001820 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001821 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001822
1823 *'complete'* *'cpt'* *E535*
1824'complete' 'cpt' string (default: ".,w,b,u,t,i")
1825 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001826 This option specifies how keyword completion |ins-completion| works
1827 when CTRL-P or CTRL-N are used. It is also used for whole-line
1828 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1829 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001830 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001831 w scan buffers from other windows
1832 b scan other loaded buffers that are in the buffer list
1833 u scan the unloaded buffers that are in the buffer list
1834 U scan the buffers that are not in the buffer list
1835 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001836 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001837 k{dict} scan the file {dict}. Several "k" flags can be given,
1838 patterns are valid too. For example: >
1839 :set cpt=k/usr/dict/*,k~/spanish
1840< s scan the files given with the 'thesaurus' option
1841 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1842 are valid too.
1843 i scan current and included files
1844 d scan current and included files for defined name or macro
1845 |i_CTRL-X_CTRL-D|
1846 ] tag completion
1847 t same as "]"
1848
1849 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1850 not executed, this may lead to unexpected completions from some files
1851 (gzipped files for example). Unloaded buffers are not scanned for
1852 whole-line completion.
1853
1854 The default is ".,w,b,u,t,i", which means to scan:
1855 1. the current buffer
1856 2. buffers in other windows
1857 3. other loaded buffers
1858 4. unloaded buffers
1859 5. tags
1860 6. included files
1861
1862 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001863 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1864 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001865
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001866 *'completefunc'* *'cfu'*
1867'completefunc' 'cfu' string (default: empty)
1868 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001869 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001870 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001871 This option specifies a function to be used for Insert mode completion
1872 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001873 See |complete-functions| for an explanation of how the function is
1874 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001875 This option cannot be set from a |modeline| or in the |sandbox|, for
1876 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001877
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001878 *'completeslash'* *'csl'*
1879'completeslash' 'csl' string (default: "")
1880 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001881 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001882 When this option is set it overrules 'shellslash' for completion:
1883 - When this option is set to "slash", a forward slash is used for path
1884 completion in insert mode. This is useful when editing HTML tag, or
1885 Makefile with 'noshellslash' on Windows.
1886 - When this option is set to "backslash", backslash is used. This is
1887 useful when editing a batch file with 'shellslash' set on Windows.
1888 - When this option is empty, same character is used as for
1889 'shellslash'.
1890 For Insert mode completion the buffer-local value is used. For
1891 command line completion the global value is used.
1892
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001893 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001894'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001895 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001896 A comma separated list of options for Insert mode completion
1897 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001898
1899 menu Use a popup menu to show the possible completions. The
1900 menu is only shown when there is more than one match and
1901 sufficient colors are available. |ins-completion-menu|
1902
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001903 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001904 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001905 match, e.g., what file it comes from.
1906
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001907 longest Only insert the longest common text of the matches. If
1908 the menu is displayed you can use CTRL-L to add more
1909 characters. Whether case is ignored depends on the kind
1910 of completion. For buffer text the 'ignorecase' option is
1911 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001912
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001913 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001914 completion in the preview window. Only works in
1915 combination with "menu" or "menuone".
1916
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001917 popup Show extra information about the currently selected
1918 completion in a popup window. Only works in combination
1919 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001920 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001921 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001922
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001923 popuphidden
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01001924 Just like "popup" but initially hide the popup. Use a
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001925 |CompleteChanged| autocommand to fetch the info and call
1926 |popup_show()| once the popup has been filled.
1927 See the example at |complete-popuphidden|.
1928 {only works when compiled with the |+textprop| feature}
1929
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001930 noinsert Do not insert any text for a match until the user selects
1931 a match from the menu. Only works in combination with
1932 "menu" or "menuone". No effect if "longest" is present.
1933
1934 noselect Do not select a match in the menu, force the user to
1935 select one from the menu. Only works in combination with
1936 "menu" or "menuone".
1937
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001938
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001939 *'completepopup'* *'cpp'*
1940'completepopup' 'cpp' string (default empty)
1941 global
1942 {not available when compiled without the |+textprop|
1943 or |+quickfix| feature}
1944 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001945 properties of the info popup when it is created. You can also use
1946 |popup_findinfo()| and then set properties for an existing info popup
1947 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001948
1949
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001950 *'concealcursor'* *'cocu'*
1951'concealcursor' 'cocu' string (default: "")
1952 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001953 {not available when compiled without the |+conceal|
1954 feature}
1955 Sets the modes in which text in the cursor line can also be concealed.
1956 When the current mode is listed then concealing happens just like in
1957 other lines.
1958 n Normal mode
1959 v Visual mode
1960 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001961 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001962
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001963 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001964 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001965 are moving around text is concealed, but when starting to insert text
1966 or selecting a Visual area the concealed text is displayed, so that
1967 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001968 Keep in mind that the cursor position is not always where it's
1969 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001970
1971
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001972 *'conceallevel'* *'cole'*
1973'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001974 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001975 {not available when compiled without the |+conceal|
1976 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001977 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1978 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001979
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001980 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001981 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001982 1 Each block of concealed text is replaced with one
1983 character. If the syntax item does not have a custom
1984 replacement character defined (see |:syn-cchar|) the
1985 character defined in 'listchars' is used (default is a
1986 space).
1987 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001988 2 Concealed text is completely hidden unless it has a
1989 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001990 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001991 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001992
Bram Moolenaara7781e02010-07-19 20:13:22 +02001993 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001994 edit and copy the text. This can be changed with the 'concealcursor'
1995 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001996
Bram Moolenaar071d4272004-06-13 20:20:40 +00001997 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1998'confirm' 'cf' boolean (default off)
1999 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002000 When 'confirm' is on, certain operations that would normally
2001 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2002 instead raise a |dialog| asking if you wish to save the current
2003 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2004 If 'confirm' is off you can still activate confirmation for one
2005 command only (this is most useful in mappings) with the |:confirm|
2006 command.
2007 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2008
2009 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2010'conskey' 'consk' boolean (default off)
2011 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002012 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002013
2014 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2015'copyindent' 'ci' boolean (default off)
2016 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002017 Copy the structure of the existing lines indent when autoindenting a
2018 new line. Normally the new indent is reconstructed by a series of
2019 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2020 in which case only spaces are used). Enabling this option makes the
2021 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002022 existing line. 'expandtab' has no effect on these characters, a Tab
2023 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002024 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002025 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 Also see 'preserveindent'.
2027
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002028 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029'cpoptions' 'cpo' string (Vim default: "aABceFs",
2030 Vi default: all flags)
2031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002032 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002033 this indicates Vi-compatible behavior. This is used for things where
2034 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002035 'cpoptions' stands for "compatible-options".
2036 Commas can be added for readability.
2037 To avoid problems with flags that are added in the future, use the
2038 "+=" and "-=" feature of ":set" |add-option-flags|.
2039 NOTE: This option is set to the Vi default value when 'compatible' is
2040 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002041 NOTE: This option is set to the POSIX default value at startup when
2042 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002043 variable exists |posix|. This means Vim tries to behave like the
2044 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002045
2046 contains behavior ~
2047 *cpo-a*
2048 a When included, a ":read" command with a file name
2049 argument will set the alternate file name for the
2050 current window.
2051 *cpo-A*
2052 A When included, a ":write" command with a file name
2053 argument will set the alternate file name for the
2054 current window.
2055 *cpo-b*
2056 b "\|" in a ":map" command is recognized as the end of
2057 the map command. The '\' is included in the mapping,
2058 the text after the '|' is interpreted as the next
2059 command. Use a CTRL-V instead of a backslash to
2060 include the '|' in the mapping. Applies to all
2061 mapping, abbreviation, menu and autocmd commands.
2062 See also |map_bar|.
2063 *cpo-B*
2064 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002065 abbreviations, user commands and the "to" part of the
2066 menu commands. Remove this flag to be able to use a
2067 backslash like a CTRL-V. For example, the command
2068 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002069 'B' included: "\^[" (^[ is a real <Esc>)
2070 'B' excluded: "<Esc>" (5 characters)
2071 ('<' excluded in both cases)
2072 *cpo-c*
2073 c Searching continues at the end of any match at the
2074 cursor position, but not further than the start of the
2075 next line. When not present searching continues
2076 one character from the cursor position. With 'c'
2077 "abababababab" only gets three matches when repeating
2078 "/abab", without 'c' there are five matches.
2079 *cpo-C*
2080 C Do not concatenate sourced lines that start with a
2081 backslash. See |line-continuation|.
2082 *cpo-d*
2083 d Using "./" in the 'tags' option doesn't mean to use
2084 the tags file relative to the current file, but the
2085 tags file in the current directory.
2086 *cpo-D*
2087 D Can't use CTRL-K to enter a digraph after Normal mode
2088 commands with a character argument, like |r|, |f| and
2089 |t|.
2090 *cpo-e*
2091 e When executing a register with ":@r", always add a
2092 <CR> to the last line, also when the register is not
2093 linewise. If this flag is not present, the register
2094 is not linewise and the last line does not end in a
2095 <CR>, then the last line is put on the command-line
2096 and can be edited before hitting <CR>.
2097 *cpo-E*
2098 E It is an error when using "y", "d", "c", "g~", "gu" or
2099 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002100 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002101 This makes "y0" fail in the first column.
2102 *cpo-f*
2103 f When included, a ":read" command with a file name
2104 argument will set the file name for the current buffer,
2105 if the current buffer doesn't have a file name yet.
2106 *cpo-F*
2107 F When included, a ":write" command with a file name
2108 argument will set the file name for the current
2109 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002110 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 *cpo-g*
2112 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002113 *cpo-H*
2114 H When using "I" on a line with only blanks, insert
2115 before the last blank. Without this flag insert after
2116 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 *cpo-i*
2118 i When included, interrupting the reading of a file will
2119 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002120 *cpo-I*
2121 I When moving the cursor up or down just after inserting
2122 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 *cpo-j*
2124 j When joining lines, only add two spaces after a '.',
2125 not after '!' or '?'. Also see 'joinspaces'.
2126 *cpo-J*
2127 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002128 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002129 white space.
2130 *cpo-k*
2131 k Disable the recognition of raw key codes in
2132 mappings, abbreviations, and the "to" part of menu
2133 commands. For example, if <Key> sends ^[OA (where ^[
2134 is <Esc>), the command ":map X ^[OA" results in X
2135 being mapped to:
2136 'k' included: "^[OA" (3 characters)
2137 'k' excluded: "<Key>" (one key code)
2138 Also see the '<' flag below.
2139 *cpo-K*
2140 K Don't wait for a key code to complete when it is
2141 halfway a mapping. This breaks mapping <F1><F1> when
2142 only part of the second <F1> has been read. It
2143 enables cancelling the mapping by typing <F1><Esc>.
2144 *cpo-l*
2145 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002146 literally, only "\]", "\^", "\-" and "\\" are special.
2147 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002148 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2149 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002150 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002151 *cpo-L*
2152 L When the 'list' option is set, 'wrapmargin',
2153 'textwidth', 'softtabstop' and Virtual Replace mode
2154 (see |gR|) count a <Tab> as two characters, instead of
2155 the normal behavior of a <Tab>.
2156 *cpo-m*
2157 m When included, a showmatch will always wait half a
2158 second. When not included, a showmatch will wait half
2159 a second or until a character is typed. |'showmatch'|
2160 *cpo-M*
2161 M When excluded, "%" matching will take backslashes into
2162 account. Thus in "( \( )" and "\( ( \)" the outer
2163 parenthesis match. When included "%" ignores
2164 backslashes, which is Vi compatible.
2165 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002166 n When included, the column used for 'number' and
2167 'relativenumber' will also be used for text of wrapped
2168 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002169 *cpo-o*
2170 o Line offset to search command is not remembered for
2171 next search.
2172 *cpo-O*
2173 O Don't complain if a file is being overwritten, even
2174 when it didn't exist when editing it. This is a
2175 protection against a file unexpectedly created by
2176 someone else. Vi didn't complain about this.
2177 *cpo-p*
2178 p Vi compatible Lisp indenting. When not present, a
2179 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002180 *cpo-P*
2181 P When included, a ":write" command that appends to a
2182 file will set the file name for the current buffer, if
2183 the current buffer doesn't have a file name yet and
2184 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002185 *cpo-q*
2186 q When joining multiple lines leave the cursor at the
2187 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002188 *cpo-r*
2189 r Redo ("." command) uses "/" to repeat a search
2190 command, instead of the actually used search string.
2191 *cpo-R*
2192 R Remove marks from filtered lines. Without this flag
2193 marks are kept like |:keepmarks| was used.
2194 *cpo-s*
2195 s Set buffer options when entering the buffer for the
2196 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002197 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002198 set when the buffer is created.
2199 *cpo-S*
2200 S Set buffer options always when entering a buffer
2201 (except 'readonly', 'fileformat', 'filetype' and
2202 'syntax'). This is the (most) Vi compatible setting.
2203 The options are set to the values in the current
2204 buffer. When you change an option and go to another
2205 buffer, the value is copied. Effectively makes the
2206 buffer options global to all buffers.
2207
2208 's' 'S' copy buffer options
2209 no no when buffer created
2210 yes no when buffer first entered (default)
2211 X yes each time when buffer entered (vi comp.)
2212 *cpo-t*
2213 t Search pattern for the tag command is remembered for
2214 "n" command. Otherwise Vim only puts the pattern in
2215 the history for search pattern, but doesn't change the
2216 last used search pattern.
2217 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002218 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002219 *cpo-v*
2220 v Backspaced characters remain visible on the screen in
2221 Insert mode. Without this flag the characters are
2222 erased from the screen right away. With this flag the
2223 screen newly typed text overwrites backspaced
2224 characters.
2225 *cpo-w*
2226 w When using "cw" on a blank character, only change one
2227 character and not all blanks until the start of the
2228 next word.
2229 *cpo-W*
2230 W Don't overwrite a readonly file. When omitted, ":w!"
2231 overwrites a readonly file, if possible.
2232 *cpo-x*
2233 x <Esc> on the command-line executes the command-line.
2234 The default in Vim is to abandon the command-line,
2235 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002236 *cpo-X*
2237 X When using a count with "R" the replaced text is
2238 deleted only once. Also when repeating "R" with "."
2239 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002240 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002241 y A yank command can be redone with ".". Think twice if
2242 you really want to use this, it may break some
2243 plugins, since most people expect "." to only repeat a
2244 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002245 *cpo-Z*
2246 Z When using "w!" while the 'readonly' option is set,
2247 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002248 *cpo-!*
2249 ! When redoing a filter command, use the last used
2250 external command, whatever it was. Otherwise the last
2251 used -filter- command is used.
2252 *cpo-$*
2253 $ When making a change to one line, don't redisplay the
2254 line, but put a '$' at the end of the changed text.
2255 The changed text will be overwritten when you type the
2256 new text. The line is redisplayed if you type any
2257 command that moves the cursor from the insertion
2258 point.
2259 *cpo-%*
2260 % Vi-compatible matching is done for the "%" command.
2261 Does not recognize "#if", "#endif", etc.
2262 Does not recognize "/*" and "*/".
2263 Parens inside single and double quotes are also
2264 counted, causing a string that contains a paren to
2265 disturb the matching. For example, in a line like
2266 "if (strcmp("foo(", s))" the first paren does not
2267 match the last one. When this flag is not included,
2268 parens inside single and double quotes are treated
2269 specially. When matching a paren outside of quotes,
2270 everything inside quotes is ignored. When matching a
2271 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002272 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002273 This flag is also used for other features, such as
2274 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002275 *cpo--*
2276 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002277 it would go above the first line or below the last
2278 line. Without it the cursor moves to the first or
2279 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002280 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002281 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002282 *cpo-+*
2283 + When included, a ":write file" command will reset the
2284 'modified' flag of the buffer, even though the buffer
2285 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002286 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 * Use ":*" in the same way as ":@". When not included,
2288 ":*" is an alias for ":'<,'>", select the Visual area.
2289 *cpo-<*
2290 < Disable the recognition of special key codes in |<>|
2291 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002292 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002293 ":map X <Tab>" results in X being mapped to:
2294 '<' included: "<Tab>" (5 characters)
2295 '<' excluded: "^I" (^I is a real <Tab>)
2296 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002297 *cpo->*
2298 > When appending to a register, put a line break before
2299 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002300 *cpo-;*
2301 ; When using |,| or |;| to repeat the last |t| search
2302 and the cursor is right in front of the searched
2303 character, the cursor won't move. When not included,
2304 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002305 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002306
2307 POSIX flags. These are not included in the Vi default value, except
2308 when $VIM_POSIX was set on startup. |posix|
2309
2310 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002311 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002312 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002313 *cpo-&*
2314 & When ":preserve" was used keep the swap file when
2315 exiting normally while this buffer is still loaded.
2316 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002317 *cpo-\*
2318 \ Backslash in a [] range in a search pattern is taken
2319 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002320 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2321 '\' excluded: "/[ \-]" finds <Space> and '-'
2322 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002323 *cpo-/*
2324 / When "%" is used as the replacement string in a |:s|
2325 command, use the previous replacement string. |:s%|
2326 *cpo-{*
2327 { The |{| and |}| commands also stop at a "{" character
2328 at the start of a line.
2329 *cpo-.*
2330 . The ":chdir" and ":cd" commands fail if the current
2331 buffer is modified, unless ! is used. Vim doesn't
2332 need this, since it remembers the full path of an
2333 opened file.
2334 *cpo-bar*
2335 | The value of the $LINES and $COLUMNS environment
2336 variables overrule the terminal size values obtained
2337 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002338
Bram Moolenaar071d4272004-06-13 20:20:40 +00002339
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002340 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002341'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002342 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002343 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002344 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002345 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002346 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002347 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002348 blowfish Blowfish method. Medium strong encryption but it has
2349 an implementation flaw. Requires Vim 7.3 or later,
2350 files can NOT be read by Vim 7.2 and older. This adds
2351 a "seed" to the file, every time you write the file
2352 the encrypted bytes will be different.
2353 *blowfish2*
2354 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002355 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002356 and older. This adds a "seed" to the file, every time
2357 you write the file the encrypted bytes will be
2358 different. The whole undo file is encrypted, not just
2359 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002360
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002361 You should use "blowfish2", also to re-encrypt older files.
2362
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002363 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002364 to the detected method of the file being read. Thus if you write it
2365 without changing 'cryptmethod' the same method will be used.
2366 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002367 explicitly write it, you don't get a warning unless there are other
2368 modifications. Also see |:X|.
2369
2370 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002371 the value "blowfish2". When setting the local value to an empty
2372 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002373
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002374 When a new encryption method is added in a later version of Vim, and
2375 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002376 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002377
2378
Bram Moolenaar071d4272004-06-13 20:20:40 +00002379 *'cscopepathcomp'* *'cspc'*
2380'cscopepathcomp' 'cspc' number (default 0)
2381 global
2382 {not available when compiled without the |+cscope|
2383 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002384 Determines how many components of the path to show in a list of tags.
2385 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002386 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387
2388 *'cscopeprg'* *'csprg'*
2389'cscopeprg' 'csprg' string (default "cscope")
2390 global
2391 {not available when compiled without the |+cscope|
2392 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002393 Specifies the command to execute cscope. See |cscopeprg|.
2394 This option cannot be set from a |modeline| or in the |sandbox|, for
2395 security reasons.
2396
2397 *'cscopequickfix'* *'csqf'*
2398'cscopequickfix' 'csqf' string (default "")
2399 global
2400 {not available when compiled without the |+cscope|
2401 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002402 Specifies whether to use quickfix window to show cscope results.
2403 See |cscopequickfix|.
2404
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002405 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002406'cscoperelative' 'csre' boolean (default off)
2407 global
2408 {not available when compiled without the |+cscope|
2409 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002410 In the absence of a prefix (-P) for cscope. setting this option enables
2411 to use the basename of cscope.out path as the prefix.
2412 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002413 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002414
Bram Moolenaar071d4272004-06-13 20:20:40 +00002415 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2416'cscopetag' 'cst' boolean (default off)
2417 global
2418 {not available when compiled without the |+cscope|
2419 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002420 Use cscope for tag commands. See |cscope-options|.
2421 NOTE: This option is reset when 'compatible' is set.
2422
2423 *'cscopetagorder'* *'csto'*
2424'cscopetagorder' 'csto' number (default 0)
2425 global
2426 {not available when compiled without the |+cscope|
2427 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002428 Determines the order in which ":cstag" performs a search. See
2429 |cscopetagorder|.
2430 NOTE: This option is set to 0 when 'compatible' is set.
2431
2432 *'cscopeverbose'* *'csverb'*
2433 *'nocscopeverbose'* *'nocsverb'*
2434'cscopeverbose' 'csverb' boolean (default off)
2435 global
2436 {not available when compiled without the |+cscope|
2437 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002438 Give messages when adding a cscope database. See |cscopeverbose|.
2439 NOTE: This option is reset when 'compatible' is set.
2440
Bram Moolenaar860cae12010-06-05 23:22:07 +02002441 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2442'cursorbind' 'crb' boolean (default off)
2443 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002444 When this option is set, as the cursor in the current
2445 window moves other cursorbound windows (windows that also have
2446 this option set) move their cursors to the corresponding line and
2447 column. This option is useful for viewing the
2448 differences between two versions of a file (see 'diff'); in diff mode,
2449 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002450 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002451
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002452
2453 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2454'cursorcolumn' 'cuc' boolean (default off)
2455 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002456 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002457 feature}
2458 Highlight the screen column of the cursor with CursorColumn
2459 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2460 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002461 If you only want the highlighting in the current window you can use
2462 these autocommands: >
2463 au WinLeave * set nocursorline nocursorcolumn
2464 au WinEnter * set cursorline cursorcolumn
2465<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002466
2467 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2468'cursorline' 'cul' boolean (default off)
2469 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002470 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002471 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002472 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2473 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002474 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002475 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002476
2477
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002478 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002479'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002480 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002481 {not available when compiled without the |+syntax|
2482 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002483 Comma separated list of settings for how 'cursorline' is displayed.
2484 Valid values:
2485 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002486 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002487 "screenline" Highlight only the screen line of the cursor with
2488 CursorLine |hl-CursorLine|.
2489 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002490 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002491
2492 Special value:
2493 "both" Alias for the values "line,number".
2494
2495 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002496
2497
Bram Moolenaar071d4272004-06-13 20:20:40 +00002498 *'debug'*
2499'debug' string (default "")
2500 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002501 These values can be used:
2502 msg Error messages that would otherwise be omitted will be given
2503 anyway.
2504 throw Error messages that would otherwise be omitted will be given
2505 anyway and also throw an exception and set |v:errmsg|.
2506 beep A message will be given when otherwise only a beep would be
2507 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002508 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002509 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2510 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511
2512 *'define'* *'def'*
2513'define' 'def' string (default "^\s*#\s*define")
2514 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002515 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002516 pattern, just like for the "/" command. This option is used for the
2517 commands like "[i" and "[d" |include-search|. The 'isident' option is
2518 used to recognize the defined name after the match:
2519 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2520 See |option-backslash| about inserting backslashes to include a space
2521 or backslash.
2522 The default value is for C programs. For C++ this value would be
2523 useful, to include const type declarations: >
2524 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002525< You can also use "\ze" just before the name and continue the pattern
2526 to check what is following. E.g. for Javascript, if a function is
2527 defined with "func_name = function(args)": >
2528 ^\s*\ze\i\+\s*=\s*function(
2529< If the function is defined with "func_name : function() {...": >
2530 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002531< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002532 To avoid that use `:let` with a single quote string: >
2533 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002534<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002535
2536 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2537'delcombine' 'deco' boolean (default off)
2538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002539 If editing Unicode and this option is set, backspace and Normal mode
2540 "x" delete each combining character on its own. When it is off (the
2541 default) the character along with its combining characters are
2542 deleted.
2543 Note: When 'delcombine' is set "xx" may work different from "2x"!
2544
2545 This is useful for Arabic, Hebrew and many other languages where one
2546 may have combining characters overtop of base characters, and want
2547 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002548 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002549
2550 *'dictionary'* *'dict'*
2551'dictionary' 'dict' string (default "")
2552 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002553 List of file names, separated by commas, that are used to lookup words
2554 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2555 contain a list of words. This can be one word per line, or several
2556 words per line, separated by non-keyword characters (white space is
2557 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002558
2559 When this option is empty or an entry "spell" is present, and spell
2560 checking is enabled, words in the word lists for the currently active
2561 'spelllang' are used. See |spell|.
2562
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002563 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002564 after a comma are ignored, otherwise spaces are included in the file
2565 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002566 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002567 Where to find a list of words?
2568 - On FreeBSD, there is the file "/usr/share/dict/words".
2569 - In the Simtel archive, look in the "msdos/linguist" directory.
2570 - In "miscfiles" of the GNU collection.
2571 The use of |:set+=| and |:set-=| is preferred when adding or removing
2572 directories from the list. This avoids problems when a future version
2573 uses another default.
2574 Backticks cannot be used in this option for security reasons.
2575
2576 *'diff'* *'nodiff'*
2577'diff' boolean (default off)
2578 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002579 {not available when compiled without the |+diff|
2580 feature}
2581 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002582 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002583
2584 *'dex'* *'diffexpr'*
2585'diffexpr' 'dex' string (default "")
2586 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002587 {not available when compiled without the |+diff|
2588 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002589 Expression which is evaluated to obtain a diff file (either ed-style
2590 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 This option cannot be set from a |modeline| or in the |sandbox|, for
2592 security reasons.
2593
2594 *'dip'* *'diffopt'*
Bram Moolenaarc8234772019-11-10 21:00:27 +01002595'diffopt' 'dip' string (default "internal,filler,closeoff")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002597 {not available when compiled without the |+diff|
2598 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002599 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002600 All are optional. Items must be separated by a comma.
2601
2602 filler Show filler lines, to keep the text
2603 synchronized with a window that has inserted
2604 lines at the same position. Mostly useful
2605 when windows are side-by-side and 'scrollbind'
2606 is set.
2607
2608 context:{n} Use a context of {n} lines between a change
2609 and a fold that contains unchanged lines.
2610 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002611 When using zero the context is actually one,
2612 since folds require a line in between, also
2613 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002614 See |fold-diff|.
2615
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002616 iblank Ignore changes where lines are all blank. Adds
2617 the "-B" flag to the "diff" command if
2618 'diffexpr' is empty. Check the documentation
2619 of the "diff" command for what this does
2620 exactly.
2621 NOTE: the diff windows will get out of sync,
2622 because no differences between blank lines are
2623 taken into account.
2624
Bram Moolenaar071d4272004-06-13 20:20:40 +00002625 icase Ignore changes in case of text. "a" and "A"
2626 are considered the same. Adds the "-i" flag
2627 to the "diff" command if 'diffexpr' is empty.
2628
2629 iwhite Ignore changes in amount of white space. Adds
2630 the "-b" flag to the "diff" command if
2631 'diffexpr' is empty. Check the documentation
2632 of the "diff" command for what this does
2633 exactly. It should ignore adding trailing
2634 white space, but not leading white space.
2635
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002636 iwhiteall Ignore all white space changes. Adds
2637 the "-w" flag to the "diff" command if
2638 'diffexpr' is empty. Check the documentation
2639 of the "diff" command for what this does
2640 exactly.
2641
2642 iwhiteeol Ignore white space changes at end of line.
2643 Adds the "-Z" flag to the "diff" command if
2644 'diffexpr' is empty. Check the documentation
2645 of the "diff" command for what this does
2646 exactly.
2647
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002648 horizontal Start diff mode with horizontal splits (unless
2649 explicitly specified otherwise).
2650
2651 vertical Start diff mode with vertical splits (unless
2652 explicitly specified otherwise).
2653
Bram Moolenaarc8234772019-11-10 21:00:27 +01002654 closeoff When a window is closed where 'diff' is set
2655 and there is only one window remaining in the
2656 same tab page with 'diff' set, execute
2657 `:diffoff` in that window. This undoes a
2658 `:diffsplit` command.
2659
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002660 hiddenoff Do not use diff mode for a buffer when it
2661 becomes hidden.
2662
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002663 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2664 starting diff mode. Without this 2 is used.
2665
Bram Moolenaare828b762018-09-10 17:51:58 +02002666 internal Use the internal diff library. This is
2667 ignored when 'diffexpr' is set. *E960*
2668 When running out of memory when writing a
2669 buffer this item will be ignored for diffs
2670 involving that buffer. Set the 'verbose'
2671 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002672
Bram Moolenaare828b762018-09-10 17:51:58 +02002673 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002674 Use the indent heuristic for the internal
2675 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002676
2677 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002678 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002679 algorithms are:
2680 myers the default algorithm
2681 minimal spend extra time to generate the
2682 smallest possible diff
2683 patience patience diff algorithm
2684 histogram histogram diff algorithm
2685
2686 Examples: >
2687 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002689 :set diffopt=internal,filler,foldcolumn:3
2690 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002691<
2692 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2693'digraph' 'dg' boolean (default off)
2694 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002695 {not available when compiled without the |+digraphs|
2696 feature}
2697 Enable the entering of digraphs in Insert mode with {char1} <BS>
2698 {char2}. See |digraphs|.
2699 NOTE: This option is reset when 'compatible' is set.
2700
2701 *'directory'* *'dir'*
2702'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002703 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 for Unix: ".,~/tmp,/var/tmp,/tmp")
2705 global
2706 List of directory names for the swap file, separated with commas.
2707 - The swap file will be created in the first directory where this is
2708 possible.
2709 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002710 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002711 - A directory "." means to put the swap file in the same directory as
2712 the edited file. On Unix, a dot is prepended to the file name, so
2713 it doesn't show in a directory listing. On MS-Windows the "hidden"
2714 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002715 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002716 put the swap file relative to where the edited file is. The leading
2717 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002718 - For Unix and Win32, if a directory ends in two path separators "//",
2719 the swap file name will be built from the complete path to the file
2720 with all path separators substituted to percent '%' signs. This will
2721 ensure file name uniqueness in the preserve directory.
2722 On Win32, it is also possible to end with "\\". However, When a
2723 separating comma is following, you must use "//", since "\\" will
2724 include the comma in the file name. Therefore it is recommended to
2725 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002726 - Spaces after the comma are ignored, other spaces are considered part
2727 of the directory name. To have a space at the start of a directory
2728 name, precede it with a backslash.
2729 - To include a comma in a directory name precede it with a backslash.
2730 - A directory name may end in an ':' or '/'.
2731 - Environment variables are expanded |:set_env|.
2732 - Careful with '\' characters, type one before a space, type two to
2733 get one in the option (see |option-backslash|), for example: >
2734 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2735< - For backwards compatibility with Vim version 3.0 a '>' at the start
2736 of the option is removed.
2737 Using "." first in the list is recommended. This means that editing
2738 the same file twice will result in a warning. Using "/tmp" on Unix is
2739 discouraged: When the system crashes you lose the swap file.
2740 "/var/tmp" is often not cleared when rebooting, thus is a better
2741 choice than "/tmp". But it can contain a lot of files, your swap
2742 files get lost in the crowd. That is why a "tmp" directory in your
2743 home directory is tried first.
2744 The use of |:set+=| and |:set-=| is preferred when adding or removing
2745 directories from the list. This avoids problems when a future version
2746 uses another default.
2747 This option cannot be set from a |modeline| or in the |sandbox|, for
2748 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002749
2750 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002751'display' 'dy' string (default "", set to "truncate" in
2752 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002753 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002754 Change the way text is displayed. This is comma separated list of
2755 flags:
2756 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002757 in a window will be displayed. "@@@" is put in the
2758 last columns of the last screen line to indicate the
2759 rest of the line is not displayed.
2760 truncate Like "lastline", but "@@@" is displayed in the first
2761 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002762 uhex Show unprintable characters hexadecimal as <xx>
2763 instead of using ^C and ~C.
2764
Bram Moolenaard0796902016-09-16 20:02:31 +02002765 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002766 doesn't fit is replaced with "@" lines.
2767
Bram Moolenaar071d4272004-06-13 20:20:40 +00002768 *'eadirection'* *'ead'*
2769'eadirection' 'ead' string (default "both")
2770 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002771 Tells when the 'equalalways' option applies:
2772 ver vertically, width of windows is not affected
2773 hor horizontally, height of windows is not affected
2774 both width and height of windows is affected
2775
2776 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2777'edcompatible' 'ed' boolean (default off)
2778 global
2779 Makes the 'g' and 'c' flags of the ":substitute" command to be
2780 toggled each time the flag is given. See |complex-change|. See
2781 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002782 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783
Bram Moolenaar03413f42016-04-12 21:07:15 +02002784 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002785'emoji' 'emo' boolean (default: on)
2786 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002787 When on all Unicode emoji characters are considered to be full width.
2788
2789
Bram Moolenaar071d4272004-06-13 20:20:40 +00002790 *'encoding'* *'enc'* *E543*
2791'encoding' 'enc' string (default: "latin1" or value from $LANG)
2792 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 Sets the character encoding used inside Vim. It applies to text in
2794 the buffers, registers, Strings in expressions, text stored in the
2795 viminfo file, etc. It sets the kind of characters which Vim can work
2796 with. See |encoding-names| for the possible values.
2797
2798 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002799 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002801 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002802
Bram Moolenaar865242e2010-07-14 21:12:05 +02002803 This option cannot be set from a |modeline|. It would most likely
2804 corrupt the text.
2805
Bram Moolenaar3df01732017-02-17 22:47:16 +01002806 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2807 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002808 'encoding', "utf-8" is the natural choice for the environment and
2809 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002810 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 versions, and to avoid changing the encoding of newly created files
2812 without your knowledge (in case 'fileencodings' is empty).
2813
2814 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002815 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002816 iconv() or as specified with 'charconvert'.
2817
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002818 If you need to know whether 'encoding' is a multi-byte encoding, you
2819 can use: >
2820 if has("multi_byte_encoding")
2821<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002822 Normally 'encoding' will be equal to your current locale. This will
2823 be the default if Vim recognizes your environment settings. If
2824 'encoding' is not set to the current locale, 'termencoding' must be
2825 set to convert typed and displayed text. See |encoding-table|.
2826
2827 When you set this option, it fires the |EncodingChanged| autocommand
2828 event so that you can set up fonts if necessary.
2829
2830 When the option is set, the value is converted to lowercase. Thus
2831 you can set it with uppercase values too. Underscores are translated
2832 to '-' signs.
2833 When the encoding is recognized, it is changed to the standard name.
2834 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2835 "iso-8859-2" and "utf8" becomes "utf-8".
2836
2837 Note: "latin1" is also used when the encoding could not be detected.
2838 This only works when editing files in the same encoding! When the
2839 actual character set is not latin1, make sure 'fileencoding' and
2840 'fileencodings' are empty. When conversion is needed, switch to using
2841 utf-8.
2842
2843 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2844 You don't notice this while editing, but it does matter for the
2845 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2846 setting 'encoding' to one of these values instead of utf-8 only has
2847 effect for encoding used for files when 'fileencoding' is empty.
2848
Bram Moolenaar661b1822005-07-28 22:36:45 +00002849 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2850 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002851
2852 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2853'endofline' 'eol' boolean (default on)
2854 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002856 is on, or 'fixeol' option is off, no <EOL> will be written for the
2857 last line in the file. This option is automatically set or reset when
2858 starting to edit a new file, depending on whether file has an <EOL>
2859 for the last line in the file. Normally you don't have to set or
2860 reset this option.
2861 When 'binary' is off and 'fixeol' is on the value is not used when
2862 writing the file. When 'binary' is on or 'fixeol' is off it is used
2863 to remember the presence of a <EOL> for the last line in the file, so
2864 that when you write the file the situation from the original file can
2865 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002866
2867 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2868'equalalways' 'ea' boolean (default on)
2869 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002870 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002871 splitting or closing a window. This also happens the moment the
2872 option is switched on. When off, splitting a window will reduce the
2873 size of the current window and leave the other windows the same. When
2874 closing a window the extra lines are given to the window next to it
2875 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002876 When mixing vertically and horizontally split windows, a minimal size
2877 is computed and some windows may be larger if there is room. The
2878 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002879 Changing the height and width of a window can be avoided by setting
2880 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002881 If a window size is specified when creating a new window sizes are
2882 currently not equalized (it's complicated, but may be implemented in
2883 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002884
2885 *'equalprg'* *'ep'*
2886'equalprg' 'ep' string (default "")
2887 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002888 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002889 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002890 or 'indentexpr'. When Vim was compiled without internal formatting,
2891 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002893 about including spaces and backslashes.
2894 This option cannot be set from a |modeline| or in the |sandbox|, for
2895 security reasons.
2896
2897 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2898'errorbells' 'eb' boolean (default off)
2899 global
2900 Ring the bell (beep or screen flash) for error messages. This only
2901 makes a difference for error messages, the bell will be used always
2902 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002903 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002904 screen flash or do nothing. See 'belloff' to finetune when to ring the
2905 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002906
2907 *'errorfile'* *'ef'*
2908'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2909 others: "errors.err")
2910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002911 {not available when compiled without the |+quickfix|
2912 feature}
2913 Name of the errorfile for the QuickFix mode (see |:cf|).
2914 When the "-q" command-line argument is used, 'errorfile' is set to the
2915 following argument. See |-q|.
2916 NOT used for the ":make" command. See 'makeef' for that.
2917 Environment variables are expanded |:set_env|.
2918 See |option-backslash| about including spaces and backslashes.
2919 This option cannot be set from a |modeline| or in the |sandbox|, for
2920 security reasons.
2921
2922 *'errorformat'* *'efm'*
2923'errorformat' 'efm' string (default is very long)
2924 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002925 {not available when compiled without the |+quickfix|
2926 feature}
2927 Scanf-like description of the format for the lines in the error file
2928 (see |errorformat|).
2929
2930 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2931'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2932 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002933 Function keys that start with an <Esc> are recognized in Insert
2934 mode. When this option is off, the cursor and function keys cannot be
2935 used in Insert mode if they start with an <Esc>. The advantage of
2936 this is that the single <Esc> is recognized immediately, instead of
2937 after one second. Instead of resetting this option, you might want to
2938 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2939 when 'esckeys' is off, you can still map anything, but the cursor keys
2940 won't work by default.
2941 NOTE: This option is set to the Vi default value when 'compatible' is
2942 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaarc8234772019-11-10 21:00:27 +01002943 NOTE: when this option is off then the |modifyOtherKeys| functionality
2944 is disabled while in Insert mode to avoid ending Insert mode with any
2945 key that has a modifier.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002946
2947 *'eventignore'* *'ei'*
2948'eventignore' 'ei' string (default "")
2949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002950 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002951 When set to "all" or when "all" is one of the items, all autocommand
2952 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002953 Otherwise this is a comma separated list of event names. Example: >
2954 :set ei=WinEnter,WinLeave
2955<
2956 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2957'expandtab' 'et' boolean (default off)
2958 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002959 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002960 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002961 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2962 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002963 This option is reset when the 'paste' option is set and restored when
2964 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002965 NOTE: This option is reset when 'compatible' is set.
2966
2967 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2968'exrc' 'ex' boolean (default off)
2969 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002970 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002971 directory.
2972
2973 Setting this option is a potential security leak. E.g., consider
2974 unpacking a package or fetching files from github, a .vimrc in there
2975 might be a trojan horse. BETTER NOT SET THIS OPTION!
2976 Instead, define an autocommand in your .vimrc to set options for a
2977 matching directory.
2978
2979 If you do switch this option on you should also consider setting the
2980 'secure' option (see |initialization|).
2981 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 This option cannot be set from a |modeline| or in the |sandbox|, for
2983 security reasons.
2984
2985 *'fileencoding'* *'fenc'* *E213*
2986'fileencoding' 'fenc' string (default: "")
2987 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002988 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002989
Bram Moolenaar071d4272004-06-13 20:20:40 +00002990 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002991 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002992 When 'fileencoding' is empty, the same value as 'encoding' will be
2993 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002994 No error will be given when the value is set, only when it is used,
2995 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002996 Conversion will also be done when 'encoding' and 'fileencoding' are
2997 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2998 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003000 'encoding' is "utf-8" or another Unicode encoding, conversion
3001 is most likely done in a way that the reverse conversion
3002 results in the same text. When 'encoding' is not "utf-8" some
3003 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 See 'encoding' for the possible values. Additionally, values may be
3006 specified that can be handled by the converter, see
3007 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003008
Bram Moolenaar071d4272004-06-13 20:20:40 +00003009 When reading a file 'fileencoding' will be set from 'fileencodings'.
3010 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003011 'fileencoding', use the |++enc| argument. One exception: when
3012 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003013 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003014
Bram Moolenaar071d4272004-06-13 20:20:40 +00003015 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3016 When the option is set, the value is converted to lowercase. Thus
3017 you can set it with uppercase values too. '_' characters are
3018 replaced with '-'. If a name is recognized from the list for
3019 'encoding', it is replaced by the standard name. For example
3020 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003021
Bram Moolenaar071d4272004-06-13 20:20:40 +00003022 When this option is set, after starting to edit a file, the 'modified'
3023 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003024
3025 Keep in mind that changing 'fenc' from a modeline happens
3026 AFTER the text has been read, thus it applies to when the file will be
3027 written. If you do set 'fenc' in a modeline, you might want to set
3028 'nomodified' to avoid not being able to ":q".
3029
Bram Moolenaar071d4272004-06-13 20:20:40 +00003030 This option can not be changed when 'modifiable' is off.
3031
3032 *'fe'*
3033 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003034 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003035 old short name was 'fe', which is no longer used.
3036
3037 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003038'fileencodings' 'fencs' string (default: "ucs-bom",
3039 "ucs-bom,utf-8,default,latin1" when
3040 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003042 This is a list of character encodings considered when starting to edit
3043 an existing file. When a file is read, Vim tries to use the first
3044 mentioned character encoding. If an error is detected, the next one
3045 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003046 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003047 an empty string, which means the value of 'encoding' is used.
3048 WARNING: Conversion can cause loss of information! When
3049 'encoding' is "utf-8" (or one of the other Unicode variants)
3050 conversion is most likely done in a way that the reverse
3051 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003052 "utf-8" some non-ASCII characters may be lost! You can use
3053 the |++bad| argument to specify what is done with characters
3054 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003055 For an empty file or a file with only ASCII characters most encodings
3056 will work and the first entry of 'fileencodings' will be used (except
3057 "ucs-bom", which requires the BOM to be present). If you prefer
3058 another encoding use an BufReadPost autocommand event to test if your
3059 preferred encoding is to be used. Example: >
3060 au BufReadPost * if search('\S', 'w') == 0 |
3061 \ set fenc=iso-2022-jp | endif
3062< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3063 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003064 When the |++enc| argument is used then the value of 'fileencodings' is
3065 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003066 Note that 'fileencodings' is not used for a new file, the global value
3067 of 'fileencoding' is used instead. You can set it with: >
3068 :setglobal fenc=iso-8859-2
3069< This means that a non-existing file may get a different encoding than
3070 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003071 The special value "ucs-bom" can be used to check for a Unicode BOM
3072 (Byte Order Mark) at the start of the file. It must not be preceded
3073 by "utf-8" or another Unicode encoding for this to work properly.
3074 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3075 because Vim cannot detect an error, thus the encoding is always
3076 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003077 The special value "default" can be used for the encoding from the
3078 environment. This is the default value for 'encoding'. It is useful
3079 when 'encoding' is set to "utf-8" and your environment uses a
3080 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003081 When 'encoding' is "utf-8" and a file contains an illegal byte
3082 sequence it won't be recognized as UTF-8. You can use the |8g8|
3083 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 WRONG VALUES: WHAT'S WRONG:
3085 latin1,utf-8 "latin1" will always be used
3086 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3087 file
3088 cp1250,latin1 "cp1250" will always be used
3089 If 'fileencodings' is empty, 'fileencoding' is not modified.
3090 See 'fileencoding' for the possible values.
3091 Setting this option does not have an effect until the next time a file
3092 is read.
3093
3094 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003095'fileformat' 'ff' string (MS-Windows default: "dos",
3096 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003097 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 This gives the <EOL> of the current buffer, which is used for
3099 reading/writing the buffer from/to a file:
3100 dos <CR> <NL>
3101 unix <NL>
3102 mac <CR>
3103 When "dos" is used, CTRL-Z at the end of a file is ignored.
3104 See |file-formats| and |file-read|.
3105 For the character encoding of the file see 'fileencoding'.
3106 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003107 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003108 This option is set automatically when starting to edit a file and
3109 'fileformats' is not empty and 'binary' is off.
3110 When this option is set, after starting to edit a file, the 'modified'
3111 option is set, because the file would be different when written.
3112 This option can not be changed when 'modifiable' is off.
3113 For backwards compatibility: When this option is set to "dos",
3114 'textmode' is set, otherwise 'textmode' is reset.
3115
3116 *'fileformats'* *'ffs'*
3117'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003118 Vim+Vi MS-Windows: "dos,unix",
3119 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 Vi Cygwin: "unix,dos",
3121 Vi others: "")
3122 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003123 This gives the end-of-line (<EOL>) formats that will be tried when
3124 starting to edit a new buffer and when reading a file into an existing
3125 buffer:
3126 - When empty, the format defined with 'fileformat' will be used
3127 always. It is not set automatically.
3128 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003129 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003130 'fileformats' name will be used when a file is read into an existing
3131 buffer, no matter what 'fileformat' for that buffer is set to.
3132 - When more than one name is present, separated by commas, automatic
3133 <EOL> detection will be done when reading a file. When starting to
3134 edit a file, a check is done for the <EOL>:
3135 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3136 'fileformat' is set to "dos".
3137 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003138 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003139 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003140 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3141 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003142 This means that "mac" is only chosen when:
3143 "unix" is not present or no <NL> is found in the file, and
3144 "dos" is not present or no <CR><NL> is found in the file.
3145 Except: if "unix" was chosen, but there is a <CR> before
3146 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003147 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 4. If 'fileformat' is still not set, the first name from
3149 'fileformats' is used.
3150 When reading a file into an existing buffer, the same is done, but
3151 this happens like 'fileformat' has been set appropriately for that
3152 file only, the option is not changed.
3153 When 'binary' is set, the value of 'fileformats' is not used.
3154
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003155 When Vim starts up with an empty buffer the first item is used. You
3156 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003157
Bram Moolenaar071d4272004-06-13 20:20:40 +00003158 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3159 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3160 done:
3161 - When 'fileformats' is empty, there is no automatic detection. Dos
3162 format will be used.
3163 - When 'fileformats' is set to one or more names, automatic detection
3164 is done. This is based on the first <NL> in the file: If there is a
3165 <CR> in front of it, Dos format is used, otherwise Unix format is
3166 used.
3167 Also see |file-formats|.
3168 For backwards compatibility: When this option is set to an empty
3169 string or one format (no comma is included), 'textauto' is reset,
3170 otherwise 'textauto' is set.
3171 NOTE: This option is set to the Vi default value when 'compatible' is
3172 set and to the Vim default value when 'compatible' is reset.
3173
Bram Moolenaarbf884932013-04-05 22:26:15 +02003174 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3175'fileignorecase' 'fic' boolean (default on for systems where case in file
3176 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003177 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003178 When set case is ignored when using file names and directories.
3179 See 'wildignorecase' for only ignoring case when doing completion.
3180
Bram Moolenaar071d4272004-06-13 20:20:40 +00003181 *'filetype'* *'ft'*
3182'filetype' 'ft' string (default: "")
3183 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003184 When this option is set, the FileType autocommand event is triggered.
3185 All autocommands that match with the value of this option will be
3186 executed. Thus the value of 'filetype' is used in place of the file
3187 name.
3188 Otherwise this option does not always reflect the current file type.
3189 This option is normally set when the file type is detected. To enable
3190 this use the ":filetype on" command. |:filetype|
3191 Setting this option to a different value is most useful in a modeline,
3192 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003193 Example, for in an IDL file:
3194 /* vim: set filetype=idl : */ ~
3195 |FileType| |filetypes|
3196 When a dot appears in the value then this separates two filetype
3197 names. Example:
3198 /* vim: set filetype=c.doxygen : */ ~
3199 This will use the "c" filetype first, then the "doxygen" filetype.
3200 This works both for filetype plugins and for syntax files. More than
3201 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003202 This option is not copied to another buffer, independent of the 's' or
3203 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003204 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003205
3206 *'fillchars'* *'fcs'*
3207'fillchars' 'fcs' string (default "vert:|,fold:-")
3208 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003209 {not available when compiled without the |+folding|
3210 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003211 Characters to fill the statuslines and vertical separators.
3212 It is a comma separated list of items:
3213
3214 item default Used for ~
3215 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003216 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217 vert:c '|' vertical separators |:vsplit|
3218 fold:c '-' filling 'foldtext'
3219 diff:c '-' deleted lines of the 'diff' option
3220
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003221 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003222 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003223 otherwise.
3224
3225 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003226 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003227< This is similar to the default, except that these characters will also
3228 be used when there is highlighting.
3229
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003230 for "stl" and "stlnc" only single-byte values are supported.
3231
Bram Moolenaar071d4272004-06-13 20:20:40 +00003232 The highlighting used for these items:
3233 item highlight group ~
3234 stl:c StatusLine |hl-StatusLine|
3235 stlnc:c StatusLineNC |hl-StatusLineNC|
3236 vert:c VertSplit |hl-VertSplit|
3237 fold:c Folded |hl-Folded|
3238 diff:c DiffDelete |hl-DiffDelete|
3239
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003240 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3241'fixendofline' 'fixeol' boolean (default on)
3242 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003243 When writing a file and this option is on, <EOL> at the end of file
3244 will be restored if missing. Turn this option off if you want to
3245 preserve the situation from the original file.
3246 When the 'binary' option is set the value of this option doesn't
3247 matter.
3248 See the 'endofline' option.
3249
Bram Moolenaar071d4272004-06-13 20:20:40 +00003250 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3251'fkmap' 'fk' boolean (default off) *E198*
3252 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003253 {only available when compiled with the |+rightleft|
3254 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003255 This option was for using Farsi, which has been removed. See
3256 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003257
3258 *'foldclose'* *'fcl'*
3259'foldclose' 'fcl' string (default "")
3260 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003261 {not available when compiled without the |+folding|
3262 feature}
3263 When set to "all", a fold is closed when the cursor isn't in it and
3264 its level is higher than 'foldlevel'. Useful if you want folds to
3265 automatically close when moving out of them.
3266
3267 *'foldcolumn'* *'fdc'*
3268'foldcolumn' 'fdc' number (default 0)
3269 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {not available when compiled without the |+folding|
3271 feature}
3272 When non-zero, a column with the specified width is shown at the side
3273 of the window which indicates open and closed folds. The maximum
3274 value is 12.
3275 See |folding|.
3276
3277 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3278'foldenable' 'fen' boolean (default on)
3279 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003280 {not available when compiled without the |+folding|
3281 feature}
3282 When off, all folds are open. This option can be used to quickly
3283 switch between showing all text unfolded and viewing the text with
3284 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003285 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003286 'foldenable' is off.
3287 This option is set by commands that create a new fold or close a fold.
3288 See |folding|.
3289
3290 *'foldexpr'* *'fde'*
3291'foldexpr' 'fde' string (default: "0")
3292 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003293 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003294 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003296 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003297
Bram Moolenaar30b65812012-07-12 22:01:11 +02003298 The expression will be evaluated in the |sandbox| if set from a
3299 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003300 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003301 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003302
3303 It is not allowed to change text or jump to another window while
3304 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305
3306 *'foldignore'* *'fdi'*
3307'foldignore' 'fdi' string (default: "#")
3308 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 {not available when compiled without the |+folding|
3310 feature}
3311 Used only when 'foldmethod' is "indent". Lines starting with
3312 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003313 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003314 The default "#" works well for C programs. See |fold-indent|.
3315
3316 *'foldlevel'* *'fdl'*
3317'foldlevel' 'fdl' number (default: 0)
3318 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003319 {not available when compiled without the |+folding|
3320 feature}
3321 Sets the fold level: Folds with a higher level will be closed.
3322 Setting this option to zero will close all folds. Higher numbers will
3323 close fewer folds.
3324 This option is set by commands like |zm|, |zM| and |zR|.
3325 See |fold-foldlevel|.
3326
3327 *'foldlevelstart'* *'fdls'*
3328'foldlevelstart' 'fdls' number (default: -1)
3329 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003330 {not available when compiled without the |+folding|
3331 feature}
3332 Sets 'foldlevel' when starting to edit another buffer in a window.
3333 Useful to always start editing with all folds closed (value zero),
3334 some folds closed (one) or no folds closed (99).
3335 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003336 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003337 ignores this option and closes all folds.
3338 It is also done before BufReadPre autocommands, to allow an autocmd to
3339 overrule the 'foldlevel' value for specific files.
3340 When the value is negative, it is not used.
3341
3342 *'foldmarker'* *'fmr'* *E536*
3343'foldmarker' 'fmr' string (default: "{{{,}}}")
3344 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 {not available when compiled without the |+folding|
3346 feature}
3347 The start and end marker used when 'foldmethod' is "marker". There
3348 must be one comma, which separates the start and end marker. The
3349 marker is a literal string (a regular expression would be too slow).
3350 See |fold-marker|.
3351
3352 *'foldmethod'* *'fdm'*
3353'foldmethod' 'fdm' string (default: "manual")
3354 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003355 {not available when compiled without the |+folding|
3356 feature}
3357 The kind of folding used for the current window. Possible values:
3358 |fold-manual| manual Folds are created manually.
3359 |fold-indent| indent Lines with equal indent form a fold.
3360 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3361 |fold-marker| marker Markers are used to specify folds.
3362 |fold-syntax| syntax Syntax highlighting items specify folds.
3363 |fold-diff| diff Fold text that is not changed.
3364
3365 *'foldminlines'* *'fml'*
3366'foldminlines' 'fml' number (default: 1)
3367 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003368 {not available when compiled without the |+folding|
3369 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003370 Sets the number of screen lines above which a fold can be displayed
3371 closed. Also for manually closed folds. With the default value of
3372 one a fold can only be closed if it takes up two or more screen lines.
3373 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003374 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003375 "zc" to close a fold, which is displayed open because it's smaller
3376 than 'foldminlines', a following "zc" may close a containing fold.
3377
3378 *'foldnestmax'* *'fdn'*
3379'foldnestmax' 'fdn' number (default: 20)
3380 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 {not available when compiled without the |+folding|
3382 feature}
3383 Sets the maximum nesting of folds for the "indent" and "syntax"
3384 methods. This avoids that too many folds will be created. Using more
3385 than 20 doesn't work, because the internal limit is 20.
3386
3387 *'foldopen'* *'fdo'*
3388'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3389 search,tag,undo")
3390 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003391 {not available when compiled without the |+folding|
3392 feature}
3393 Specifies for which type of commands folds will be opened, if the
3394 command moves the cursor into a closed fold. It is a comma separated
3395 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003396 NOTE: When the command is part of a mapping this option is not used.
3397 Add the |zv| command to the mapping to get the same effect.
3398 (rationale: the mapping may want to control opening folds itself)
3399
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 item commands ~
3401 all any
3402 block "(", "{", "[[", "[{", etc.
3403 hor horizontal movements: "l", "w", "fx", etc.
3404 insert any command in Insert mode
3405 jump far jumps: "G", "gg", etc.
3406 mark jumping to a mark: "'m", CTRL-O, etc.
3407 percent "%"
3408 quickfix ":cn", ":crew", ":make", etc.
3409 search search for a pattern: "/", "n", "*", "gd", etc.
3410 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003411 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003412 tag jumping to a tag: ":ta", CTRL-T, etc.
3413 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003414 When a movement command is used for an operator (e.g., "dl" or "y%")
3415 this option is not used. This means the operator will include the
3416 whole closed fold.
3417 Note that vertical movements are not here, because it would make it
3418 very difficult to move onto a closed fold.
3419 In insert mode the folds containing the cursor will always be open
3420 when text is inserted.
3421 To close folds you can re-apply 'foldlevel' with the |zx| command or
3422 set the 'foldclose' option to "all".
3423
3424 *'foldtext'* *'fdt'*
3425'foldtext' 'fdt' string (default: "foldtext()")
3426 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003427 {not available when compiled without the |+folding|
3428 feature}
3429 An expression which is used to specify the text displayed for a closed
3430 fold. See |fold-foldtext|.
3431
Bram Moolenaar30b65812012-07-12 22:01:11 +02003432 The expression will be evaluated in the |sandbox| if set from a
3433 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003434 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003435
3436 It is not allowed to change text or jump to another window while
3437 evaluating 'foldtext' |textlock|.
3438
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003439 *'formatexpr'* *'fex'*
3440'formatexpr' 'fex' string (default "")
3441 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003442 {not available when compiled without the |+eval|
3443 feature}
3444 Expression which is evaluated to format a range of lines for the |gq|
3445 operator or automatic formatting (see 'formatoptions'). When this
3446 option is empty 'formatprg' is used.
3447
3448 The |v:lnum| variable holds the first line to be formatted.
3449 The |v:count| variable holds the number of lines to be formatted.
3450 The |v:char| variable holds the character that is going to be
3451 inserted if the expression is being evaluated due to
3452 automatic formatting. This can be empty. Don't insert
3453 it yet!
3454
3455 Example: >
3456 :set formatexpr=mylang#Format()
3457< This will invoke the mylang#Format() function in the
3458 autoload/mylang.vim file in 'runtimepath'. |autoload|
3459
3460 The expression is also evaluated when 'textwidth' is set and adding
3461 text beyond that limit. This happens under the same conditions as
3462 when internal formatting is used. Make sure the cursor is kept in the
3463 same spot relative to the text then! The |mode()| function will
3464 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003465
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003466 When the expression evaluates to non-zero Vim will fall back to using
3467 the internal format mechanism.
3468
3469 The expression will be evaluated in the |sandbox| when set from a
3470 modeline, see |sandbox-option|. That stops the option from working,
3471 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003472 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003473 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003474
Bram Moolenaar86b68352004-12-27 21:59:20 +00003475 *'formatlistpat'* *'flp'*
3476'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3477 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003478 A pattern that is used to recognize a list header. This is used for
3479 the "n" flag in 'formatoptions'.
3480 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003481 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003482 while still checking more characters. There must be a character
3483 following the pattern, when it matches the whole line it is handled
3484 like there is no match.
3485 The default recognizes a number, followed by an optional punctuation
3486 character and white space.
3487
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003488 *'formatoptions'* *'fo'*
3489'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3490 local to buffer
3491 This is a sequence of letters which describes how automatic
3492 formatting is to be done. See |fo-table|. When the 'paste' option is
3493 on, no formatting is done (like 'formatoptions' is empty). Commas can
3494 be inserted for readability.
3495 To avoid problems with flags that are added in the future, use the
3496 "+=" and "-=" feature of ":set" |add-option-flags|.
3497 NOTE: This option is set to the Vi default value when 'compatible' is
3498 set and to the Vim default value when 'compatible' is reset.
3499
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500 *'formatprg'* *'fp'*
3501'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003502 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003503 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003504 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003505 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003506 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003507 If the 'formatexpr' option is not empty it will be used instead.
3508 Otherwise, if 'formatprg' option is an empty string, the internal
3509 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003510 Environment variables are expanded |:set_env|. See |option-backslash|
3511 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003512 This option cannot be set from a |modeline| or in the |sandbox|, for
3513 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003514
Bram Moolenaard94464e2015-11-02 15:28:18 +01003515 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003516'fsync' 'fs' boolean (default on)
3517 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003518 When on, the library function fsync() will be called after writing a
3519 file. This will flush a file to disk, ensuring that it is safely
3520 written even on filesystems which do metadata-only journaling. This
3521 will force the harddrive to spin up on Linux systems running in laptop
3522 mode, so it may be undesirable in some situations. Be warned that
3523 turning this off increases the chances of data loss after a crash. On
3524 systems without an fsync() implementation, this variable is always
3525 off.
3526 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003527 'fsync' also applies to |writefile()|, unless a flag is used to
3528 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003529 This option cannot be set from a |modeline| or in the |sandbox|, for
3530 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003531
Bram Moolenaar071d4272004-06-13 20:20:40 +00003532 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3533'gdefault' 'gd' boolean (default off)
3534 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535 When on, the ":substitute" flag 'g' is default on. This means that
3536 all matches in a line are substituted instead of one. When a 'g' flag
3537 is given to a ":substitute" command, this will toggle the substitution
3538 of all or one match. See |complex-change|.
3539
3540 command 'gdefault' on 'gdefault' off ~
3541 :s/// subst. all subst. one
3542 :s///g subst. one subst. all
3543 :s///gg subst. all subst. one
3544
3545 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003546 DEPRECATED: Setting this option may break plugins that are not aware
3547 of this option. Also, many users get confused that adding the /g flag
3548 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003549
3550 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003551'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003552 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003553 Format to recognize for the ":grep" command output.
3554 This is a scanf-like string that uses the same format as the
3555 'errorformat' option: see |errorformat|.
3556
3557 *'grepprg'* *'gp'*
3558'grepprg' 'gp' string (default "grep -n ",
3559 Unix: "grep -n $* /dev/null",
3560 Win32: "findstr /n" or "grep -n",
3561 VMS: "SEARCH/NUMBERS ")
3562 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003563 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003564 and '#' characters, which are expanded like when used in a command-
3565 line. The placeholder "$*" is allowed to specify where the arguments
3566 will be included. Environment variables are expanded |:set_env|. See
3567 |option-backslash| about including spaces and backslashes.
3568 When your "grep" accepts the "-H" argument, use this to make ":grep"
3569 also work well with a single file: >
3570 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003571< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003572 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3573 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003574 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003575 apply equally to 'grepprg'.
3576 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3577 otherwise it's "grep -n".
3578 This option cannot be set from a |modeline| or in the |sandbox|, for
3579 security reasons.
3580
3581 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3582'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3583 ve:ver35-Cursor,
3584 o:hor50-Cursor,
3585 i-ci:ver25-Cursor/lCursor,
3586 r-cr:hor20-Cursor/lCursor,
3587 sm:block-Cursor
3588 -blinkwait175-blinkoff150-blinkon175",
3589 for MS-DOS and Win32 console:
3590 "n-v-c:block,o:hor50,i-ci:hor15,
3591 r-cr:hor30,sm:block")
3592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003593 {only available when compiled with GUI enabled, and
3594 for MS-DOS and Win32 console}
3595 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003596 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003597 the height of the cursor can be changed. This can be done by
3598 specifying a block cursor, or a percentage for a vertical or
3599 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003600 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3601 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003602
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003603 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003604 mode-list and an argument-list:
3605 mode-list:argument-list,mode-list:argument-list,..
3606 The mode-list is a dash separated list of these modes:
3607 n Normal mode
3608 v Visual mode
3609 ve Visual mode with 'selection' "exclusive" (same as 'v',
3610 if not specified)
3611 o Operator-pending mode
3612 i Insert mode
3613 r Replace mode
3614 c Command-line Normal (append) mode
3615 ci Command-line Insert mode
3616 cr Command-line Replace mode
3617 sm showmatch in Insert mode
3618 a all modes
3619 The argument-list is a dash separated list of these arguments:
3620 hor{N} horizontal bar, {N} percent of the character height
3621 ver{N} vertical bar, {N} percent of the character width
3622 block block cursor, fills the whole character
3623 [only one of the above three should be present]
3624 blinkwait{N} *cursor-blinking*
3625 blinkon{N}
3626 blinkoff{N}
3627 blink times for cursor: blinkwait is the delay before
3628 the cursor starts blinking, blinkon is the time that
3629 the cursor is shown and blinkoff is the time that the
3630 cursor is not shown. The times are in msec. When one
3631 of the numbers is zero, there is no blinking. The
3632 default is: "blinkwait700-blinkon400-blinkoff250".
3633 These numbers are used for a missing entry. This
3634 means that blinking is enabled by default. To switch
3635 blinking off you can use "blinkon0". The cursor only
3636 blinks when Vim is waiting for input, not while
3637 executing a command.
3638 To make the cursor blink in an xterm, see
3639 |xterm-blink|.
3640 {group-name}
3641 a highlight group name, that sets the color and font
3642 for the cursor
3643 {group-name}/{group-name}
3644 Two highlight group names, the first is used when
3645 no language mappings are used, the other when they
3646 are. |language-mapping|
3647
3648 Examples of parts:
3649 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3650 block cursor with colors from the "nCursor"
3651 highlight group
3652 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3653 In Insert and Command-line Insert mode, use a
3654 30% vertical bar cursor with colors from the
3655 "iCursor" highlight group. Blink a bit
3656 faster.
3657
3658 The 'a' mode is different. It will set the given argument-list for
3659 all modes. It does not reset anything to defaults. This can be used
3660 to do a common setting for all modes. For example, to switch off
3661 blinking: "a:blinkon0"
3662
3663 Examples of cursor highlighting: >
3664 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3665 :highlight Cursor gui=NONE guifg=bg guibg=fg
3666<
3667 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003668 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669'guifont' 'gfn' string (default "")
3670 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003671 {only available when compiled with GUI enabled}
3672 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003673 In its simplest form the value is just one font name.
3674 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003675
3676 *'guifontset'* *'gfs'*
3677 *E250* *E252* *E234* *E597* *E598*
3678'guifontset' 'gfs' string (default "")
3679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 {only available when compiled with GUI enabled and
3681 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003682 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003683 When not empty, specifies two (or more) fonts to be used. The first
3684 one for normal English, the second one for your special language. See
3685 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003686
Bram Moolenaar071d4272004-06-13 20:20:40 +00003687 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3688'guifontwide' 'gfw' string (default "")
3689 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003690 {only available when compiled with GUI enabled}
3691 When not empty, specifies a comma-separated list of fonts to be used
3692 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003693 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003694
Bram Moolenaar071d4272004-06-13 20:20:40 +00003695 *'guiheadroom'* *'ghr'*
3696'guiheadroom' 'ghr' number (default 50)
3697 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003698 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 The number of pixels subtracted from the screen height when fitting
3700 the GUI window on the screen. Set this before the GUI is started,
3701 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003702 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 lines will be left for window decorations and other items on the
3704 screen. Set it to a negative value to allow windows taller than the
3705 screen.
3706
3707 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003708'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3709 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003710 "aegimrLtT" (GTK, Motif and Athena),
3711 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003713 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003714 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 sequence of letters which describes what components and options of the
3716 GUI should be used.
3717 To avoid problems with flags that are added in the future, use the
3718 "+=" and "-=" feature of ":set" |add-option-flags|.
3719
Bram Moolenaar13568252018-03-16 20:46:58 +01003720 Valid characters are as follows:
3721 *'go-!'*
3722 '!' External commands are executed in a terminal window. Without
3723 this flag the MS-Windows GUI will open a console window to
3724 execute the command. The Unix GUI will simulate a dumb
3725 terminal to list the command output.
3726 The terminal window will be positioned at the bottom, and grow
3727 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003728 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003729 'a' Autoselect: If present, then whenever VISUAL mode is started,
3730 or the Visual area extended, Vim tries to become the owner of
3731 the windowing system's global selection. This means that the
3732 Visually highlighted text is available for pasting into other
3733 applications as well as into Vim itself. When the Visual mode
3734 ends, possibly due to an operation on the text, or when an
3735 application wants to paste the selection, the highlighted text
3736 is automatically yanked into the "* selection register.
3737 Thus the selection is still available for pasting into other
3738 applications after the VISUAL mode has ended.
3739 If not present, then Vim won't become the owner of the
3740 windowing system's global selection unless explicitly told to
3741 by a yank or delete operation for the "* register.
3742 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003743 *'go-P'*
3744 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003745 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003746 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003747 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003748 applies to the modeless selection.
3749
3750 'guioptions' autoselect Visual autoselect modeless ~
3751 "" - -
3752 "a" yes yes
3753 "A" - yes
3754 "aA" yes yes
3755
Bram Moolenaar02467872007-05-06 13:22:01 +00003756 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003757 'c' Use console dialogs instead of popup dialogs for simple
3758 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003759 *'go-d'*
3760 'd' Use dark theme variant if available. Currently only works for
3761 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003762 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003763 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003764 'guitablabel' can be used to change the text in the labels.
3765 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003766 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003767 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003768 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003769 'f' Foreground: Don't use fork() to detach the GUI from the shell
3770 where it was started. Use this for programs that wait for the
3771 editor to finish (e.g., an e-mail program). Alternatively you
3772 can use "gvim -f" or ":gui -f" to start the GUI in the
3773 foreground. |gui-fork|
3774 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003775 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003776 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003777 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3778 corner of the window. It's black&white on non-GTK, because of
3779 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003780 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003781 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003782 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003783 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003784 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003785 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003786 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003787 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003788 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 'g' Grey menu items: Make menu items that are not active grey. If
3790 'g' is not included inactive menu items are not shown at all.
3791 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003792 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003793 't' Include tearoff menu items. Currently only works for Win32,
3794 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003795 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003796 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003797 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003798 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003800 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003801 'R' Right-hand scrollbar is present when there is a vertically
3802 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003803 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003804 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'L' Left-hand scrollbar is present when there is a vertically
3807 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003808 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003809 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3810 the longest visible line, or on the cursor line if the 'h'
3811 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003812 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003813 'h' Limit horizontal scrollbar size to the length of the cursor
3814 line. Reduces computations. |gui-horiz-scroll|
3815
3816 And yes, you may even have scrollbars on the left AND the right if
3817 you really want to :-). See |gui-scrollbars| for more information.
3818
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003819 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003820 'v' Use a vertical button layout for dialogs. When not included,
3821 a horizontal layout is preferred, but when it doesn't fit a
3822 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003823 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003824 'p' Use Pointer callbacks for X11 GUI. This is required for some
3825 window managers. If the cursor is not blinking or hollow at
3826 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003827 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003829 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003830 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003831 *'go-k'*
3832 'k' Keep the GUI window size when adding/removing a scrollbar, or
3833 toolbar, tabline, etc. Instead, the behavior is similar to
3834 when the window is maximized and will adjust 'lines' and
3835 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003836 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003837 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003838
Bram Moolenaar071d4272004-06-13 20:20:40 +00003839 *'guipty'* *'noguipty'*
3840'guipty' boolean (default on)
3841 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003842 {only available when compiled with GUI enabled}
3843 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3844 I/O to/from shell commands. See |gui-pty|.
3845
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003846 *'guitablabel'* *'gtl'*
3847'guitablabel' 'gtl' string (default empty)
3848 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003849 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003851 pages line. When empty and when the result is empty Vim will use a
3852 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003853
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003854 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003855 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003856 The expression will be evaluated in the |sandbox| when set from a
3857 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003858 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003859
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003860 Only used when the GUI tab pages line is displayed. 'e' must be
3861 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3862 used.
3863
Bram Moolenaar57657d82006-04-21 22:12:41 +00003864 *'guitabtooltip'* *'gtt'*
3865'guitabtooltip' 'gtt' string (default empty)
3866 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003867 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003868 When nonempty describes the text to use in a tooltip for the GUI tab
3869 pages line. When empty Vim will use a default tooltip.
3870 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003871 You can include a line break. Simplest method is to use |:let|: >
3872 :let &guitabtooltip = "line one\nline two"
3873<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003874
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 *'helpfile'* *'hf'*
3876'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3877 (others) "$VIMRUNTIME/doc/help.txt")
3878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003879 Name of the main help file. All distributed help files should be
3880 placed together in one directory. Additionally, all "doc" directories
3881 in 'runtimepath' will be used.
3882 Environment variables are expanded |:set_env|. For example:
3883 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003884 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003885 spaces and backslashes.
3886 This option cannot be set from a |modeline| or in the |sandbox|, for
3887 security reasons.
3888
3889 *'helpheight'* *'hh'*
3890'helpheight' 'hh' number (default 20)
3891 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003892 Minimal initial height of the help window when it is opened with the
3893 ":help" command. The initial height of the help window is half of the
3894 current window, or (when the 'ea' option is on) the same as other
3895 windows. When the height is less than 'helpheight', the height is
3896 set to 'helpheight'. Set to zero to disable.
3897
3898 *'helplang'* *'hlg'*
3899'helplang' 'hlg' string (default: messages language or empty)
3900 global
3901 {only available when compiled with the |+multi_lang|
3902 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003903 Comma separated list of languages. Vim will use the first language
3904 for which the desired help can be found. The English help will always
3905 be used as a last resort. You can add "en" to prefer English over
3906 another language, but that will only find tags that exist in that
3907 language and not in the English help.
3908 Example: >
3909 :set helplang=de,it
3910< This will first search German, then Italian and finally English help
3911 files.
3912 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3913 try to find the tag in the current language before using this option.
3914 See |help-translated|.
3915
3916 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3917'hidden' 'hid' boolean (default off)
3918 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003919 When off a buffer is unloaded when it is |abandon|ed. When on a
3920 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3921 displayed in another window, it does not become hidden, of course.
3922 The commands that move through the buffer list sometimes make a buffer
3923 hidden although the 'hidden' option is off: When the buffer is
3924 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003925 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003926 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003927 This option is set for one command with ":hide {command}" |:hide|.
3928 WARNING: It's easy to forget that you have changes in hidden buffers.
3929 Think twice when using ":q!" or ":qa!".
3930
3931 *'highlight'* *'hl'*
3932'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003933 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3934 d:Directory,e:ErrorMsg,i:IncSearch,
3935 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003936 a:LineNrAbove,b:LineNrBelow,
Bram Moolenaar58b85342016-08-14 19:54:54 +02003937 N:CursorLineNr,r:Question,s:StatusLine,
3938 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003939 v:Visual,V:VisualNOS,w:WarningMsg,
3940 W:WildMenu,f:Folded,F:FoldColumn,
3941 A:DiffAdd,C:DiffChange,D:DiffDelete,
3942 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003943 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003944 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003945 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3946 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003947 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003948 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003949 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003950 This option can be used to set highlighting mode for various
3951 occasions. It is a comma separated list of character pairs. The
3952 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003953 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003954 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003955 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3956 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003957 characters from 'showbreak'
3958 |hl-Directory| d directories in CTRL-D listing and other special
3959 things in listings
3960 |hl-ErrorMsg| e error messages
3961 h (obsolete, ignored)
3962 |hl-IncSearch| i 'incsearch' highlighting
3963 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3964 |hl-MoreMsg| m |more-prompt|
3965 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003966 |hl-LineNr| n line number for ":number" and ":#" commands, and
3967 when 'number' or 'relativenumber' option is set.
Bram Moolenaarefae76a2019-10-27 22:54:58 +01003968 |hl-LineNrAbove| a line number above the cursor for when the
3969 'relativenumber' option is set.
3970 |hl-LineNrBelow| b line number below the cursor for when the
3971 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003972 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3973 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003974 |hl-Question| r |hit-enter| prompt and yes/no questions
3975 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003976 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003977 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3978 |hl-VertSplit| c column used to separate vertically split windows
3979 |hl-Visual| v Visual mode
3980 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3981 Selection" Only X11 Gui's |gui-x11| and
3982 |xterm-clipboard|.
3983 |hl-WarningMsg| w warning messages
3984 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3985 |hl-Folded| f line used for closed folds
3986 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003987 |hl-DiffAdd| A added line in diff mode
3988 |hl-DiffChange| C changed line in diff mode
3989 |hl-DiffDelete| D deleted line in diff mode
3990 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003991 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003992 |hl-Conceal| - the placeholders used for concealed characters
3993 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003994 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003995 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003996 |hl-SpellRare| R rare word |spell|
3997 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003998 |hl-Pmenu| + popup menu normal line
3999 |hl-PmenuSel| = popup menu selected line
4000 |hl-PmenuSbar| x popup menu scrollbar
4001 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00004002
4003 The display modes are:
4004 r reverse (termcap entry "mr" and "me")
4005 i italic (termcap entry "ZH" and "ZR")
4006 b bold (termcap entry "md" and "me")
4007 s standout (termcap entry "so" and "se")
4008 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00004009 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02004010 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 n no highlighting
4012 - no highlighting
4013 : use a highlight group
4014 The default is used for occasions that are not included.
4015 If you want to change what the display modes do, see |dos-colors|
4016 for an example.
4017 When using the ':' display mode, this must be followed by the name of
4018 a highlight group. A highlight group can be used to define any type
4019 of highlighting, including using color. See |:highlight| on how to
4020 define one. The default uses a different group for each occasion.
4021 See |highlight-default| for the default highlight groups.
4022
Bram Moolenaar071d4272004-06-13 20:20:40 +00004023 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004024'history' 'hi' number (Vim default: 50, Vi default: 0,
4025 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004026 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004027 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004028 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004029 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004030 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004031 NOTE: This option is set to the Vi default value when 'compatible' is
4032 set and to the Vim default value when 'compatible' is reset.
4033
4034 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4035'hkmap' 'hk' boolean (default off)
4036 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004037 {only available when compiled with the |+rightleft|
4038 feature}
4039 When on, the keyboard is mapped for the Hebrew character set.
4040 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4041 toggle this option. See |rileft.txt|.
4042 NOTE: This option is reset when 'compatible' is set.
4043
4044 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4045'hkmapp' 'hkp' boolean (default off)
4046 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004047 {only available when compiled with the |+rightleft|
4048 feature}
4049 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4050 This is useful if you have a non-Hebrew keyboard.
4051 See |rileft.txt|.
4052 NOTE: This option is reset when 'compatible' is set.
4053
Bram Moolenaar036986f2017-03-16 17:41:02 +01004054 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4055'hlsearch' 'hls' boolean (default off)
4056 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004057 {not available when compiled without the
4058 |+extra_search| feature}
4059 When there is a previous search pattern, highlight all its matches.
4060 The type of highlighting used can be set with the 'l' occasion in the
4061 'highlight' option. This uses the "Search" highlight group by
4062 default. Note that only the matching text is highlighted, any offsets
4063 are not applied.
4064 See also: 'incsearch' and |:match|.
4065 When you get bored looking at the highlighted matches, you can turn it
4066 off with |:nohlsearch|. This does not change the option value, as
4067 soon as you use a search command, the highlighting comes back.
4068 'redrawtime' specifies the maximum time spent on finding matches.
4069 When the search pattern can match an end-of-line, Vim will try to
4070 highlight all of the matched text. However, this depends on where the
4071 search starts. This will be the first line in the window or the first
4072 line below a closed fold. A match in a previous line which is not
4073 drawn may not continue in a newly drawn line.
4074 You can specify whether the highlight status is restored on startup
4075 with the 'h' flag in 'viminfo' |viminfo-h|.
4076 NOTE: This option is reset when 'compatible' is set.
4077
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 *'icon'* *'noicon'*
4079'icon' boolean (default off, on when title can be restored)
4080 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004081 {not available when compiled without the |+title|
4082 feature}
4083 When on, the icon text of the window will be set to the value of
4084 'iconstring' (if it is not empty), or to the name of the file
4085 currently being edited. Only the last part of the name is used.
4086 Overridden by the 'iconstring' option.
4087 Only works if the terminal supports setting window icons (currently
4088 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4089 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4090 builtin termcap).
4091 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004092 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004094 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095
4096 *'iconstring'*
4097'iconstring' string (default "")
4098 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004099 {not available when compiled without the |+title|
4100 feature}
4101 When this option is not empty, it will be used for the icon text of
4102 the window. This happens only when the 'icon' option is on.
4103 Only works if the terminal supports setting window icon text
4104 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4105 Does not work for MS Windows.
4106 When Vim was compiled with HAVE_X11 defined, the original icon will be
4107 restored if possible |X11|.
4108 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004109 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004110 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004111 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004112 {not available when compiled without the |+statusline| feature}
4113
4114 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4115'ignorecase' 'ic' boolean (default off)
4116 global
4117 Ignore case in search patterns. Also used when searching in the tags
4118 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004119 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004120 Can be overruled by using "\c" or "\C" in the pattern, see
4121 |/ignorecase|.
4122
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004123 *'imactivatefunc'* *'imaf'*
4124'imactivatefunc' 'imaf' string (default "")
4125 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004126 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004127 activate or deactivate the Input Method.
4128 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004129 The expression will be evaluated in the |sandbox| when set from a
4130 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004131
4132 Example: >
4133 function ImActivateFunc(active)
4134 if a:active
4135 ... do something
4136 else
4137 ... do something
4138 endif
4139 " return value is not used
4140 endfunction
4141 set imactivatefunc=ImActivateFunc
4142<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004143 *'imactivatekey'* *'imak'*
4144'imactivatekey' 'imak' string (default "")
4145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004146 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004147 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004148 Specifies the key that your Input Method in X-Windows uses for
4149 activation. When this is specified correctly, vim can fully control
4150 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4151 You can't use this option to change the activation key, the option
4152 tells Vim what the key is.
4153 Format:
4154 [MODIFIER_FLAG-]KEY_STRING
4155
4156 These characters can be used for MODIFIER_FLAG (case is ignored):
4157 S Shift key
4158 L Lock key
4159 C Control key
4160 1 Mod1 key
4161 2 Mod2 key
4162 3 Mod3 key
4163 4 Mod4 key
4164 5 Mod5 key
4165 Combinations are allowed, for example "S-C-space" or "SC-space" are
4166 both shift+ctrl+space.
4167 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4168
4169 Example: >
4170 :set imactivatekey=S-space
4171< "S-space" means shift+space. This is the activation key for kinput2 +
4172 canna (Japanese), and ami (Korean).
4173
4174 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4175'imcmdline' 'imc' boolean (default off)
4176 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004177 When set the Input Method is always on when starting to edit a command
4178 line, unless entering a search pattern (see 'imsearch' for that).
4179 Setting this option is useful when your input method allows entering
4180 English characters directly, e.g., when it's used to type accented
4181 characters with dead keys.
4182
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004183 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004186 When set the Input Method is never used. This is useful to disable
4187 the IM when it doesn't work properly.
4188 Currently this option is on by default for SGI/IRIX machines. This
4189 may change in later releases.
4190
4191 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004192'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004193 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004194 Specifies whether :lmap or an Input Method (IM) is to be used in
4195 Insert mode. Valid values:
4196 0 :lmap is off and IM is off
4197 1 :lmap is ON and IM is off
4198 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 To always reset the option to zero when leaving Insert mode with <Esc>
4200 this can be used: >
4201 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4202< This makes :lmap and IM turn off automatically when leaving Insert
4203 mode.
4204 Note that this option changes when using CTRL-^ in Insert mode
4205 |i_CTRL-^|.
4206 The value is set to 1 when setting 'keymap' to a valid keymap name.
4207 It is also used for the argument of commands like "r" and "f".
4208 The value 0 may not work correctly with Athena and Motif with some XIM
4209 methods. Use 'imdisable' to disable XIM then.
4210
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004211 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004212 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004213 |+multi_byte_ime| or |global-ime|.
4214
Bram Moolenaar071d4272004-06-13 20:20:40 +00004215 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004216'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004217 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004218 Specifies whether :lmap or an Input Method (IM) is to be used when
4219 entering a search pattern. Valid values:
4220 -1 the value of 'iminsert' is used, makes it look like
4221 'iminsert' is also used when typing a search pattern
4222 0 :lmap is off and IM is off
4223 1 :lmap is ON and IM is off
4224 2 :lmap is off and IM is ON
4225 Note that this option changes when using CTRL-^ in Command-line mode
4226 |c_CTRL-^|.
4227 The value is set to 1 when it is not -1 and setting the 'keymap'
4228 option to a valid keymap name.
4229 The value 0 may not work correctly with Athena and Motif with some XIM
4230 methods. Use 'imdisable' to disable XIM then.
4231
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004232 *'imstatusfunc'* *'imsf'*
4233'imstatusfunc' 'imsf' string (default "")
4234 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004235 This option specifies a function that is called to obtain the status
4236 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004237 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004238
4239 Example: >
4240 function ImStatusFunc()
4241 let is_active = ...do something
4242 return is_active ? 1 : 0
4243 endfunction
4244 set imstatusfunc=ImStatusFunc
4245<
4246 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004247 The expression will be evaluated in the |sandbox| when set from a
4248 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004249
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004250 *'imstyle'* *'imst'*
4251'imstyle' 'imst' number (default 1)
4252 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004253 {only available when compiled with |+xim| and
4254 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004255 This option specifies the input style of Input Method:
4256 0 use on-the-spot style
4257 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004258 See: |xim-input-style|
4259
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004260 For a long time on-the-spot style had been used in the GTK version of
4261 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004262 |single-repeat|, etc. Therefore over-the-spot style becomes the
4263 default now. This should work fine for most people, however if you
4264 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004265 The expression will be evaluated in the |sandbox| when set from a
4266 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004267
Bram Moolenaar071d4272004-06-13 20:20:40 +00004268 *'include'* *'inc'*
4269'include' 'inc' string (default "^\s*#\s*include")
4270 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 {not available when compiled without the
4272 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004273 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004274 pattern, just like for the "/" command (See |pattern|). The default
4275 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004276 "]I", "[d", etc.
4277 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004278 comes after the matched pattern. But if "\zs" appears in the pattern
4279 then the text matched from "\zs" to the end, or until "\ze" if it
4280 appears, is used as the file name. Use this to include characters
4281 that are not in 'isfname', such as a space. You can then use
4282 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004283 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004284
4285 *'includeexpr'* *'inex'*
4286'includeexpr' 'inex' string (default "")
4287 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004288 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004289 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004291 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004292 :set includeexpr=substitute(v:fname,'\\.','/','g')
4293< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004294
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004296 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004297 Also used for |<cfile>|.
4298
Bram Moolenaar30b65812012-07-12 22:01:11 +02004299 The expression will be evaluated in the |sandbox| when set from a
4300 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004301 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004302
4303 It is not allowed to change text or jump to another window while
4304 evaluating 'includeexpr' |textlock|.
4305
Bram Moolenaar071d4272004-06-13 20:20:40 +00004306 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004307'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4308 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004309 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004310 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004311 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004312 While typing a search command, show where the pattern, as it was typed
4313 so far, matches. The matched string is highlighted. If the pattern
4314 is invalid or not found, nothing is shown. The screen will be updated
4315 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004316 Also applies to the pattern in commands: >
4317 :global
4318 :lvimgrep
4319 :lvimgrepadd
4320 :smagic
4321 :snomagic
4322 :sort
4323 :substitute
4324 :vglobal
4325 :vimgrep
4326 :vimgrepadd
4327< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004328 original position when no match is found and when pressing <Esc>. You
4329 still need to finish the search command with <Enter> to move the
4330 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004331 You can use the CTRL-G and CTRL-T keys to move to the next and
4332 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004333 When compiled with the |+reltime| feature Vim only searches for about
4334 half a second. With a complicated pattern and/or a lot of text the
4335 match may not be found. This is to avoid that Vim hangs while you
4336 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004337 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004338 When 'hlsearch' is on, all matched strings are highlighted too while
4339 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004340 If you don't want to turn 'hlsearch' on, but want to highlight all
4341 matches while searching, you can turn on and off 'hlsearch' with
4342 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004343 augroup vimrc-incsearch-highlight
4344 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004345 autocmd CmdlineEnter /,\? :set hlsearch
4346 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004347 augroup END
4348<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004349 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004350 to the command line. If 'ignorecase' and 'smartcase' are set and the
4351 command line has no uppercase characters, the added character is
4352 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004353 CTRL-R CTRL-W can be used to add the word at the end of the current
4354 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004355 NOTE: This option is reset when 'compatible' is set.
4356
4357 *'indentexpr'* *'inde'*
4358'indentexpr' 'inde' string (default "")
4359 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004360 {not available when compiled without the |+cindent|
4361 or |+eval| features}
4362 Expression which is evaluated to obtain the proper indent for a line.
4363 It is used when a new line is created, for the |=| operator and
4364 in Insert mode as specified with the 'indentkeys' option.
4365 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004366 'smartindent' indenting. When 'lisp' is set, this option is
4367 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004368 When 'paste' is set this option is not used for indenting.
4369 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004370 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371 when the expression is evaluated (but it may be moved around).
4372 The expression must return the number of spaces worth of indent. It
4373 can return "-1" to keep the current indent (this means 'autoindent' is
4374 used for the indent).
4375 Functions useful for computing the indent are |indent()|, |cindent()|
4376 and |lispindent()|.
4377 The evaluation of the expression must not have side effects! It must
4378 not change the text, jump to another window, etc. Afterwards the
4379 cursor position is always restored, thus the cursor may be moved.
4380 Normally this option would be set to call a function: >
4381 :set indentexpr=GetMyIndent()
4382< Error messages will be suppressed, unless the 'debug' option contains
4383 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004384 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004385 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004386
Bram Moolenaar30b65812012-07-12 22:01:11 +02004387 The expression will be evaluated in the |sandbox| when set from a
4388 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004389 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004390
4391 It is not allowed to change text or jump to another window while
4392 evaluating 'indentexpr' |textlock|.
4393
4394
Bram Moolenaar071d4272004-06-13 20:20:40 +00004395 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004396'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004398 {not available when compiled without the |+cindent|
4399 feature}
4400 A list of keys that, when typed in Insert mode, cause reindenting of
4401 the current line. Only happens if 'indentexpr' isn't empty.
4402 The format is identical to 'cinkeys', see |indentkeys-format|.
4403 See |C-indenting| and |indent-expression|.
4404
4405 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4406'infercase' 'inf' boolean (default off)
4407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004409 'ignorecase' is also on, the case of the match is adjusted depending
4410 on the typed text. If the typed text contains a lowercase letter
4411 where the match has an upper case letter, the completed part is made
4412 lowercase. If the typed text has no lowercase letters and the match
4413 has a lowercase letter where the typed text has an uppercase letter,
4414 and there is a letter before it, the completed part is made uppercase.
4415 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004416
4417 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4418'insertmode' 'im' boolean (default off)
4419 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004420 Makes Vim work in a way that Insert mode is the default mode. Useful
4421 if you want to use Vim as a modeless editor. Used for |evim|.
4422 These Insert mode commands will be useful:
4423 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004424 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004425 this is a mapping, it is executed as if 'insertmode' was off.
4426 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004427 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004428 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4429 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004430
4431 These items change when 'insertmode' is set:
4432 - when starting to edit of a file, Vim goes to Insert mode.
4433 - <Esc> in Insert mode is a no-op and beeps.
4434 - <Esc> in Normal mode makes Vim go to Insert mode.
4435 - CTRL-L in Insert mode is a command, it is not inserted.
4436 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4437 However, when <Esc> is used inside a mapping, it behaves like
4438 'insertmode' was not set. This was done to be able to use the same
4439 mappings with 'insertmode' set or not set.
4440 When executing commands with |:normal| 'insertmode' is not used.
4441
4442 NOTE: This option is reset when 'compatible' is set.
4443
4444 *'isfname'* *'isf'*
4445'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4446 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4447 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4448 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4449 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4450 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4451 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004452 The characters specified by this option are included in file names and
4453 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004454 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 Multi-byte characters 256 and above are always included, only the
4456 characters up to 255 are specified with this option.
4457 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004458 Think twice before adding white space to this option. Although a
4459 space may appear inside a file name, the effect will be that Vim
4460 doesn't know where a file name starts or ends when doing completion.
4461 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004462
4463 Note that on systems using a backslash as path separator, Vim tries to
4464 do its best to make it work as you would expect. That is a bit
4465 tricky, since Vi originally used the backslash to escape special
4466 characters. Vim will not remove a backslash in front of a normal file
4467 name character on these systems, but it will on Unix and alikes. The
4468 '&' and '^' are not included by default, because these are special for
4469 cmd.exe.
4470
4471 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004472 Each part can be a single character number or a range. A range is two
4473 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 decimal number between 0 and 255 or the ASCII character itself (does
4475 not work for digits). Example:
4476 "_,-,128-140,#-43" (include '_' and '-' and the range
4477 128 to 140 and '#' to 43)
4478 If a part starts with '^', the following character number or range
4479 will be excluded from the option. The option is interpreted from left
4480 to right. Put the excluded character after the range where it is
4481 included. To include '^' itself use it as the last character of the
4482 option or the end of a range. Example:
4483 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4484 If the character is '@', all characters where isalpha() returns TRUE
4485 are included. Normally these are the characters a to z and A to Z,
4486 plus accented characters. To include '@' itself use "@-@". Examples:
4487 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004488 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 "a-z,A-Z,@-@" All letters plus the '@' character.
4490 A comma can be included by using it where a character number is
4491 expected. Example:
4492 "48-57,,,_" Digits, comma and underscore.
4493 A comma can be excluded by prepending a '^'. Example:
4494 " -~,^,,9" All characters from space to '~', excluding
4495 comma, plus <Tab>.
4496 See |option-backslash| about including spaces and backslashes.
4497
4498 *'isident'* *'isi'*
4499'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4500 "@,48-57,_,128-167,224-235"
4501 otherwise: "@,48-57,_,192-255")
4502 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 The characters given by this option are included in identifiers.
4504 Identifiers are used in recognizing environment variables and after a
4505 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004506 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004507 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004509 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4511
4512 *'iskeyword'* *'isk'*
4513'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4514 "@,48-57,_,128-167,224-235"
4515 otherwise: "@,48-57,_,192-255"
4516 Vi default: "@,48-57,_")
4517 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004518 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004519 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004520 'isfname' for a description of the format of this option. For '@'
4521 characters above 255 check the "word" character class.
4522 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004523 For a help file it is set to all non-blank printable characters except
4524 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4525 command).
4526 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004527 This option also influences syntax highlighting, unless the syntax
4528 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004529 NOTE: This option is set to the Vi default value when 'compatible' is
4530 set and to the Vim default value when 'compatible' is reset.
4531
4532 *'isprint'* *'isp'*
4533'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4534 "@,~-255"; otherwise: "@,161-255")
4535 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536 The characters given by this option are displayed directly on the
4537 screen. It is also used for "\p" in a |pattern|. The characters from
4538 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4539 even when they are not included in 'isprint' or excluded. See
4540 'isfname' for a description of the format of this option.
4541
4542 Non-printable characters are displayed with two characters:
4543 0 - 31 "^@" - "^_"
4544 32 - 126 always single characters
4545 127 "^?"
4546 128 - 159 "~@" - "~_"
4547 160 - 254 "| " - "|~"
4548 255 "~?"
4549 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4550 displayed as <xx>, with the hexadecimal value of the byte.
4551 When 'display' contains "uhex" all unprintable characters are
4552 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004553 The SpecialKey highlighting will be used for unprintable characters.
4554 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004555
4556 Multi-byte characters 256 and above are always included, only the
4557 characters up to 255 are specified with this option. When a character
4558 is printable but it is not available in the current font, a
4559 replacement character will be shown.
4560 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4561 There is no option to specify these characters.
4562
4563 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4564'joinspaces' 'js' boolean (default on)
4565 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004566 Insert two spaces after a '.', '?' and '!' with a join command.
4567 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4568 Otherwise only one space is inserted.
4569 NOTE: This option is set when 'compatible' is set.
4570
4571 *'key'*
4572'key' string (default "")
4573 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004574 {only available when compiled with the |+cryptv|
4575 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004577 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004578 Careful: Do not set the key value by hand, someone might see the typed
4579 key. Use the |:X| command. But you can make 'key' empty: >
4580 :set key=
4581< It is not possible to get the value of this option with ":set key" or
4582 "echo &key". This is to avoid showing it to someone who shouldn't
4583 know. It also means you cannot see it yourself once you have set it,
4584 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004585 You can use "&key" in an expression to detect whether encryption is
4586 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587
4588 *'keymap'* *'kmp'* *E544*
4589'keymap' 'kmp' string (default "")
4590 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004591 {only available when compiled with the |+keymap|
4592 feature}
4593 Name of a keyboard mapping. See |mbyte-keymap|.
4594 Setting this option to a valid keymap name has the side effect of
4595 setting 'iminsert' to one, so that the keymap becomes effective.
4596 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004597 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004598
4599 *'keymodel'* *'km'*
4600'keymodel' 'km' string (default "")
4601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004602 List of comma separated words, which enable special things that keys
4603 can do. These values can be used:
4604 startsel Using a shifted special key starts selection (either
4605 Select mode or Visual mode, depending on "key" being
4606 present in 'selectmode').
4607 stopsel Using a not-shifted special key stops selection.
4608 Special keys in this context are the cursor keys, <End>, <Home>,
4609 <PageUp> and <PageDown>.
4610 The 'keymodel' option is set by the |:behave| command.
4611
4612 *'keywordprg'* *'kp'*
4613'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004614 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004616 Program to use for the |K| command. Environment variables are
4617 expanded |:set_env|. ":help" may be used to access the Vim internal
4618 help. (Note that previously setting the global option to the empty
4619 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004620 When the first character is ":", the command is invoked as a Vim
4621 Ex command prefixed with [count].
4622 When "man", "man -s" or an Ex command is used, Vim will automatically
4623 translate a count for the "K" command and pass it as the first
4624 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004625 See |option-backslash| about including spaces and backslashes.
4626 Example: >
4627 :set keywordprg=man\ -s
4628< This option cannot be set from a |modeline| or in the |sandbox|, for
4629 security reasons.
4630
4631 *'langmap'* *'lmap'* *E357* *E358*
4632'langmap' 'lmap' string (default "")
4633 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004634 {only available when compiled with the |+langmap|
4635 feature}
4636 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004637 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004638 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004639 care of translating these special characters to the original meaning
4640 of the key. This means you don't have to change the keyboard mode to
4641 be able to execute Normal mode commands.
4642 This is the opposite of the 'keymap' option, where characters are
4643 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004644 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004645 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004646 This option cannot be set from a |modeline| or in the |sandbox|, for
4647 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004648
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004649 Example (for Greek, in UTF-8): *greek* >
4650 :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 +00004651< Example (exchanges meaning of z and y for commands): >
4652 :set langmap=zy,yz,ZY,YZ
4653<
4654 The 'langmap' option is a list of parts, separated with commas. Each
4655 part can be in one of two forms:
4656 1. A list of pairs. Each pair is a "from" character immediately
4657 followed by the "to" character. Examples: "aA", "aAbBcC".
4658 2. A list of "from" characters, a semi-colon and a list of "to"
4659 characters. Example: "abc;ABC"
4660 Example: "aA,fgh;FGH,cCdDeE"
4661 Special characters need to be preceded with a backslash. These are
4662 ";", ',' and backslash itself.
4663
4664 This will allow you to activate vim actions without having to switch
4665 back and forth between the languages. Your language characters will
4666 be understood as normal vim English characters (according to the
4667 langmap mappings) in the following cases:
4668 o Normal/Visual mode (commands, buffer/register names, user mappings)
4669 o Insert/Replace Mode: Register names after CTRL-R
4670 o Insert/Replace Mode: Mappings
4671 Characters entered in Command-line mode will NOT be affected by
4672 this option. Note that this option can be changed at any time
4673 allowing to switch between mappings for different languages/encodings.
4674 Use a mapping to avoid having to type it each time!
4675
4676 *'langmenu'* *'lm'*
4677'langmenu' 'lm' string (default "")
4678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004679 {only available when compiled with the |+menu| and
4680 |+multi_lang| features}
4681 Language to use for menu translation. Tells which file is loaded
4682 from the "lang" directory in 'runtimepath': >
4683 "lang/menu_" . &langmenu . ".vim"
4684< (without the spaces). For example, to always use the Dutch menus, no
4685 matter what $LANG is set to: >
4686 :set langmenu=nl_NL.ISO_8859-1
4687< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004688 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004689 If your $LANG is set to a non-English language but you do want to use
4690 the English menus: >
4691 :set langmenu=none
4692< This option must be set before loading menus, switching on filetype
4693 detection or syntax highlighting. Once the menus are defined setting
4694 this option has no effect. But you could do this: >
4695 :source $VIMRUNTIME/delmenu.vim
4696 :set langmenu=de_DE.ISO_8859-1
4697 :source $VIMRUNTIME/menu.vim
4698< Warning: This deletes all menus that you defined yourself!
4699
Bram Moolenaard94464e2015-11-02 15:28:18 +01004700 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004701'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004702 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004703 {only available when compiled with the |+langmap|
4704 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004705 This is just like 'langremap' but with the value inverted. It only
4706 exists for backwards compatibility. When setting 'langremap' then
4707 'langnoremap' is set to the inverted value, and the other way around.
4708
4709 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4710'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4711 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004712 {only available when compiled with the |+langmap|
4713 feature}
4714 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004715 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004716 'langmap' disables some of your mappings, try resetting this option.
4717 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004718 that works for you to avoid mappings to break.
4719
Bram Moolenaar071d4272004-06-13 20:20:40 +00004720 *'laststatus'* *'ls'*
4721'laststatus' 'ls' number (default 1)
4722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004723 The value of this option influences when the last window will have a
4724 status line:
4725 0: never
4726 1: only if there are at least two windows
4727 2: always
4728 The screen looks nicer with a status line if you have several
4729 windows, but it takes another screen line. |status-line|
4730
4731 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4732'lazyredraw' 'lz' boolean (default off)
4733 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004734 When this option is set, the screen will not be redrawn while
4735 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004736 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004737 update use |:redraw|.
4738
4739 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4740'linebreak' 'lbr' boolean (default off)
4741 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004742 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004743 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004744 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 than at the last character that fits on the screen. Unlike
4746 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004747 it only affects the way the file is displayed, not its contents.
4748 If 'breakindent' is set, line is visually indented. Then, the value
4749 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004750 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004751 Note that <Tab> characters after an <EOL> are mostly not displayed
4752 with the right amount of white space.
4753
4754 *'lines'* *E593*
4755'lines' number (default 24 or terminal height)
4756 global
4757 Number of lines of the Vim window.
4758 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004759 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004760 When Vim is running in the GUI or in a resizable window, setting this
4761 option will cause the window size to be changed. When you only want
4762 to use the size for the GUI, put the command in your |gvimrc| file.
4763 Vim limits the number of lines to what fits on the screen. You can
4764 use this command to get the tallest window possible: >
4765 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004766< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004767 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004768 When you set this option and Vim is unable to change the physical
4769 number of lines of the display, the display may be messed up.
4770
4771 *'linespace'* *'lsp'*
4772'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4773 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004774 {only in the GUI}
4775 Number of pixel lines inserted between characters. Useful if the font
4776 uses the full character cell height, making lines touch each other.
4777 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004778 With some fonts there can be too much room between lines (to have
4779 space for ascents and descents). Then it makes sense to set
4780 'linespace' to a negative value. This may cause display problems
4781 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782
4783 *'lisp'* *'nolisp'*
4784'lisp' boolean (default off)
4785 local to buffer
4786 {not available when compiled without the |+lispindent|
4787 feature}
4788 Lisp mode: When <Enter> is typed in insert mode set the indent for
4789 the next line to Lisp standards (well, sort of). Also happens with
4790 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4791 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4792 better. Also see 'lispwords'.
4793 The '-' character is included in keyword characters. Redefines the
4794 "=" operator to use this same indentation algorithm rather than
4795 calling an external program if 'equalprg' is empty.
4796 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004797
4798 *'lispwords'* *'lw'*
4799'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004800 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 {not available when compiled without the |+lispindent|
4802 feature}
4803 Comma separated list of words that influence the Lisp indenting.
4804 |'lisp'|
4805
4806 *'list'* *'nolist'*
4807'list' boolean (default off)
4808 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004809 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4810 line. Useful to see the difference between tabs and spaces and for
4811 trailing blanks. Further changed by the 'listchars' option.
4812
4813 The cursor is displayed at the start of the space a Tab character
4814 occupies, not at the end as usual in Normal mode. To get this cursor
4815 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004816 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004817<
4818 Note that list mode will also affect formatting (set with 'textwidth'
4819 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004820 changing the way tabs are displayed.
4821
4822 *'listchars'* *'lcs'*
4823'listchars' 'lcs' string (default "eol:$")
4824 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004825 Strings to use in 'list' mode and for the |:list| command. It is a
4826 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004827 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004828 eol:c Character to show at the end of each line. When
4829 omitted, there is no extra character at the end of the
4830 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004831 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004832 tab:xy[z] Two or three characters to be used to show a tab.
4833 The third character is optional.
4834
4835 tab:xy The 'x' is always used, then 'y' as many times as will
4836 fit. Thus "tab:>-" displays:
4837 >
4838 >-
4839 >--
4840 etc.
4841
4842 tab:xyz The 'z' is always used, then 'x' is prepended, and
4843 then 'y' is used as many times as will fit. Thus
4844 "tab:<->" displays:
4845 >
4846 <>
4847 <->
4848 <-->
4849 etc.
4850
4851 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004852 *lcs-space*
4853 space:c Character to show for a space. When omitted, spaces
4854 are left blank.
4855 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004856 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004857 trailing spaces are blank. Overrides the "space"
4858 setting for trailing spaces.
4859 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004860 extends:c Character to show in the last column, when 'wrap' is
4861 off and the line continues beyond the right of the
4862 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004863 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004864 precedes:c Character to show in the first visible column of the
4865 physical line, when there is text preceding the
4866 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004867 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004868 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004869 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004870 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004871 nbsp:c Character to show for a non-breakable space character
4872 (0xA0 (160 decimal) and U+202F). Left blank when
4873 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004874
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004875 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004877 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004878
4879 Examples: >
4880 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004881 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004882 :set lcs=extends:>,precedes:<
4883< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004884 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004885 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004886
4887 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4888'loadplugins' 'lpl' boolean (default on)
4889 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004890 When on the plugin scripts are loaded when starting up |load-plugins|.
4891 This option can be reset in your |vimrc| file to disable the loading
4892 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004893 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4894 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004895
Bram Moolenaard94464e2015-11-02 15:28:18 +01004896 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004897'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004898 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004899 {only available when compiled with the |+lua/dyn|
4900 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004901 Specifies the name of the Lua shared library. The default is
4902 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004903 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004904 This option cannot be set from a |modeline| or in the |sandbox|, for
4905 security reasons.
4906
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004907 *'macatsui'* *'nomacatsui'*
4908'macatsui' boolean (default on)
4909 global
4910 {only available in Mac GUI version}
4911 This is a workaround for when drawing doesn't work properly. When set
4912 and compiled with multi-byte support ATSUI text drawing is used. When
4913 not set ATSUI text drawing is not used. Switch this option off when
4914 you experience drawing problems. In a future version the problems may
4915 be solved and this option becomes obsolete. Therefore use this method
4916 to unset it: >
4917 if exists('&macatsui')
4918 set nomacatsui
4919 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004920< Another option to check if you have drawing problems is
4921 'termencoding'.
4922
Bram Moolenaar071d4272004-06-13 20:20:40 +00004923 *'magic'* *'nomagic'*
4924'magic' boolean (default on)
4925 global
4926 Changes the special characters that can be used in search patterns.
4927 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004928 WARNING: Switching this option off most likely breaks plugins! That
4929 is because many patterns assume it's on and will fail when it's off.
4930 Only switch it off when working with old Vi scripts. In any other
4931 situation write patterns that work when 'magic' is on. Include "\M"
4932 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004933
4934 *'makeef'* *'mef'*
4935'makeef' 'mef' string (default: "")
4936 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004937 {not available when compiled without the |+quickfix|
4938 feature}
4939 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4940 and the |:grep| command.
4941 When it is empty, an internally generated temp file will be used.
4942 When "##" is included, it is replaced by a number to make the name
4943 unique. This makes sure that the ":make" command doesn't overwrite an
4944 existing file.
4945 NOT used for the ":cf" command. See 'errorfile' for that.
4946 Environment variables are expanded |:set_env|.
4947 See |option-backslash| about including spaces and backslashes.
4948 This option cannot be set from a |modeline| or in the |sandbox|, for
4949 security reasons.
4950
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004951 *'makeencoding'* *'menc'*
4952'makeencoding' 'menc' string (default "")
4953 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004954 Encoding used for reading the output of external commands. When empty,
4955 encoding is not converted.
4956 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4957 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4958 and `:laddfile`.
4959
4960 This would be mostly useful when you use MS-Windows and set 'encoding'
4961 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4962 'makeencoding' to "char" has the same effect as setting to the system
4963 locale encoding. Example: >
4964 :set encoding=utf-8
4965 :set makeencoding=char " system locale is used
4966<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004967 *'makeprg'* *'mp'*
4968'makeprg' 'mp' string (default "make", VMS: "MMS")
4969 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004970 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004971 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4972 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004973 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004974 Environment variables are expanded |:set_env|. See |option-backslash|
4975 about including spaces and backslashes.
4976 Note that a '|' must be escaped twice: once for ":set" and once for
4977 the interpretation of a command. When you use a filter called
4978 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004979 :set makeprg=gmake\ \\\|\ myfilter
4980< The placeholder "$*" can be given (even multiple times) to specify
4981 where the arguments will be included, for example: >
4982 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4983< This option cannot be set from a |modeline| or in the |sandbox|, for
4984 security reasons.
4985
4986 *'matchpairs'* *'mps'*
4987'matchpairs' 'mps' string (default "(:),{:},[:]")
4988 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004990 other.
4991 Only character pairs are allowed that are different, thus you cannot
4992 jump between two double quotes.
4993 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004994 The pairs must be separated by a comma. Example for including '<' and
4995 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004996 :set mps+=<:>
4997
4998< A more exotic example, to jump between the '=' and ';' in an
4999 assignment, useful for languages like C and Java: >
5000 :au FileType c,cpp,java set mps+==:;
5001
5002< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01005003 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004
5005 *'matchtime'* *'mat'*
5006'matchtime' 'mat' number (default 5)
5007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 Tenths of a second to show the matching paren, when 'showmatch' is
5009 set. Note that this is not in milliseconds, like other options that
5010 set a time. This is to be compatible with Nvi.
5011
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005012 *'maxcombine'* *'mco'*
5013'maxcombine' 'mco' number (default 2)
5014 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005015 The maximum number of combining characters supported for displaying.
5016 Only used when 'encoding' is "utf-8".
5017 The default is OK for most languages. Hebrew may require 4.
5018 Maximum value is 6.
5019 Even when this option is set to 2 you can still edit text with more
5020 combining characters, you just can't see them. Use |g8| or |ga|.
5021 See |mbyte-combining|.
5022
Bram Moolenaar071d4272004-06-13 20:20:40 +00005023 *'maxfuncdepth'* *'mfd'*
5024'maxfuncdepth' 'mfd' number (default 100)
5025 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005026 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005027 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005028 Maximum depth of function calls for user functions. This normally
5029 catches endless recursion. When using a recursive function with
5030 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5031 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005032 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005033 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005034 See also |:function|.
5035
5036 *'maxmapdepth'* *'mmd'* *E223*
5037'maxmapdepth' 'mmd' number (default 1000)
5038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005039 Maximum number of times a mapping is done without resulting in a
5040 character to be used. This normally catches endless mappings, like
5041 ":map x y" with ":map y x". It still does not catch ":map g wg",
5042 because the 'w' is used before the next mapping is done. See also
5043 |key-mapping|.
5044
5045 *'maxmem'* *'mm'*
5046'maxmem' 'mm' number (default between 256 to 5120 (system
5047 dependent) or half the amount of memory
5048 available)
5049 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005050 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5051 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005052 other memory to be freed.
5053 The maximum usable value is about 2000000. Use this to work without a
5054 limit.
5055 The value is ignored when 'swapfile' is off.
5056 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005057
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005058 *'maxmempattern'* *'mmp'*
5059'maxmempattern' 'mmp' number (default 1000)
5060 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005061 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005062 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005063 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005064 When Vim runs into the limit it gives an error message and mostly
5065 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005066 Running into the limit often means that the pattern is very
5067 inefficient or too complex. This may already happen with the pattern
5068 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005069 Might also happen on redraw, when syntax rules try to match a complex
5070 text structure.
5071 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5072 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005073
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 *'maxmemtot'* *'mmt'*
5075'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5076 dependent) or half the amount of memory
5077 available)
5078 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005079 Maximum amount of memory in Kbyte to use for all buffers together.
5080 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005081 without a limit.
5082 On 64 bit machines higher values might work. But hey, do you really
5083 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005084 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005085 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005086 Buffers with 'swapfile' off still count to the total amount of memory
5087 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005088 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005089
5090 *'menuitems'* *'mis'*
5091'menuitems' 'mis' number (default 25)
5092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005093 {not available when compiled without the |+menu|
5094 feature}
5095 Maximum number of items to use in a menu. Used for menus that are
5096 generated from a list of items, e.g., the Buffers menu. Changing this
5097 option has no direct effect, the menu must be refreshed first.
5098
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005099 *'mkspellmem'* *'msm'*
5100'mkspellmem' 'msm' string (default "460000,2000,500")
5101 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005102 {not available when compiled without the |+syntax|
5103 feature}
5104 Parameters for |:mkspell|. This tunes when to start compressing the
5105 word tree. Compression can be slow when there are many words, but
5106 it's needed to avoid running out of memory. The amount of memory used
5107 per word depends very much on how similar the words are, that's why
5108 this tuning is complicated.
5109
5110 There are three numbers, separated by commas:
5111 {start},{inc},{added}
5112
5113 For most languages the uncompressed word tree fits in memory. {start}
5114 gives the amount of memory in Kbyte that can be used before any
5115 compression is done. It should be a bit smaller than the amount of
5116 memory that is available to Vim.
5117
5118 When going over the {start} limit the {inc} number specifies the
5119 amount of memory in Kbyte that can be allocated before another
5120 compression is done. A low number means compression is done after
5121 less words are added, which is slow. A high number means more memory
5122 will be allocated.
5123
5124 After doing compression, {added} times 1024 words can be added before
5125 the {inc} limit is ignored and compression is done when any extra
5126 amount of memory is needed. A low number means there is a smaller
5127 chance of hitting the {inc} limit, less memory is used but it's
5128 slower.
5129
5130 The languages for which these numbers are important are Italian and
5131 Hungarian. The default works for when you have about 512 Mbyte. If
5132 you have 1 Gbyte you could use: >
5133 :set mkspellmem=900000,3000,800
5134< If you have less than 512 Mbyte |:mkspell| may fail for some
5135 languages, no matter what you set 'mkspellmem' to.
5136
Bram Moolenaar07607392019-05-26 19:20:43 +02005137 This option cannot be set from a |modeline| or in the |sandbox|.
5138
Bram Moolenaar071d4272004-06-13 20:20:40 +00005139 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005140'modeline' 'ml' boolean (Vim default: on (off for root),
5141 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005142 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005143 If 'modeline' is on 'modelines' gives the number of lines that is
5144 checked for set commands. If 'modeline' is off or 'modelines' is zero
5145 no lines are checked. See |modeline|.
5146
5147 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5148'modelineexpr' 'mle' boolean (default: off)
5149 global
5150 When on allow some options that are an expression to be set in the
5151 modeline. Check the option for whether it is affected by
5152 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005153 This option cannot be set from a |modeline| or in the |sandbox|, for
5154 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005155
Bram Moolenaar071d4272004-06-13 20:20:40 +00005156 *'modelines'* *'mls'*
5157'modelines' 'mls' number (default 5)
5158 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005159 If 'modeline' is on 'modelines' gives the number of lines that is
5160 checked for set commands. If 'modeline' is off or 'modelines' is zero
5161 no lines are checked. See |modeline|.
5162 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5163 set and to the Vim default value when 'compatible' is reset.
5164
5165 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005166 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005167'modifiable' 'ma' boolean (default on)
5168 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005169 When off the buffer contents cannot be changed. The 'fileformat' and
5170 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005171 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005172
5173 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5174'modified' 'mod' boolean (default off)
5175 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005176 When on, the buffer is considered to be modified. This option is set
5177 when:
5178 1. A change was made to the text since it was last written. Using the
5179 |undo| command to go back to the original text will reset the
5180 option. But undoing changes that were made before writing the
5181 buffer will set the option again, since the text is different from
5182 when it was written.
5183 2. 'fileformat' or 'fileencoding' is different from its original
5184 value. The original value is set when the buffer is read or
5185 written. A ":set nomodified" command also resets the original
5186 values to the current values and the 'modified' option will be
5187 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005188 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005189 This option is not set when a change is made to the buffer as the
5190 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5191 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5192 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005193 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5194 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005195 Note that the text may actually be the same, e.g. 'modified' is set
5196 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005197
5198 *'more'* *'nomore'*
5199'more' boolean (Vim default: on, Vi default: off)
5200 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005201 When on, listings pause when the whole screen is filled. You will get
5202 the |more-prompt|. When this option is off there are no pauses, the
5203 listing continues until finished.
5204 NOTE: This option is set to the Vi default value when 'compatible' is
5205 set and to the Vim default value when 'compatible' is reset.
5206
5207 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005208'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
Bram Moolenaar5b418992019-10-27 18:50:25 +01005209 set to "a" or "nvi" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005210 global
Bram Moolenaar5b418992019-10-27 18:50:25 +01005211 Enable the use of the mouse. Works for most terminals (xterm, MS-DOS,
5212 Win32 |win32-mouse|, QNX pterm, *BSD console with sysmouse and Linux
5213 console with gpm). For using the mouse in the GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005214 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005215 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005216 v Visual mode
5217 i Insert mode
5218 c Command-line mode
5219 h all previous modes when editing a help file
5220 a all previous modes
5221 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005222 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 :set mouse=a
Bram Moolenaar5b418992019-10-27 18:50:25 +01005224< If your terminal can't overrule the mouse events going to the
5225 application, use: >
5226 :set mouse=nvi
5227< The you can press ":", select text for the system, and press Esc to go
5228 back to Vim using the mouse events.
5229 In |defaults.vim| "nvi" is used if the 'term' option is not matching
5230 "xterm".
5231
5232 When the mouse is not enabled, the GUI will still use the mouse for
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 modeless selection. This doesn't move the text cursor.
5234
5235 See |mouse-using|. Also see |'clipboard'|.
5236
5237 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005238 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005239 the mouse buttons can still be used by keeping the shift key pressed.
5240 Also see the 'clipboard' option.
5241
5242 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5243'mousefocus' 'mousef' boolean (default off)
5244 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005245 {only works in the GUI}
5246 The window that the mouse pointer is on is automatically activated.
5247 When changing the window layout or window focus in another way, the
5248 mouse pointer is moved to the window with keyboard focus. Off is the
5249 default because it makes using the pull down menus a little goofy, as
5250 a pointer transit may activate a window unintentionally.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01005251 MS-Windows: Also see 'scrollfocus' for what window is scrolled when
5252 using the mouse scroll whel.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005253
5254 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5255'mousehide' 'mh' boolean (default on)
5256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005257 {only works in the GUI}
5258 When on, the mouse pointer is hidden when characters are typed.
5259 The mouse pointer is restored when the mouse is moved.
5260
5261 *'mousemodel'* *'mousem'*
5262'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5263 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005264 Sets the model to use for the mouse. The name mostly specifies what
5265 the right mouse button is used for:
5266 extend Right mouse button extends a selection. This works
5267 like in an xterm.
5268 popup Right mouse button pops up a menu. The shifted left
5269 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005270 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005271 popup_setpos Like "popup", but the cursor will be moved to the
5272 position where the mouse was clicked, and thus the
5273 selected operation will act upon the clicked object.
5274 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005275 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 course, that right clicking outside a selection will
5277 end Visual mode.
5278 Overview of what button does what for each model:
5279 mouse extend popup(_setpos) ~
5280 left click place cursor place cursor
5281 left drag start selection start selection
5282 shift-left search word extend selection
5283 right click extend selection popup menu (place cursor)
5284 right drag extend selection -
5285 middle click paste paste
5286
5287 In the "popup" model the right mouse button produces a pop-up menu.
5288 You need to define this first, see |popup-menu|.
5289
5290 Note that you can further refine the meaning of buttons with mappings.
5291 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5292 selection (because that's handled in the GUI code directly).
5293
5294 The 'mousemodel' option is set by the |:behave| command.
5295
5296 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005297'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5298 vs:leftright,vd:lrsizing,m:no,
5299 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005300 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005301 {only available when compiled with the |+mouseshape|
5302 feature}
5303 This option tells Vim what the mouse pointer should look like in
5304 different modes. The option is a comma separated list of parts, much
5305 like used for 'guicursor'. Each part consist of a mode/location-list
5306 and an argument-list:
5307 mode-list:shape,mode-list:shape,..
5308 The mode-list is a dash separated list of these modes/locations:
5309 In a normal window: ~
5310 n Normal mode
5311 v Visual mode
5312 ve Visual mode with 'selection' "exclusive" (same as 'v',
5313 if not specified)
5314 o Operator-pending mode
5315 i Insert mode
5316 r Replace mode
5317
5318 Others: ~
5319 c appending to the command-line
5320 ci inserting in the command-line
5321 cr replacing in the command-line
5322 m at the 'Hit ENTER' or 'More' prompts
5323 ml idem, but cursor in the last line
5324 e any mode, pointer below last window
5325 s any mode, pointer on a status line
5326 sd any mode, while dragging a status line
5327 vs any mode, pointer on a vertical separator line
5328 vd any mode, while dragging a vertical separator line
5329 a everywhere
5330
5331 The shape is one of the following:
5332 avail name looks like ~
5333 w x arrow Normal mouse pointer
5334 w x blank no pointer at all (use with care!)
5335 w x beam I-beam
5336 w x updown up-down sizing arrows
5337 w x leftright left-right sizing arrows
5338 w x busy The system's usual busy pointer
5339 w x no The system's usual 'no input' pointer
5340 x udsizing indicates up-down resizing
5341 x lrsizing indicates left-right resizing
5342 x crosshair like a big thin +
5343 x hand1 black hand
5344 x hand2 white hand
5345 x pencil what you write with
5346 x question big ?
5347 x rightup-arrow arrow pointing right-up
5348 w x up-arrow arrow pointing up
5349 x <number> any X11 pointer number (see X11/cursorfont.h)
5350
5351 The "avail" column contains a 'w' if the shape is available for Win32,
5352 x for X11.
5353 Any modes not specified or shapes not available use the normal mouse
5354 pointer.
5355
5356 Example: >
5357 :set mouseshape=s:udsizing,m:no
5358< will make the mouse turn to a sizing arrow over the status lines and
5359 indicate no input when the hit-enter prompt is displayed (since
5360 clicking the mouse has no effect in this state.)
5361
5362 *'mousetime'* *'mouset'*
5363'mousetime' 'mouset' number (default 500)
5364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005365 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5366 time in msec between two mouse clicks for the second click to be
5367 recognized as a multi click.
5368
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005369 *'mzschemedll'*
5370'mzschemedll' string (default depends on the build)
5371 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005372 {only available when compiled with the |+mzscheme/dyn|
5373 feature}
5374 Specifies the name of the MzScheme shared library. The default is
5375 DYNAMIC_MZSCH_DLL which was specified at compile time.
5376 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005377 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005378 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005379 This option cannot be set from a |modeline| or in the |sandbox|, for
5380 security reasons.
5381
5382 *'mzschemegcdll'*
5383'mzschemegcdll' string (default depends on the build)
5384 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005385 {only available when compiled with the |+mzscheme/dyn|
5386 feature}
5387 Specifies the name of the MzScheme GC shared library. The default is
5388 DYNAMIC_MZGC_DLL which was specified at compile time.
5389 The value can be equal to 'mzschemedll' if it includes the GC code.
5390 Environment variables are expanded |:set_env|.
5391 This option cannot be set from a |modeline| or in the |sandbox|, for
5392 security reasons.
5393
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005394 *'mzquantum'* *'mzq'*
5395'mzquantum' 'mzq' number (default 100)
5396 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005397 {not available when compiled without the |+mzscheme|
5398 feature}
5399 The number of milliseconds between polls for MzScheme threads.
5400 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005401 NOTE: This option is set to the Vim default value when 'compatible'
5402 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005403
Bram Moolenaar071d4272004-06-13 20:20:40 +00005404 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005405'nrformats' 'nf' string (default "bin,octal,hex",
5406 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005407 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005408 This defines what bases Vim will consider for numbers when using the
5409 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5410 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005411 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005412 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005413 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005414 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005415 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005416 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005417 considered to be hexadecimal. Example: Using CTRL-X on
5418 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005419 bin If included, numbers starting with "0b" or "0B" will be
5420 considered to be binary. Example: Using CTRL-X on
5421 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422 Numbers which simply begin with a digit in the range 1-9 are always
5423 considered decimal. This also happens for numbers that are not
5424 recognized as octal or hex.
5425
5426 *'number'* *'nu'* *'nonumber'* *'nonu'*
5427'number' 'nu' boolean (default off)
5428 local to window
5429 Print the line number in front of each line. When the 'n' option is
5430 excluded from 'cpoptions' a wrapped line will not use the column of
5431 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005432 The 'numberwidth' option can be used to set the room used for the line
5433 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005434 When a long, wrapped line doesn't start with the first character, '-'
5435 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005436 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5437 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005438 *number_relativenumber*
5439 The 'relativenumber' option changes the displayed number to be
5440 relative to the cursor. Together with 'number' there are these
5441 four combinations (cursor in line 3):
5442
Bram Moolenaar3848e002016-03-19 18:42:29 +01005443 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005444 'nornu' 'nornu' 'rnu' 'rnu'
5445
5446 |apple | 1 apple | 2 apple | 2 apple
5447 |pear | 2 pear | 1 pear | 1 pear
5448 |nobody | 3 nobody | 0 nobody |3 nobody
5449 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005450
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005451 *'numberwidth'* *'nuw'*
5452'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5453 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005454 {only available when compiled with the |+linebreak|
5455 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005456 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005457 when the 'number' or 'relativenumber' option is set or printing lines
5458 with a line number. Since one space is always between the number and
5459 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005460 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005461 fit the highest line number in the buffer respectively the number of
5462 rows in the window, depending on whether 'number' or 'relativenumber'
5463 is set. Thus with the Vim default of 4 there is room for a line number
5464 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005465 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005466 NOTE: This option is set to the Vi default value when 'compatible' is
5467 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005468
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005469 *'omnifunc'* *'ofu'*
5470'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005471 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005472 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005473 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005474 This option specifies a function to be used for Insert mode omni
5475 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005476 See |complete-functions| for an explanation of how the function is
5477 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005478 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005479 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005480 This option cannot be set from a |modeline| or in the |sandbox|, for
5481 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005482
5483
Bram Moolenaar02467872007-05-06 13:22:01 +00005484 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005485'opendevice' 'odev' boolean (default off)
5486 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005487 {only for MS-DOS, MS-Windows and OS/2}
5488 Enable reading and writing from devices. This may get Vim stuck on a
5489 device that can be opened but doesn't actually do the I/O. Therefore
5490 it is off by default.
5491 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5492 result in editing a device.
5493
5494
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005495 *'operatorfunc'* *'opfunc'*
5496'operatorfunc' 'opfunc' string (default: empty)
5497 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005498 This option specifies a function to be called by the |g@| operator.
5499 See |:map-operator| for more info and an example.
5500
5501 This option cannot be set from a |modeline| or in the |sandbox|, for
5502 security reasons.
5503
5504
Bram Moolenaar251e1912011-06-19 05:09:16 +02005505 *'osfiletype'* *'oft'*
5506'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005507 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005508 This option was supported on RISC OS, which has been removed.
5509
Bram Moolenaar071d4272004-06-13 20:20:40 +00005510
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005511 *'packpath'* *'pp'*
5512'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005513 Directories used to find packages. See |packages|.
5514
5515
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005517'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005518 global
5519 Specifies the nroff macros that separate paragraphs. These are pairs
5520 of two letters (see |object-motions|).
5521
5522 *'paste'* *'nopaste'*
5523'paste' boolean (default off)
5524 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005525 Put Vim in Paste mode. This is useful if you want to cut or copy
5526 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 unexpected effects.
5528 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005529 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005530 knows about pasting and will mostly do the right thing without 'paste'
5531 being set. The same is true for a terminal where Vim handles the
5532 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005533 This option is reset when starting the GUI. Thus if you set it in
5534 your .vimrc it will work in a terminal, but not in the GUI. Setting
5535 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5536 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005537 When the 'paste' option is switched on (also when it was already on):
5538 - mapping in Insert mode and Command-line mode is disabled
5539 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005541 - 'expandtab' is reset
5542 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005543 - 'revins' is reset
5544 - 'ruler' is reset
5545 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005546 - 'smartindent' is reset
5547 - 'smarttab' is reset
5548 - 'softtabstop' is set to 0
5549 - 'textwidth' is set to 0
5550 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005551 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005552 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005553 - 'indentexpr'
5554 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005555 NOTE: When you start editing another file while the 'paste' option is
5556 on, settings from the modelines or autocommands may change the
5557 settings again, causing trouble when pasting text. You might want to
5558 set the 'paste' option again.
5559 When the 'paste' option is reset the mentioned options are restored to
5560 the value before the moment 'paste' was switched from off to on.
5561 Resetting 'paste' before ever setting it does not have any effect.
5562 Since mapping doesn't work while 'paste' is active, you need to use
5563 the 'pastetoggle' option to toggle the 'paste' option with some key.
5564
5565 *'pastetoggle'* *'pt'*
5566'pastetoggle' 'pt' string (default "")
5567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 When non-empty, specifies the key sequence that toggles the 'paste'
5569 option. This is like specifying a mapping: >
5570 :map {keys} :set invpaste<CR>
5571< Where {keys} is the value of 'pastetoggle'.
5572 The difference is that it will work even when 'paste' is set.
5573 'pastetoggle' works in Insert mode and Normal mode, but not in
5574 Command-line mode.
5575 Mappings are checked first, thus overrule 'pastetoggle'. However,
5576 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5577 this: >
5578 :map <F10> :set paste<CR>
5579 :map <F11> :set nopaste<CR>
5580 :imap <F10> <C-O>:set paste<CR>
5581 :imap <F11> <nop>
5582 :set pastetoggle=<F11>
5583< This will make <F10> start paste mode and <F11> stop paste mode.
5584 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5585 mode everything is inserted literally, except the 'pastetoggle' key
5586 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005587 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588
5589 *'pex'* *'patchexpr'*
5590'patchexpr' 'pex' string (default "")
5591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592 {not available when compiled without the |+diff|
5593 feature}
5594 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005595 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005596
Bram Moolenaardbc28022014-07-26 13:40:44 +02005597 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598'patchmode' 'pm' string (default "")
5599 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005600 When non-empty the oldest version of a file is kept. This can be used
5601 to keep the original version of a file if you are changing files in a
5602 source distribution. Only the first time that a file is written a
5603 copy of the original file will be kept. The name of the copy is the
5604 name of the original file with the string in the 'patchmode' option
5605 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005606 ".orig" or ".org". 'backupdir' must not be empty for this to work
5607 (Detail: The backup file is renamed to the patchmode file after the
5608 new file has been successfully written, that's why it must be possible
5609 to write a backup file). If there was no file to be backed up, an
5610 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005611 When the 'backupskip' pattern matches, a patchmode file is not made.
5612 Using 'patchmode' for compressed files appends the extension at the
5613 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5614 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005615 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005616
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005617 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005618'path' 'pa' string (default on Unix: ".,/usr/include,,"
5619 on OS/2: ".,/emx/include,,"
5620 other systems: ".,,")
5621 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005622 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005623 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5624 provided that the file being searched for has a relative path (not
5625 starting with "/", "./" or "../"). The directories in the 'path'
5626 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 - Use commas to separate directory names: >
5628 :set path=.,/usr/local/include,/usr/include
5629< - Spaces can also be used to separate directory names (for backwards
5630 compatibility with version 3.0). To have a space in a directory
5631 name, precede it with an extra backslash, and escape the space: >
5632 :set path=.,/dir/with\\\ space
5633< - To include a comma in a directory name precede it with an extra
5634 backslash: >
5635 :set path=.,/dir/with\\,comma
5636< - To search relative to the directory of the current file, use: >
5637 :set path=.
5638< - To search in the current directory use an empty string between two
5639 commas: >
5640 :set path=,,
5641< - A directory name may end in a ':' or '/'.
5642 - Environment variables are expanded |:set_env|.
5643 - When using |netrw.vim| URLs can be used. For example, adding
5644 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005645 - Search upwards and downwards in a directory tree using "*", "**" and
5646 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005647 {not available when compiled without the |+path_extra| feature}
5648 - Careful with '\' characters, type two to get one in the option: >
5649 :set path=.,c:\\include
5650< Or just use '/' instead: >
5651 :set path=.,c:/include
5652< Don't forget "." or files won't even be found in the same directory as
5653 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005654 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005655 it is something like 256 or 1024 characters.
5656 You can check if all the include files are found, using the value of
5657 'path', see |:checkpath|.
5658 The use of |:set+=| and |:set-=| is preferred when adding or removing
5659 directories from the list. This avoids problems when a future version
5660 uses another default. To remove the current directory use: >
5661 :set path-=
5662< To add the current directory use: >
5663 :set path+=
5664< To use an environment variable, you probably need to replace the
5665 separator. Here is an example to append $INCL, in which directory
5666 names are separated with a semi-colon: >
5667 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5668< Replace the ';' with a ':' or whatever separator is used. Note that
5669 this doesn't work when $INCL contains a comma or white space.
5670
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005671 *'perldll'*
5672'perldll' string (default depends on the build)
5673 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005674 {only available when compiled with the |+perl/dyn|
5675 feature}
5676 Specifies the name of the Perl shared library. The default is
5677 DYNAMIC_PERL_DLL, which was specified at compile time.
5678 Environment variables are expanded |:set_env|.
5679 This option cannot be set from a |modeline| or in the |sandbox|, for
5680 security reasons.
5681
Bram Moolenaar071d4272004-06-13 20:20:40 +00005682 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5683'preserveindent' 'pi' boolean (default off)
5684 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005685 When changing the indent of the current line, preserve as much of the
5686 indent structure as possible. Normally the indent is replaced by a
5687 series of tabs followed by spaces as required (unless |'expandtab'| is
5688 enabled, in which case only spaces are used). Enabling this option
5689 means the indent will preserve as many existing characters as possible
5690 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005691 'expandtab' does not apply to the preserved white space, a Tab remains
5692 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693 NOTE: When using ">>" multiple times the resulting indent is a mix of
5694 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005695 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005696 Also see 'copyindent'.
5697 Use |:retab| to clean up white space.
5698
5699 *'previewheight'* *'pvh'*
5700'previewheight' 'pvh' number (default 12)
5701 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005702 {not available when compiled without the |+quickfix|
5703 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005704 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005705 commands. Used for |CTRL-W_}| when no count is given. Not used when
5706 'previewpopup' is set.
5707
5708 *'previewpopup'* *'pvp'*
5709'previewpopup' 'pvp' string (default empty)
5710 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005711 {not available when compiled without the |+textprop|
5712 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005713 When not empty a popup window is used for commands that would open a
5714 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005715 Not used for the insert completion info, add "popup" to
5716 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
5718 *'previewwindow'* *'nopreviewwindow'*
5719 *'pvw'* *'nopvw'* *E590*
5720'previewwindow' 'pvw' boolean (default off)
5721 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005722 {not available when compiled without the |+quickfix|
5723 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005724 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 set. It's normally not set directly, but by using one of the commands
5726 |:ptag|, |:pedit|, etc.
5727
5728 *'printdevice'* *'pdev'*
5729'printdevice' 'pdev' string (default empty)
5730 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731 {only available when compiled with the |+printer|
5732 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005733 The name of the printer to be used for |:hardcopy|.
5734 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005735 This option cannot be set from a |modeline| or in the |sandbox|, for
5736 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005737
Bram Moolenaar8299df92004-07-10 09:47:34 +00005738 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005739'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005740 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005741 {only available when compiled with the |+printer|
5742 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005743 Sets the character encoding used when printing.
5744 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005745
5746 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005747'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005748 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005749 {only available when compiled with the |+printer|
5750 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005751 Expression used to print the PostScript produced with |:hardcopy|.
5752 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005753 This option cannot be set from a |modeline| or in the |sandbox|, for
5754 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005755
Bram Moolenaar8299df92004-07-10 09:47:34 +00005756 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005757'printfont' 'pfn' string (default "courier")
5758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759 {only available when compiled with the |+printer|
5760 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005761 The name of the font that will be used for |:hardcopy|.
5762 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763
5764 *'printheader'* *'pheader'*
5765'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 {only available when compiled with the |+printer|
5768 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005769 The format of the header produced in |:hardcopy| output.
5770 See |pheader-option|.
5771
5772 *'printmbcharset'* *'pmbcs'*
5773'printmbcharset' 'pmbcs' string (default "")
5774 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005775 {only available when compiled with the |+printer|
5776 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005777 The CJK character set to be used for CJK output from |:hardcopy|.
5778 See |pmbcs-option|.
5779
5780 *'printmbfont'* *'pmbfn'*
5781'printmbfont' 'pmbfn' string (default "")
5782 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005783 {only available when compiled with the |+printer|
5784 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005785 List of font names to be used for CJK output from |:hardcopy|.
5786 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005787
5788 *'printoptions'* *'popt'*
5789'printoptions' 'popt' string (default "")
5790 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005791 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005792 List of items that control the format of the output of |:hardcopy|.
5793 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005794
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005795 *'prompt'* *'noprompt'*
5796'prompt' boolean (default on)
5797 global
5798 When on a ":" prompt is used in Ex mode.
5799
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005800 *'pumheight'* *'ph'*
5801'pumheight' 'ph' number (default 0)
5802 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005803 Determines the maximum number of items to show in the popup menu for
5804 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005805 |ins-completion-menu|.
5806
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005807 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005808'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005809 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005810 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005811 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005812
Bram Moolenaard94464e2015-11-02 15:28:18 +01005813 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005814'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005815 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005816 {only available when compiled with the |+python/dyn|
5817 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005818 Specifies the name of the Python 2.x shared library. The default is
5819 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005820 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005821 This option cannot be set from a |modeline| or in the |sandbox|, for
5822 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005823
Bram Moolenaar94073162018-01-31 21:49:05 +01005824 *'pythonhome'*
5825'pythonhome' string (default "")
5826 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005827 {only available when compiled with the |+python/dyn|
5828 feature}
5829 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5830 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5831 which was specified at compile time, will be used for the Python 2.x
5832 home directory.
5833 Environment variables are expanded |:set_env|.
5834 This option cannot be set from a |modeline| or in the |sandbox|, for
5835 security reasons.
5836
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005837 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005838'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005839 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005840 {only available when compiled with the |+python3/dyn|
5841 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005842 Specifies the name of the Python 3 shared library. The default is
5843 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005844 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005845 This option cannot be set from a |modeline| or in the |sandbox|, for
5846 security reasons.
5847
Bram Moolenaar94073162018-01-31 21:49:05 +01005848 *'pythonthreehome'*
5849'pythonthreehome' string (default "")
5850 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005851 {only available when compiled with the |+python3/dyn|
5852 feature}
5853 Specifies the name of the Python 3 home directory. When
5854 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5855 PYTHON3_HOME, which was specified at compile time, will be used for
5856 the Python 3 home directory.
5857 Environment variables are expanded |:set_env|.
5858 This option cannot be set from a |modeline| or in the |sandbox|, for
5859 security reasons.
5860
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005861 *'pyxversion'* *'pyx'*
5862'pyxversion' 'pyx' number (default depends on the build)
5863 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005864 {only available when compiled with the |+python| or
5865 the |+python3| feature}
5866 Specifies the python version used for pyx* functions and commands
5867 |python_x|. The default value is as follows:
5868
5869 Compiled with Default ~
5870 |+python| and |+python3| 0
5871 only |+python| 2
5872 only |+python3| 3
5873
5874 Available values are 0, 2 and 3.
5875 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5876 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5877 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5878 to 2 if Python 2 is available.
5879 See also: |has-pythonx|
5880
5881 If Vim is compiled with only |+python| or |+python3| setting
5882 'pyxversion' has no effect. The pyx* functions and commands are
5883 always the same as the compiled version.
5884
5885 This option cannot be set from a |modeline| or in the |sandbox|, for
5886 security reasons.
5887
Bram Moolenaar677ee682005-01-27 14:41:15 +00005888 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005889'quoteescape' 'qe' string (default "\")
5890 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005891 The characters that are used to escape quotes in a string. Used for
5892 objects like a', a" and a` |a'|.
5893 When one of the characters in this option is found inside a string,
5894 the following character will be skipped. The default value makes the
5895 text "foo\"bar\\" considered to be one string.
5896
Bram Moolenaar071d4272004-06-13 20:20:40 +00005897 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5898'readonly' 'ro' boolean (default off)
5899 local to buffer
5900 If on, writes fail unless you use a '!'. Protects you from
5901 accidentally overwriting a file. Default on when Vim is started
5902 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005903 When using ":w!" the 'readonly' option is reset for the current
5904 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005905 When using the ":view" command the 'readonly' option is set for the
5906 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005907 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005908
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005909 *'redrawtime'* *'rdt'*
5910'redrawtime' 'rdt' number (default 2000)
5911 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005912 {only available when compiled with the |+reltime|
5913 feature}
5914 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005915 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005916 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005917 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005918 matches will be highlighted.
5919 For syntax highlighting the time applies per window. When over the
5920 limit syntax highlighting is disabled until |CTRL-L| is used.
5921 This is used to avoid that Vim hangs when using a very complicated
5922 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005923
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005924 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005925'regexpengine' 're' number (default 0)
5926 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005927 This selects the default regexp engine. |two-engines|
5928 The possible values are:
5929 0 automatic selection
5930 1 old engine
5931 2 NFA engine
5932 Note that when using the NFA engine and the pattern contains something
5933 that is not supported the pattern will not match. This is only useful
5934 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005935 Using automatic selection enables Vim to switch the engine, if the
5936 default engine becomes too costly. E.g., when the NFA engine uses too
5937 many states. This should prevent Vim from hanging on a combination of
5938 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005939
Bram Moolenaar64486672010-05-16 15:46:46 +02005940 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5941'relativenumber' 'rnu' boolean (default off)
5942 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005943 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005944 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005945 precede some vertical motion commands (e.g. j k + -) with, without
5946 having to calculate it yourself. Especially useful in combination with
5947 other commands (e.g. y d c < > gq gw =).
5948 When the 'n' option is excluded from 'cpoptions' a wrapped
5949 line will not use the column of line numbers (this is the default when
5950 'compatible' isn't set).
5951 The 'numberwidth' option can be used to set the room used for the line
5952 number.
5953 When a long, wrapped line doesn't start with the first character, '-'
5954 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005955 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5956 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005957
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005958 The number in front of the cursor line also depends on the value of
5959 'number', see |number_relativenumber| for all combinations of the two
5960 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005961
Bram Moolenaar071d4272004-06-13 20:20:40 +00005962 *'remap'* *'noremap'*
5963'remap' boolean (default on)
5964 global
5965 Allows for mappings to work recursively. If you do not want this for
5966 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005967 NOTE: To avoid portability problems with Vim scripts, always keep
5968 this option at the default "on". Only switch it off when working with
5969 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005970
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005971 *'renderoptions'* *'rop'*
5972'renderoptions' 'rop' string (default: empty)
5973 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005974 {only available when compiled with GUI and DIRECTX on
5975 MS-Windows}
5976 Select a text renderer and set its options. The options depend on the
5977 renderer.
5978
5979 Syntax: >
5980 set rop=type:{renderer}(,{name}:{value})*
5981<
5982 Currently, only one optional renderer is available.
5983
5984 render behavior ~
5985 directx Vim will draw text using DirectX (DirectWrite). It makes
5986 drawn glyphs more beautiful than default GDI.
5987 It requires 'encoding' is "utf-8", and only works on
5988 MS-Windows Vista or newer version.
5989
5990 Options:
5991 name meaning type value ~
5992 gamma gamma float 1.0 - 2.2 (maybe)
5993 contrast enhancedContrast float (unknown)
5994 level clearTypeLevel float (unknown)
5995 geom pixelGeometry int 0 - 2 (see below)
5996 renmode renderingMode int 0 - 6 (see below)
5997 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005998 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005999
Bram Moolenaar92467d32017-12-05 13:22:16 +01006000 See this URL for detail (except for scrlines):
6001 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006002
6003 For geom: structure of a device pixel.
6004 0 - DWRITE_PIXEL_GEOMETRY_FLAT
6005 1 - DWRITE_PIXEL_GEOMETRY_RGB
6006 2 - DWRITE_PIXEL_GEOMETRY_BGR
6007
6008 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006009 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006010
6011 For renmode: method of rendering glyphs.
6012 0 - DWRITE_RENDERING_MODE_DEFAULT
6013 1 - DWRITE_RENDERING_MODE_ALIASED
6014 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
6015 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
6016 4 - DWRITE_RENDERING_MODE_NATURAL
6017 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
6018 6 - DWRITE_RENDERING_MODE_OUTLINE
6019
6020 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006021 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006022
6023 For taamode: antialiasing mode used for drawing text.
6024 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6025 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6026 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6027 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6028
6029 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006030 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6031
Bram Moolenaara338adc2018-01-31 20:51:47 +01006032 For scrlines:
6033 This was used for optimizing scrolling behavior, however this
6034 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006035
6036 Example: >
6037 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006038 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006039 set rop=type:directx
6040<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006041 If select a raster font (Courier, Terminal or FixedSys which
6042 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006043 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006044
6045 NOTE: It is known that some fonts and options combination
6046 causes trouble on drawing glyphs.
6047
Bram Moolenaar92467d32017-12-05 13:22:16 +01006048 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006049 special made fonts (True-Type fonts which includes only
6050 bitmap glyphs).
6051 - 'taamode:3' will not work with some vector fonts.
6052
6053 NOTE: With this option, you can display colored emoji
6054 (emoticon) in Windows 8.1 or later. To display colored emoji,
6055 there are some conditions which you should notice.
6056
6057 - If your font includes non-colored emoji already, it will
6058 be used.
6059 - If your font doesn't have emoji, the system chooses an
6060 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6061 will be used.
6062 - When this alternative font didn't have fixed width glyph,
6063 emoji might be rendered beyond the bounding box of drawing
6064 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006065
6066 Other render types are currently not supported.
6067
Bram Moolenaar071d4272004-06-13 20:20:40 +00006068 *'report'*
6069'report' number (default 2)
6070 global
6071 Threshold for reporting number of lines changed. When the number of
6072 changed lines is more than 'report' a message will be given for most
6073 ":" commands. If you want it always, set 'report' to 0.
6074 For the ":substitute" command the number of substitutions is used
6075 instead of the number of lines.
6076
6077 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6078'restorescreen' 'rs' boolean (default on)
6079 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006080 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006081 When set, the screen contents is restored when exiting Vim. This also
6082 happens when executing external commands.
6083
6084 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6085 options in your .vimrc. To disable restoring:
6086 set t_ti= t_te=
6087 To enable restoring (for an xterm):
6088 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6089 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6090
6091 *'revins'* *'ri'* *'norevins'* *'nori'*
6092'revins' 'ri' boolean (default off)
6093 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006094 {only available when compiled with the |+rightleft|
6095 feature}
6096 Inserting characters in Insert mode will work backwards. See "typing
6097 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6098 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006099 NOTE: This option is reset when 'compatible' is set.
6100 This option is reset when 'paste' is set and restored when 'paste' is
6101 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006102
6103 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6104'rightleft' 'rl' boolean (default off)
6105 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006106 {only available when compiled with the |+rightleft|
6107 feature}
6108 When on, display orientation becomes right-to-left, i.e., characters
6109 that are stored in the file appear from the right to the left.
6110 Using this option, it is possible to edit files for languages that
6111 are written from the right to the left such as Hebrew and Arabic.
6112 This option is per window, so it is possible to edit mixed files
6113 simultaneously, or to view the same file in both ways (this is
6114 useful whenever you have a mixed text file with both right-to-left
6115 and left-to-right strings so that both sets are displayed properly
6116 in different windows). Also see |rileft.txt|.
6117
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006118 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006119'rightleftcmd' 'rlc' string (default "search")
6120 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 {only available when compiled with the |+rightleft|
6122 feature}
6123 Each word in this option enables the command line editing to work in
6124 right-to-left mode for a group of commands:
6125
6126 search "/" and "?" commands
6127
6128 This is useful for languages such as Hebrew, Arabic and Farsi.
6129 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6130
Bram Moolenaard94464e2015-11-02 15:28:18 +01006131 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006132'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006133 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006134 {only available when compiled with the |+ruby/dyn|
6135 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006136 Specifies the name of the Ruby shared library. The default is
6137 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006138 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006139 This option cannot be set from a |modeline| or in the |sandbox|, for
6140 security reasons.
6141
Bram Moolenaar071d4272004-06-13 20:20:40 +00006142 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006143'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006145 {not available when compiled without the
6146 |+cmdline_info| feature}
6147 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006148 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006149 text in the file is shown on the far right:
6150 Top first line is visible
6151 Bot last line is visible
6152 All first and last line are visible
6153 45% relative position in the file
6154 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006155 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006156 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006157 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006158 this option takes precedence over 'ruler' and 'rulerformat'
6159 If the number of characters displayed is different from the number of
6160 bytes in the text (e.g., for a TAB or a multi-byte character), both
6161 the text column (byte number) and the screen column are shown,
6162 separated with a dash.
6163 For an empty line "0-1" is shown.
6164 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006165 This option is reset when 'paste' is set and restored when 'paste' is
6166 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006167 If you don't want to see the ruler all the time but want to know where
6168 you are, use "g CTRL-G" |g_CTRL-G|.
6169 NOTE: This option is reset when 'compatible' is set.
6170
6171 *'rulerformat'* *'ruf'*
6172'rulerformat' 'ruf' string (default empty)
6173 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006174 {not available when compiled without the |+statusline|
6175 feature}
6176 When this option is not empty, it determines the content of the ruler
6177 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006178 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006179 This option cannot be set in a modeline when 'modelineexpr' is off.
6180
Bram Moolenaar071d4272004-06-13 20:20:40 +00006181 The default ruler width is 17 characters. To make the ruler 15
6182 characters wide, put "%15(" at the start and "%)" at the end.
6183 Example: >
6184 :set rulerformat=%15(%c%V\ %p%%%)
6185<
6186 *'runtimepath'* *'rtp'* *vimfiles*
6187'runtimepath' 'rtp' string (default:
6188 Unix: "$HOME/.vim,
6189 $VIM/vimfiles,
6190 $VIMRUNTIME,
6191 $VIM/vimfiles/after,
6192 $HOME/.vim/after"
6193 Amiga: "home:vimfiles,
6194 $VIM/vimfiles,
6195 $VIMRUNTIME,
6196 $VIM/vimfiles/after,
6197 home:vimfiles/after"
6198 PC, OS/2: "$HOME/vimfiles,
6199 $VIM/vimfiles,
6200 $VIMRUNTIME,
6201 $VIM/vimfiles/after,
6202 $HOME/vimfiles/after"
6203 Macintosh: "$VIM:vimfiles,
6204 $VIMRUNTIME,
6205 $VIM:vimfiles:after"
6206 RISC-OS: "Choices:vimfiles,
6207 $VIMRUNTIME,
6208 Choices:vimfiles/after"
6209 VMS: "sys$login:vimfiles,
6210 $VIM/vimfiles,
6211 $VIMRUNTIME,
6212 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006213 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006215 This is a list of directories which will be searched for runtime
6216 files:
6217 filetype.vim filetypes by file name |new-filetype|
6218 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006219 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006220 colors/ color scheme files |:colorscheme|
6221 compiler/ compiler files |:compiler|
6222 doc/ documentation |write-local-help|
6223 ftplugin/ filetype plugins |write-filetype-plugin|
6224 indent/ indent scripts |indent-expression|
6225 keymap/ key mapping files |mbyte-keymap|
6226 lang/ menu translations |:menutrans|
6227 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006228 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 plugin/ plugin scripts |write-plugin|
6230 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006231 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006232 syntax/ syntax files |mysyntaxfile|
6233 tutor/ files for vimtutor |tutor|
6234
6235 And any other file searched for with the |:runtime| command.
6236
6237 The defaults for most systems are setup to search five locations:
6238 1. In your home directory, for your personal preferences.
6239 2. In a system-wide Vim directory, for preferences from the system
6240 administrator.
6241 3. In $VIMRUNTIME, for files distributed with Vim.
6242 *after-directory*
6243 4. In the "after" directory in the system-wide Vim directory. This is
6244 for the system administrator to overrule or add to the distributed
6245 defaults (rarely needed)
6246 5. In the "after" directory in your home directory. This is for
6247 personal preferences to overrule or add to the distributed defaults
6248 or system-wide settings (rarely needed).
6249
Bram Moolenaard0796902016-09-16 20:02:31 +02006250 More entries are added when using |packages|. If it gets very long
6251 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6252 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006253
Bram Moolenaar071d4272004-06-13 20:20:40 +00006254 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6255 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006256 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006257 wildcards.
6258 See |:runtime|.
6259 Example: >
6260 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6261< This will use the directory "~/vimruntime" first (containing your
6262 personal Vim runtime files), then "/mygroup/vim" (shared between a
6263 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6264 files).
6265 You probably should always include $VIMRUNTIME somewhere, to use the
6266 distributed runtime files. You can put a directory before $VIMRUNTIME
6267 to find files which replace a distributed runtime files. You can put
6268 a directory after $VIMRUNTIME to find files which add to distributed
6269 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006270 When Vim is started with |--clean| the home directory entries are not
6271 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 This option cannot be set from a |modeline| or in the |sandbox|, for
6273 security reasons.
6274
6275 *'scroll'* *'scr'*
6276'scroll' 'scr' number (default: half the window height)
6277 local to window
6278 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6279 set to half the number of lines in the window when the window size
6280 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006281 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006282 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283
6284 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6285'scrollbind' 'scb' boolean (default off)
6286 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 See also |scroll-binding|. When this option is set, the current
6288 window scrolls as other scrollbind windows (windows that also have
6289 this option set) scroll. This option is useful for viewing the
6290 differences between two versions of a file, see 'diff'.
6291 See |'scrollopt'| for options that determine how this option should be
6292 interpreted.
6293 This option is mostly reset when splitting a window to edit another
6294 file. This means that ":split | edit file" results in two windows
6295 with scroll-binding, but ":split file" does not.
6296
Bram Moolenaarae20f342019-11-05 21:09:23 +01006297 *'scrollfocus'* *'scf'* *'noscrollfocus'* *'noscf'*
6298'scrollfocus' 'scf' boolean (default off)
6299 global
6300 {only for MS-Windows GUI}
6301 When using the scroll wheel and this option is set, the window under
6302 the mouse pointer is scrolled. With this option off the current
6303 window is scrolled.
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006304 Systems other than MS-Windows always behave like this option is on.
Bram Moolenaarae20f342019-11-05 21:09:23 +01006305
Bram Moolenaar071d4272004-06-13 20:20:40 +00006306 *'scrolljump'* *'sj'*
6307'scrolljump' 'sj' number (default 1)
6308 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006309 Minimal number of lines to scroll when the cursor gets off the
6310 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6311 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006312 When set to a negative number from -1 to -100 this is used as the
6313 percentage of the window height. Thus -50 scrolls half the window
6314 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006315 NOTE: This option is set to 1 when 'compatible' is set.
6316
6317 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006318'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006319 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006320 Minimal number of screen lines to keep above and below the cursor.
6321 This will make some context visible around where you are working. If
6322 you set it to a very large value (999) the cursor line will always be
6323 in the middle of the window (except at the start or end of the file or
6324 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006325 After using the local value, go back the global value with one of
6326 these two: >
6327 setlocal scrolloff<
6328 setlocal scrolloff=-1
6329< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006330 NOTE: This option is set to 0 when 'compatible' is set.
6331
6332 *'scrollopt'* *'sbo'*
6333'scrollopt' 'sbo' string (default "ver,jump")
6334 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006335 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006336 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6337 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006338 The following words are available:
6339 ver Bind vertical scrolling for 'scrollbind' windows
6340 hor Bind horizontal scrolling for 'scrollbind' windows
6341 jump Applies to the offset between two windows for vertical
6342 scrolling. This offset is the difference in the first
6343 displayed line of the bound windows. When moving
6344 around in a window, another 'scrollbind' window may
6345 reach a position before the start or after the end of
6346 the buffer. The offset is not changed though, when
6347 moving back the 'scrollbind' window will try to scroll
6348 to the desired position when possible.
6349 When now making that window the current one, two
6350 things can be done with the relative offset:
6351 1. When "jump" is not included, the relative offset is
6352 adjusted for the scroll position in the new current
6353 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006354 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006355 2. When "jump" is included, the other windows are
6356 scrolled to keep the same relative offset. When
6357 going back to the other window, it still uses the
6358 same relative offset.
6359 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006360 When 'diff' mode is active there always is vertical scroll binding,
6361 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006362
6363 *'sections'* *'sect'*
6364'sections' 'sect' string (default "SHNHH HUnhsh")
6365 global
6366 Specifies the nroff macros that separate sections. These are pairs of
6367 two letters (See |object-motions|). The default makes a section start
6368 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6369
6370 *'secure'* *'nosecure'* *E523*
6371'secure' boolean (default off)
6372 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006373 When on, ":autocmd", shell and write commands are not allowed in
6374 ".vimrc" and ".exrc" in the current directory and map commands are
6375 displayed. Switch it off only if you know that you will not run into
6376 problems, or when the 'exrc' option is off. On Unix this option is
6377 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006378 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006379 'secure' at the end of your ~/.vimrc then.
6380 This option cannot be set from a |modeline| or in the |sandbox|, for
6381 security reasons.
6382
6383 *'selection'* *'sel'*
6384'selection' 'sel' string (default "inclusive")
6385 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 This option defines the behavior of the selection. It is only used
6387 in Visual and Select mode.
6388 Possible values:
6389 value past line inclusive ~
6390 old no yes
6391 inclusive yes yes
6392 exclusive yes no
6393 "past line" means that the cursor is allowed to be positioned one
6394 character past the line.
6395 "inclusive" means that the last character of the selection is included
6396 in an operation. For example, when "x" is used to delete the
6397 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006398 When "old" is used and 'virtualedit' allows the cursor to move past
6399 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006400 Note that when "exclusive" is used and selecting from the end
6401 backwards, you cannot include the last character of a line, when
6402 starting in Normal mode and 'virtualedit' empty.
6403
6404 The 'selection' option is set by the |:behave| command.
6405
6406 *'selectmode'* *'slm'*
6407'selectmode' 'slm' string (default "")
6408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006409 This is a comma separated list of words, which specifies when to start
6410 Select mode instead of Visual mode, when a selection is started.
6411 Possible values:
6412 mouse when using the mouse
6413 key when using shifted special keys
6414 cmd when using "v", "V" or CTRL-V
6415 See |Select-mode|.
6416 The 'selectmode' option is set by the |:behave| command.
6417
6418 *'sessionoptions'* *'ssop'*
6419'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006420 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006421 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006422 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006423 feature}
6424 Changes the effect of the |:mksession| command. It is a comma
6425 separated list of words. Each word enables saving and restoring
6426 something:
6427 word save and restore ~
6428 blank empty windows
6429 buffers hidden and unloaded buffers, not just those in windows
6430 curdir the current directory
6431 folds manually created folds, opened/closed folds and local
6432 fold options
6433 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006434 and contain at least one lowercase letter. Only
6435 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006436 help the help window
6437 localoptions options and mappings local to a window or buffer (not
6438 global values for local options)
6439 options all options and mappings (also global values for local
6440 options)
6441 resize size of the Vim window: 'lines' and 'columns'
6442 sesdir the directory in which the session file is located
6443 will become the current directory (useful with
6444 projects accessed over a network from different
6445 systems)
6446 slash backslashes in file names replaced with forward
6447 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006448 tabpages all tab pages; without this only the current tab page
6449 is restored, so that you can make a session for each
6450 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006451 terminal include terminal windows where the command can be
6452 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006453 unix with Unix end-of-line format (single <NL>), even when
6454 on Windows or DOS
6455 winpos position of the whole Vim window
6456 winsize window sizes
6457
6458 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006459 When neither "curdir" nor "sesdir" is included, file names are stored
6460 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006461 "slash" and "unix" are useful on Windows when sharing session files
6462 with Unix. The Unix version of Vim cannot source dos format scripts,
6463 but the Windows version of Vim can source unix format scripts.
6464
6465 *'shell'* *'sh'* *E91*
6466'shell' 'sh' string (default $SHELL or "sh",
6467 MS-DOS and Win32: "command.com" or
6468 "cmd.exe", OS/2: "cmd")
6469 global
6470 Name of the shell to use for ! and :! commands. When changing the
6471 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6472 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006473 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006474 See |option-backslash| about including spaces and backslashes.
6475 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006476
Bram Moolenaar1ff14ba2019-11-02 14:09:23 +01006477 If the name of the shell contains a space, you need to enclose it in
Bram Moolenaar5ef1c6a2019-11-10 22:09:11 +01006478 quotes and escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006479 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6480< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006481 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006482 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006483 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006484 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006485 Example with escaped space (Vim will do this when initializing the
6486 option from $SHELL): >
6487 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006488< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006489 backslashes are consumed by `:set`.
6490
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 Under MS-Windows, when the executable ends in ".com" it must be
6492 included. Thus setting the shell to "command.com" or "4dos.com"
6493 works, but "command" and "4dos" do not work for all commands (e.g.,
6494 filtering).
6495 For unknown reasons, when using "4dos.com" the current directory is
6496 changed to "C:\". To avoid this set 'shell' like this: >
6497 :set shell=command.com\ /c\ 4dos
6498< This option cannot be set from a |modeline| or in the |sandbox|, for
6499 security reasons.
6500
6501 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006502'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006503 MS-DOS and Win32, when 'shell' does not
6504 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006505 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006506 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6507 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6508 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006509 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006510 On Unix it can have more than one flag. Each white space separated
6511 part is passed as an argument to the shell command.
6512 See |option-backslash| about including spaces and backslashes.
6513 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006514 This option cannot be set from a |modeline| or in the |sandbox|, for
6515 security reasons.
6516
6517 *'shellpipe'* *'sp'*
6518'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6519 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006520 {not available when compiled without the |+quickfix|
6521 feature}
6522 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006523 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006524 including spaces and backslashes.
6525 The name of the temporary file can be represented by "%s" if necessary
6526 (the file name is appended automatically if no %s appears in the value
6527 of this option).
6528 For the Amiga and MS-DOS the default is ">". The output is directly
6529 saved in a file and not echoed to the screen.
6530 For Unix the default it "| tee". The stdout of the compiler is saved
6531 in a file and echoed to the screen. If the 'shell' option is "csh" or
6532 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006533 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6534 "bash" or "fish" the default becomes "2>&1| tee". This means that
6535 stderr is also included. Before using the 'shell' option a path is
6536 removed, thus "/bin/sh" uses "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 The initialization of this option is done after reading the ".vimrc"
6538 and the other initializations, so that when the 'shell' option is set
6539 there, the 'shellpipe' option changes automatically, unless it was
6540 explicitly set before.
6541 When 'shellpipe' is set to an empty string, no redirection of the
6542 ":make" output will be done. This is useful if you use a 'makeprg'
6543 that writes to 'makeef' by itself. If you want no piping, but do
6544 want to include the 'makeef', set 'shellpipe' to a single space.
6545 Don't forget to precede the space with a backslash: ":set sp=\ ".
6546 In the future pipes may be used for filtering and this option will
6547 become obsolete (at least for Unix).
6548 This option cannot be set from a |modeline| or in the |sandbox|, for
6549 security reasons.
6550
6551 *'shellquote'* *'shq'*
6552'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6553 contains "sh" somewhere: "\"")
6554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006555 Quoting character(s), put around the command passed to the shell, for
6556 the "!" and ":!" commands. The redirection is kept outside of the
6557 quoting. See 'shellxquote' to include the redirection. It's
6558 probably not useful to set both options.
6559 This is an empty string by default. Only known to be useful for
6560 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6561 or bash, where it should be "\"". The default is adjusted according
6562 the value of 'shell', to reduce the need to set this option by the
6563 user. See |dos-shell|.
6564 This option cannot be set from a |modeline| or in the |sandbox|, for
6565 security reasons.
6566
6567 *'shellredir'* *'srr'*
6568'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6569 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006570 String to be used to put the output of a filter command in a temporary
6571 file. See also |:!|. See |option-backslash| about including spaces
6572 and backslashes.
6573 The name of the temporary file can be represented by "%s" if necessary
6574 (the file name is appended automatically if no %s appears in the value
6575 of this option).
Bram Moolenaar96f45c02019-10-26 19:53:45 +02006576 The default is ">". For Unix, if the 'shell' option is "csh" or
6577 "tcsh" during initializations, the default becomes ">&". If the
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01006578 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh", "zsh-beta",
6579 "bash" or "fish", the default becomes ">%s 2>&1". This means that
6580 stderr is also included. For Win32, the Unix checks are done and
6581 additionally "cmd" is checked for, which makes the default ">%s 2>&1".
6582 Also, the same names with ".exe" appended are checked for.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006583 The initialization of this option is done after reading the ".vimrc"
6584 and the other initializations, so that when the 'shell' option is set
6585 there, the 'shellredir' option changes automatically unless it was
6586 explicitly set before.
6587 In the future pipes may be used for filtering and this option will
6588 become obsolete (at least for Unix).
6589 This option cannot be set from a |modeline| or in the |sandbox|, for
6590 security reasons.
6591
6592 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6593'shellslash' 'ssl' boolean (default off)
6594 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006595 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006596 When set, a forward slash is used when expanding file names. This is
6597 useful when a Unix-like shell is used instead of command.com or
6598 cmd.exe. Backward slashes can still be typed, but they are changed to
6599 forward slashes by Vim.
6600 Note that setting or resetting this option has no effect for some
6601 existing file names, thus this option needs to be set before opening
6602 any file for best results. This might change in the future.
6603 'shellslash' only works when a backslash can be used as a path
6604 separator. To test if this is so use: >
6605 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006606< Also see 'completeslash'.
6607
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006608 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6609'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6610 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006611 When on, use temp files for shell commands. When off use a pipe.
6612 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006613 Currently a pipe is only supported on Unix and MS-Windows 2K and
6614 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006615 :if has("filterpipe")
6616< The advantage of using a pipe is that nobody can read the temp file
6617 and the 'shell' command does not need to support redirection.
6618 The advantage of using a temp file is that the file type and encoding
6619 can be detected.
6620 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6621 |FilterWritePost| autocommands event are not triggered when
6622 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006623 The `system()` function does not respect this option and always uses
6624 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006625 NOTE: This option is set to the Vim default value when 'compatible'
6626 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006627
Bram Moolenaar071d4272004-06-13 20:20:40 +00006628 *'shelltype'* *'st'*
6629'shelltype' 'st' number (default 0)
6630 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006631 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006632 On the Amiga this option influences the way how the commands work
6633 which use a shell.
6634 0 and 1: always use the shell
6635 2 and 3: use the shell only to filter lines
6636 4 and 5: use shell only for ':sh' command
6637 When not using the shell, the command is executed directly.
6638
6639 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6640 1 and 3: use "shell cmd" to start external commands
6641
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006642 *'shellxescape'* *'sxe'*
6643'shellxescape' 'sxe' string (default: "";
6644 for MS-DOS and MS-Windows: "\"&|<>()@^")
6645 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006646 When 'shellxquote' is set to "(" then the characters listed in this
6647 option will be escaped with a '^' character. This makes it possible
6648 to execute most external commands with cmd.exe.
6649
Bram Moolenaar071d4272004-06-13 20:20:40 +00006650 *'shellxquote'* *'sxq'*
6651'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006652 for Win32, when 'shell' is cmd.exe: "("
6653 for Win32, when 'shell' contains "sh"
6654 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 for Unix, when using system(): "\"")
6656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006657 Quoting character(s), put around the command passed to the shell, for
6658 the "!" and ":!" commands. Includes the redirection. See
6659 'shellquote' to exclude the redirection. It's probably not useful
6660 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006661 When the value is '(' then ')' is appended. When the value is '"('
6662 then ')"' is appended.
6663 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006664 This is an empty string by default on most systems, but is known to be
6665 useful for on Win32 version, either for cmd.exe which automatically
6666 strips off the first and last quote on a command, or 3rd-party shells
6667 such as the MKS Korn Shell or bash, where it should be "\"". The
6668 default is adjusted according the value of 'shell', to reduce the need
6669 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006670 This option cannot be set from a |modeline| or in the |sandbox|, for
6671 security reasons.
6672
6673 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6674'shiftround' 'sr' boolean (default off)
6675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006676 Round indent to multiple of 'shiftwidth'. Applies to > and <
6677 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6678 a multiple of 'shiftwidth' (this is Vi compatible).
6679 NOTE: This option is reset when 'compatible' is set.
6680
6681 *'shiftwidth'* *'sw'*
6682'shiftwidth' 'sw' number (default 8)
6683 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006684 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006685 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006686 When zero the 'ts' value will be used. Use the |shiftwidth()|
6687 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688
6689 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006690'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6691 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006692 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006693 This option helps to avoid all the |hit-enter| prompts caused by file
6694 messages, for example with CTRL-G, and to avoid some other messages.
6695 It is a list of flags:
6696 flag meaning when present ~
6697 f use "(3 of 5)" instead of "(file 3 of 5)"
6698 i use "[noeol]" instead of "[Incomplete last line]"
6699 l use "999L, 888C" instead of "999 lines, 888 characters"
6700 m use "[+]" instead of "[Modified]"
6701 n use "[New]" instead of "[New File]"
6702 r use "[RO]" instead of "[readonly]"
6703 w use "[w]" instead of "written" for file write message
6704 and "[a]" instead of "appended" for ':w >> file' command
6705 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6706 "[unix format]" and "[mac]" instead of "[mac format]".
6707 a all of the above abbreviations
6708
6709 o overwrite message for writing a file with subsequent message
6710 for reading a file (useful for ":wn" or when 'autowrite' on)
6711 O message for reading a file overwrites any previous message.
6712 Also for quickfix message (e.g., ":cn").
6713 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006714 hit TOP, continuing at BOTTOM" messages; when using the search
6715 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006716 t truncate file message at the start if it is too long to fit
6717 on the command-line, "<" will appear in the left most column.
6718 Ignored in Ex mode.
6719 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006720 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006721 Ignored in Ex mode.
6722 W don't give "written" or "[w]" when writing a file
6723 A don't give the "ATTENTION" message when an existing swap file
6724 is found.
6725 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006726 c don't give |ins-completion-menu| messages. For example,
6727 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6728 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006729 q use "recording" instead of "recording @a"
6730 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006731 was used for the command; note that this also affects messages
6732 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006733 S do not show search count message when searching, e.g.
6734 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735
6736 This gives you the opportunity to avoid that a change between buffers
6737 requires you to hit <Enter>, but still gives as useful a message as
6738 possible for the space available. To get the whole message that you
6739 would have got with 'shm' empty, use ":file!"
6740 Useful values:
6741 shm= No abbreviation of message.
6742 shm=a Abbreviation, but no loss of information.
6743 shm=at Abbreviation, and truncate message when necessary.
6744
6745 NOTE: This option is set to the Vi default value when 'compatible' is
6746 set and to the Vim default value when 'compatible' is reset.
6747
6748 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6749'shortname' 'sn' boolean (default off)
6750 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 Filenames are assumed to be 8 characters plus one extension of 3
6752 characters. Multiple dots in file names are not allowed. When this
6753 option is on, dots in file names are replaced with underscores when
6754 adding an extension (".~" or ".swp"). This option is not available
6755 for MS-DOS, because then it would always be on. This option is useful
6756 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6757 or crossdos. When running the Win32 GUI version under Win32s, this
6758 option is always on by default.
6759
6760 *'showbreak'* *'sbr'* *E595*
6761'showbreak' 'sbr' string (default "")
Bram Moolenaaree857022019-11-09 23:26:40 +01006762 global or local to window |global-local|
Bram Moolenaardb84e452010-08-15 13:50:43 +02006763 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 feature}
6765 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006766 values are "> " or "+++ ": >
6767 :set showbreak=>\
6768< Note the backslash to escape the trailing space. It's easier like
6769 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006770 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006771< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772 comma (in a future version the comma might be used to separate the
6773 part that is shown at the end and at the start of a line).
6774 The characters are highlighted according to the '@' flag in
6775 'highlight'.
6776 Note that tabs after the showbreak will be displayed differently.
6777 If you want the 'showbreak' to appear in between line numbers, add the
6778 "n" flag to 'cpoptions'.
Bram Moolenaaree857022019-11-09 23:26:40 +01006779 A window-local value overrules a global value. If the global value is
6780 set and you want no value in the current window use NONE: >
6781 :setlocal showbreak=NONE
6782<
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006784'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6785 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006786 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 {not available when compiled without the
6788 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006789 Show (partial) command in the last line of the screen. Set this
6790 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006791 In Visual mode the size of the selected area is shown:
6792 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006793 If the number of bytes is different it is also displayed: "2-6"
6794 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006795 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006796 - When selecting a block, the size in screen characters:
6797 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006798 NOTE: This option is set to the Vi default value when 'compatible' is
6799 set and to the Vim default value when 'compatible' is reset.
6800
6801 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6802'showfulltag' 'sft' boolean (default off)
6803 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006804 When completing a word in insert mode (see |ins-completion|) from the
6805 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006806 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006807 matched a C function, you can see a template for what arguments are
6808 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006809 Note that this doesn't work well together with having "longest" in
6810 'completeopt', because the completion from the search pattern may not
6811 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006812
6813 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6814'showmatch' 'sm' boolean (default off)
6815 global
6816 When a bracket is inserted, briefly jump to the matching one. The
6817 jump is only done if the match can be seen on the screen. The time to
6818 show the match can be set with 'matchtime'.
6819 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006820 seen or not).
6821 This option is reset when 'paste' is set and restored when 'paste' is
6822 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006823 When the 'm' flag is not included in 'cpoptions', typing a character
6824 will immediately move the cursor back to where it belongs.
6825 See the "sm" field in 'guicursor' for setting the cursor shape and
6826 blinking when showing the match.
6827 The 'matchpairs' option can be used to specify the characters to show
6828 matches for. 'rightleft' and 'revins' are used to look for opposite
6829 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006830 Also see the matchparen plugin for highlighting the match when moving
6831 around |pi_paren.txt|.
6832 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006833
6834 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6835'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6836 global
6837 If in Insert, Replace or Visual mode put a message on the last line.
6838 Use the 'M' flag in 'highlight' to set the type of highlighting for
6839 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006840 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006841 doesn't mean XIM is really active, especially when 'imactivatekey' is
6842 not set.
6843 NOTE: This option is set to the Vi default value when 'compatible' is
6844 set and to the Vim default value when 'compatible' is reset.
6845
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006846 *'showtabline'* *'stal'*
6847'showtabline' 'stal' number (default 1)
6848 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006849 The value of this option specifies when the line with tab page labels
6850 will be displayed:
6851 0: never
6852 1: only if there are at least two tab pages
6853 2: always
6854 This is both for the GUI and non-GUI implementation of the tab pages
6855 line.
6856 See |tab-page| for more information about tab pages.
6857
Bram Moolenaar071d4272004-06-13 20:20:40 +00006858 *'sidescroll'* *'ss'*
6859'sidescroll' 'ss' number (default 0)
6860 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006861 The minimal number of columns to scroll horizontally. Used only when
6862 the 'wrap' option is off and the cursor is moved off of the screen.
6863 When it is zero the cursor will be put in the middle of the screen.
6864 When using a slow terminal set it to a large number or 0. When using
6865 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6866 commands.
6867
6868 *'sidescrolloff'* *'siso'*
6869'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006870 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006871 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006872 right of the cursor if 'nowrap' is set. Setting this option to a
6873 value greater than 0 while having |'sidescroll'| also at a non-zero
6874 value makes some context visible in the line you are scrolling in
6875 horizontally (except at beginning of the line). Setting this option
6876 to a large value (like 999) has the effect of keeping the cursor
6877 horizontally centered in the window, as long as one does not come too
6878 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006879 After using the local value, go back the global value with one of
6880 these two: >
6881 setlocal sidescrolloff<
6882 setlocal sidescrolloff=-1
6883< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006884
6885 Example: Try this together with 'sidescroll' and 'listchars' as
6886 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006887 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006888
6889 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6890 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006891<
6892 *'signcolumn'* *'scl'*
6893'signcolumn' 'scl' string (default "auto")
6894 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006895 {not available when compiled without the |+signs|
6896 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006897 Whether or not to draw the signcolumn. Valid values are:
6898 "auto" only when there is a sign to display
6899 "no" never
6900 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006901 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006902 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903
6904
6905 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6906'smartcase' 'scs' boolean (default off)
6907 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006908 Override the 'ignorecase' option if the search pattern contains upper
6909 case characters. Only used when the search pattern is typed and
6910 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006911 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006912 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6913 recalling the search pattern from history and hitting <Enter>.
6914 NOTE: This option is reset when 'compatible' is set.
6915
6916 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6917'smartindent' 'si' boolean (default off)
6918 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 {not available when compiled without the
6920 |+smartindent| feature}
6921 Do smart autoindenting when starting a new line. Works for C-like
6922 programs, but can also be used for other languages. 'cindent' does
6923 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006924 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006925 setting 'si' has no effect. 'indentexpr' is a more advanced
6926 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006927 Normally 'autoindent' should also be on when using 'smartindent'.
6928 An indent is automatically inserted:
6929 - After a line ending in '{'.
6930 - After a line starting with a keyword from 'cinwords'.
6931 - Before a line starting with '}' (only with the "O" command).
6932 When typing '}' as the first character in a new line, that line is
6933 given the same indent as the matching '{'.
6934 When typing '#' as the first character in a new line, the indent for
6935 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006936 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006937 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6938 When using the ">>" command, lines starting with '#' are not shifted
6939 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006940 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006941 This option is reset when 'paste' is set and restored when 'paste' is
6942 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006943
6944 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6945'smarttab' 'sta' boolean (default off)
6946 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006947 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006948 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6949 <BS> will delete a 'shiftwidth' worth of space at the start of the
6950 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006951 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006952 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6953 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006954 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006955 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006956 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006957 This option is reset when 'paste' is set and restored when 'paste' is
6958 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006959 NOTE: This option is reset when 'compatible' is set.
6960
6961 *'softtabstop'* *'sts'*
6962'softtabstop' 'sts' number (default 0)
6963 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006964 Number of spaces that a <Tab> counts for while performing editing
6965 operations, like inserting a <Tab> or using <BS>. It "feels" like
6966 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6967 used. This is useful to keep the 'ts' setting at its standard value
6968 of 8, while being able to edit like it is set to 'sts'. However,
6969 commands like "x" still work on the actual characters.
6970 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006971 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006972 'softtabstop' is set to 0 when the 'paste' option is set and restored
6973 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006974 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6975 spaces is minimized by using <Tab>s.
6976 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6977 set.
6978 NOTE: This option is set to 0 when 'compatible' is set.
6979
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006980 If Vim is compiled with the |+vartabs| feature then the value of
6981 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6982 anything other than an empty string.
6983
Bram Moolenaar217ad922005-03-20 22:37:15 +00006984 *'spell'* *'nospell'*
6985'spell' boolean (default off)
6986 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006987 {not available when compiled without the |+syntax|
6988 feature}
6989 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006990 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006991
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006992 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006993'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006994 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006995 {not available when compiled without the |+syntax|
6996 feature}
6997 Pattern to locate the end of a sentence. The following word will be
6998 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006999 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007000 When this check is not wanted make this option empty.
7001 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00007002 Be careful with special characters, see |option-backslash| about
7003 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007004 To set this option automatically depending on the language, see
7005 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007006
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007007 *'spellfile'* *'spf'*
7008'spellfile' 'spf' string (default empty)
7009 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007010 {not available when compiled without the |+syntax|
7011 feature}
7012 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00007013 commands. It must end in ".{encoding}.add". You need to include the
7014 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00007015 *E765*
7016 It may also be a comma separated list of names. A count before the
7017 |zg| and |zw| commands can be used to access each. This allows using
7018 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007019 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00007020 you: Using the first directory in 'runtimepath' that is writable. If
7021 there is no "spell" directory yet it will be created. For the file
7022 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00007023 ignoring the region.
7024 The resulting ".spl" file will be used for spell checking, it does not
7025 have to appear in 'spelllang'.
7026 Normally one file is used for all regions, but you can add the region
7027 name if you want to. However, it will then only be used when
7028 'spellfile' is set to it, for entries in 'spelllang' only files
7029 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00007030 This option cannot be set from a |modeline| or in the |sandbox|, for
7031 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007032
Bram Moolenaar217ad922005-03-20 22:37:15 +00007033 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00007034'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00007035 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007036 {not available when compiled without the |+syntax|
7037 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007038 A comma separated list of word list names. When the 'spell' option is
7039 on spellchecking will be done for these languages. Example: >
7040 set spelllang=en_us,nl,medical
7041< This means US English, Dutch and medical words are recognized. Words
7042 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007043 The word list name must consist of alphanumeric characters, a dash or
7044 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007045 recommended to separate the two letter language name from a
7046 specification. Thus "en-rare" is used for rare English words.
7047 A region name must come last and have the form "_xx", where "xx" is
7048 the two-letter, lower case region name. You can use more than one
7049 region by listing them: "en_us,en_ca" supports both US and Canadian
7050 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007051 Britain. (Note: currently en_au and en_nz dictionaries are older than
7052 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007053 If the name "cjk" is included East Asian characters are excluded from
7054 spell checking. This is useful when editing text that also has Asian
7055 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007056 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007057 As a special case the name of a .spl file can be given as-is. The
7058 first "_xx" in the name is removed and used as the region name
7059 (_xx is an underscore, two letters and followed by a non-letter).
7060 This is mainly for testing purposes. You must make sure the correct
7061 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007062 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007063 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7064 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007065 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007066
Bram Moolenaar98692072006-02-04 00:57:42 +00007067 If the |spellfile.vim| plugin is active and you use a language name
7068 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7069 will ask you if you want to download the file.
7070
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007071 After this option has been set successfully, Vim will source the files
7072 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007073 up to the first character that is not an ASCII letter or number and
7074 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007075
7076
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007077 *'spellsuggest'* *'sps'*
7078'spellsuggest' 'sps' string (default "best")
7079 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007080 {not available when compiled without the |+syntax|
7081 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007082 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007083 the |spellsuggest()| function. This is a comma-separated list of
7084 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007085
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007086 best Internal method that works best for English. Finds
7087 changes like "fast" and uses a bit of sound-a-like
7088 scoring to improve the ordering.
7089
7090 double Internal method that uses two methods and mixes the
7091 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007092 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007093 word. That only works when the language specifies
7094 sound folding. Can be slow and doesn't always give
7095 better results.
7096
7097 fast Internal method that only checks for simple changes:
7098 character inserts/deletes/swaps. Works well for
7099 simple typing mistakes.
7100
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007101 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007102 Not used for |spellsuggest()|. The number of
7103 suggestions is never more than the value of 'lines'
7104 minus two.
7105
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007106 file:{filename} Read file {filename}, which must have two columns,
7107 separated by a slash. The first column contains the
7108 bad word, the second column the suggested good word.
7109 Example:
7110 theribal/terrible ~
7111 Use this for common mistakes that do not appear at the
7112 top of the suggestion list with the internal methods.
7113 Lines without a slash are ignored, use this for
7114 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007115 The word in the second column must be correct,
7116 otherwise it will not be used. Add the word to an
7117 ".add" file if it is currently flagged as a spelling
7118 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007119 The file is used for all languages.
7120
7121 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7122 trouble with spaces. |v:val| holds the badly spelled
7123 word. The expression must evaluate to a List of
7124 Lists, each with a suggestion and a score.
7125 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007126 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007127 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007128 internal methods use. A lower score is better.
7129 This may invoke |spellsuggest()| if you temporarily
7130 set 'spellsuggest' to exclude the "expr:" part.
7131 Errors are silently ignored, unless you set the
7132 'verbose' option to a non-zero value.
7133
7134 Only one of "best", "double" or "fast" may be used. The others may
7135 appear several times in any order. Example: >
7136 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7137<
7138 This option cannot be set from a |modeline| or in the |sandbox|, for
7139 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007140
7141
Bram Moolenaar071d4272004-06-13 20:20:40 +00007142 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7143'splitbelow' 'sb' boolean (default off)
7144 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145 When on, splitting a window will put the new window below the current
7146 one. |:split|
7147
7148 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7149'splitright' 'spr' boolean (default off)
7150 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007151 When on, splitting a window will put the new window right of the
7152 current one. |:vsplit|
7153
7154 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7155'startofline' 'sol' boolean (default on)
7156 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007157 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007158 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007159 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007160 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007161 with a linewise operator, with "%" with a count and to buffer changing
7162 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7163 only has a line number, e.g., ":25" or ":+".
7164 In case of buffer changing commands the cursor is placed at the column
7165 where it was the last time the buffer was edited.
7166 NOTE: This option is set when 'compatible' is set.
7167
Bram Moolenaar00654022011-02-25 14:42:19 +01007168 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007170 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007171 {not available when compiled without the |+statusline|
7172 feature}
7173 When nonempty, this option determines the content of the status line.
7174 Also see |status-line|.
7175
7176 The option consists of printf style '%' items interspersed with
7177 normal text. Each status line item is of the form:
7178 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007179 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007180 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181
Bram Moolenaar238a5642006-02-21 22:12:05 +00007182 When the option starts with "%!" then it is used as an expression,
7183 evaluated and the result is used as the option value. Example: >
7184 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007185< The *g:statusline_winid* variable will be set to the |window-ID| of the
7186 window that the status line belongs to.
7187 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007188 Note that the "%!" expression is evaluated in the context of the
7189 current window and buffer, while %{} items are evaluated in the
7190 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007191
7192 When there is error while evaluating the option then it will be made
7193 empty to avoid further errors. Otherwise screen updating would loop.
7194
Bram Moolenaar071d4272004-06-13 20:20:40 +00007195 Note that the only effect of 'ruler' when this option is set (and
7196 'laststatus' is 2) is controlling the output of |CTRL-G|.
7197
7198 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007199 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007200 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007201 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 minwid Minimum width of the item, padding as set by '-' & '0'.
7203 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007204 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007205 on the left for text items. Numeric items will be
7206 shifted down to maxwid-2 digits followed by '>'number
7207 where number is the amount of missing digits, much like
7208 an exponential notation.
7209 item A one letter code as described below.
7210
7211 Following is a description of the possible statusline items. The
7212 second character in "item" is the type:
7213 N for number
7214 S for string
7215 F for flags as described below
7216 - not applicable
7217
7218 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007219 f S Path to the file in the buffer, as typed or relative to current
7220 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007221 F S Full path to the file in the buffer.
7222 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007223 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007224 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007225 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007226 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007227 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007228 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007229 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007230 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007231 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007232 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007233 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007234 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7235 being used: "<keymap>"
7236 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007237 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007238 B N As above, in hexadecimal.
7239 o N Byte number in file of byte under cursor, first byte is 1.
7240 Mnemonic: Offset from start of file (with one added)
7241 {not available when compiled without |+byte_offset| feature}
7242 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007243 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244 l N Line number.
7245 L N Number of lines in buffer.
7246 c N Column number.
7247 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007248 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007249 p N Percentage through file in lines as in |CTRL-G|.
7250 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007251 percentage described for 'ruler'. Always 3 in length, unless
7252 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007253 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007254 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007255 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007256 Note that there is no '%' before the closing '}'. The
7257 expression cannot contain a '}' character, call a function to
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007258 work around that. See |stl-%{| below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007259 ( - Start of item group. Can be used for setting the width and
7260 alignment of a section. Must be followed by %) somewhere.
7261 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007262 T N For 'tabline': start of tab page N label. Use %T after the last
7263 label. This information is used for mouse clicks.
7264 X N For 'tabline': start of close tab N label. Use %X after the
7265 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7266 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007267 < - Where to truncate line if too long. Default is at the start.
7268 No width fields allowed.
7269 = - Separation point between left and right aligned items.
7270 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007271 # - Set highlight group. The name must follow and then a # again.
7272 Thus use %#HLname# for highlight group HLname. The same
7273 highlighting is used, also for the statusline of non-current
7274 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007275 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007276 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 The difference between User{N} and StatusLine will be applied
7278 to StatusLineNC for the statusline of non-current windows.
7279 The number N must be between 1 and 9. See |hl-User1..9|
7280
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007281 When displaying a flag, Vim removes the leading comma, if any, when
7282 that flag comes right after plaintext. This will make a nice display
7283 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007284
Bram Moolenaar582fd852005-03-28 20:58:01 +00007285 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007286 not set) and a minwid is not set for the group, the whole group will
7287 become empty. This will make a group like the following disappear
7288 completely from the statusline when none of the flags are set. >
7289 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007290< Beware that an expression is evaluated each and every time the status
7291 line is displayed.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01007292 *stl-%{* *g:actual_curbuf* *g:actual_curwin*
7293 While evaluationg %{} the current buffer and current window will be
7294 set temporarily to that of the window (and buffer) whose statusline is
7295 currently being drawn. The expression will evaluate in this context.
7296 The variable "g:actual_curbuf" is set to the `bufnr()` number of the
7297 real current buffer and "g:actual_curwin" to the |window-ID| of the
7298 real current window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007299
Bram Moolenaar30b65812012-07-12 22:01:11 +02007300 The 'statusline' option will be evaluated in the |sandbox| if set from
7301 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007302 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007303
7304 It is not allowed to change text or jump to another window while
7305 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306
7307 If the statusline is not updated when you want it (e.g., after setting
7308 a variable that's used in an expression), you can force an update by
7309 setting an option without changing its value. Example: >
7310 :let &ro = &ro
7311
7312< A result of all digits is regarded a number for display purposes.
7313 Otherwise the result is taken as flag text and applied to the rules
7314 described above.
7315
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007316 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007317 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007318 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007319
7320 Examples:
7321 Emulate standard status line with 'ruler' set >
7322 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7323< Similar, but add ASCII value of char under the cursor (like "ga") >
7324 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7325< Display byte count and byte value, modified flag in red. >
7326 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7327 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7328< Display a ,GZ flag if a compressed file is loaded >
7329 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7330< In the |:autocmd|'s: >
7331 :let b:gzflag = 1
7332< And: >
7333 :unlet b:gzflag
7334< And define this function: >
7335 :function VarExists(var, val)
7336 : if exists(a:var) | return a:val | else | return '' | endif
7337 :endfunction
7338<
7339 *'suffixes'* *'su'*
7340'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7341 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007342 Files with these suffixes get a lower priority when multiple files
7343 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007344 suffixes. Spaces after the comma are ignored. A dot is also seen as
7345 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007346 separator, precede it with a backslash (see |option-backslash| about
7347 including spaces and backslashes).
7348 See 'wildignore' for completely ignoring files.
7349 The use of |:set+=| and |:set-=| is preferred when adding or removing
7350 suffixes from the list. This avoids problems when a future version
7351 uses another default.
7352
7353 *'suffixesadd'* *'sua'*
7354'suffixesadd' 'sua' string (default "")
7355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007356 {not available when compiled without the
7357 |+file_in_path| feature}
7358 Comma separated list of suffixes, which are used when searching for a
7359 file for the "gf", "[I", etc. commands. Example: >
7360 :set suffixesadd=.java
7361<
7362 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7363'swapfile' 'swf' boolean (default on)
7364 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007365 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007366 swapfile is not wanted for a specific buffer. For example, with
7367 confidential information that even root must not be able to access.
7368 Careful: All text will be in memory:
7369 - Don't use this for big files.
7370 - Recovery will be impossible!
7371 A swapfile will only be present when |'updatecount'| is non-zero and
7372 'swapfile' is set.
7373 When 'swapfile' is reset, the swap file for the current buffer is
7374 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7375 non-zero, a swap file is immediately created.
7376 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007377 If you want to open a new buffer without creating a swap file for it,
7378 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007379 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380
7381 This option is used together with 'bufhidden' and 'buftype' to
7382 specify special kinds of buffers. See |special-buffers|.
7383
7384 *'swapsync'* *'sws'*
7385'swapsync' 'sws' string (default "fsync")
7386 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007387 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007388 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007389 When this option is empty parts of the swap file may be in memory and
7390 not written to disk. When the system crashes you may lose more work.
7391 On Unix the system does a sync now and then without Vim asking for it,
7392 so the disadvantage of setting this option off is small. On some
7393 systems the swap file will not be written at all. For a unix system
7394 setting it to "sync" will use the sync() call instead of the default
7395 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007396 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397
7398 *'switchbuf'* *'swb'*
7399'switchbuf' 'swb' string (default "")
7400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007401 This option controls the behavior when switching between buffers.
7402 Possible values (comma separated list):
7403 useopen If included, jump to the first open window that
7404 contains the specified buffer (if there is one).
7405 Otherwise: Do not examine other windows.
7406 This setting is checked with |quickfix| commands, when
7407 jumping to errors (":cc", ":cn", "cp", etc.). It is
7408 also used in all buffer related split commands, for
7409 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007410 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007411 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007413 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007414 Otherwise: do not split, use current window (when used
7415 in the quickfix window: the previously used window or
7416 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007417 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007418 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007419 "split" when both are present.
Bram Moolenaar539aa6b2019-11-17 18:09:38 +01007420 uselast If included, jump to the previously used window when
7421 jumping to errors with |quickfix| commands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007422
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007423 *'synmaxcol'* *'smc'*
7424'synmaxcol' 'smc' number (default 3000)
7425 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007426 {not available when compiled without the |+syntax|
7427 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007428 Maximum column in which to search for syntax items. In long lines the
7429 text after this column is not highlighted and following lines may not
7430 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007431 This helps to avoid very slow redrawing for an XML file that is one
7432 long line.
7433 Set to zero to remove the limit.
7434
Bram Moolenaar071d4272004-06-13 20:20:40 +00007435 *'syntax'* *'syn'*
7436'syntax' 'syn' string (default empty)
7437 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007438 {not available when compiled without the |+syntax|
7439 feature}
7440 When this option is set, the syntax with this name is loaded, unless
7441 syntax highlighting has been switched off with ":syntax off".
7442 Otherwise this option does not always reflect the current syntax (the
7443 b:current_syntax variable does).
7444 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007445 not automatically recognized. Example, in an IDL file:
7446 /* vim: set syntax=idl : */ ~
7447 When a dot appears in the value then this separates two filetype
7448 names. Example:
7449 /* vim: set syntax=c.doxygen : */ ~
7450 This will use the "c" syntax first, then the "doxygen" syntax.
7451 Note that the second one must be prepared to be loaded as an addition,
7452 otherwise it will be skipped. More than one dot may appear.
7453 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007454 :set syntax=OFF
7455< To switch syntax highlighting on according to the current value of the
7456 'filetype' option: >
7457 :set syntax=ON
7458< What actually happens when setting the 'syntax' option is that the
7459 Syntax autocommand event is triggered with the value as argument.
7460 This option is not copied to another buffer, independent of the 's' or
7461 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007462 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007463
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007464 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007465'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007466 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007467 When nonempty, this option determines the content of the tab pages
7468 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007469 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007470
7471 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007472 option and only when there is no GUI tab line. When 'e' is in
7473 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007474 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007475
7476 The value is evaluated like with 'statusline'. You can use
7477 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007478 the text to be displayed. Use "%1T" for the first label, "%2T" for
7479 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007480
Bram Moolenaare12bab32019-01-08 22:02:56 +01007481 When changing something that is used in 'tabline' that does not
7482 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007483 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007484
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007485 Keep in mind that only one of the tab pages is the current one, others
7486 are invisible and you can't jump to their windows.
7487
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007488
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007489 *'tabpagemax'* *'tpm'*
7490'tabpagemax' 'tpm' number (default 10)
7491 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007492 Maximum number of tab pages to be opened by the |-p| command line
7493 argument or the ":tab all" command. |tabpage|
7494
7495
7496 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007497'tabstop' 'ts' number (default 8)
7498 local to buffer
7499 Number of spaces that a <Tab> in the file counts for. Also see
7500 |:retab| command, and 'softtabstop' option.
7501
7502 Note: Setting 'tabstop' to any other value than 8 can make your file
7503 appear wrong in many places (e.g., when printing it).
7504
7505 There are four main ways to use tabs in Vim:
7506 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7507 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007508 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007509 behave like a tab appears every 4 (or 3) characters.
7510 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7511 'expandtab'. This way you will always insert spaces. The
7512 formatting will never be messed up when 'tabstop' is changed.
7513 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007514 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007515 works when using Vim to edit the file.
7516 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7517 'noexpandtab'. This should then work (for initial indents only)
7518 for any tabstop setting that people use. It might be nice to have
7519 tabs after the first non-blank inserted as spaces if you do this
7520 though. Otherwise aligned comments will be wrong when 'tabstop' is
7521 changed.
7522
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007523 If Vim is compiled with the |+vartabs| feature then the value of
7524 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7525 than an empty string.
7526
Bram Moolenaar071d4272004-06-13 20:20:40 +00007527 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7528'tagbsearch' 'tbs' boolean (default on)
7529 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007531 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007532 searching makes searching for a tag a LOT faster, but a linear search
7533 will find more tags if the tags file wasn't properly sorted.
7534 Vim normally assumes that your tags files are sorted, or indicate that
7535 they are not sorted. Only when this is not the case does the
7536 'tagbsearch' option need to be switched off.
7537
7538 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007539 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007540 certain files, or retry all files with a linear search. When
7541 'tagbsearch' is off, only a linear search is done.
7542
7543 Linear searching is done anyway, for one file, when Vim finds a line
7544 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007545 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007546< [The whitespace before and after the '0' must be a single <Tab>]
7547
7548 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007549 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007550 instead of a normal tag name, a retry is done with a linear search.
7551 Tags in unsorted tags files, and matches with different case will only
7552 be found in the retry.
7553
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007554 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007555 linear search can be avoided when case is ignored. Use a value of '2'
7556 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7557 sorted with the -f switch to "sort" in most unices, as in the command:
7558 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7559 (at least 5.5) the --sort=foldcase switch can be used for this as
7560 well. Note that case must be folded to uppercase for this to work.
7561
7562 By default, tag searches are case-sensitive. Case is ignored when
7563 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7564 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007565 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7566 'tagcase' is "smart", and the pattern contains only lowercase
7567 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007568
7569 When 'tagbsearch' is off, tags searching is slower when a full match
7570 exists, but faster when no full match exists. Tags in unsorted tags
7571 files may only be found with 'tagbsearch' off.
7572 When the tags file is not sorted, or sorted in a wrong way (not on
7573 ASCII byte value), 'tagbsearch' should be off, or the line given above
7574 must be included in the tags file.
7575 This option doesn't affect commands that find all matching tags (e.g.,
7576 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007577
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007578 *'tagcase'* *'tc'*
7579'tagcase' 'tc' string (default "followic")
7580 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007581 This option specifies how case is handled when searching the tags
7582 file:
7583 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007584 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007585 ignore Ignore case
7586 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007587 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007588 NOTE: This option is set to the Vi default value when 'compatible' is
7589 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007590
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007591 *'tagfunc'* *'tfu'*
7592'tagfunc' 'tfu' string (default: empty)
7593 local to buffer
7594 {not available when compiled without the |+eval|
7595 feature}
7596 This option specifies a function to be used to perform tag searches.
7597 The function gets the tag pattern and should return a List of matching
7598 tags. See |tag-function| for an explanation of how to write the
7599 function and an example.
7600
Bram Moolenaar071d4272004-06-13 20:20:40 +00007601 *'taglength'* *'tl'*
7602'taglength' 'tl' number (default 0)
7603 global
7604 If non-zero, tags are significant up to this number of characters.
7605
7606 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7607'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7608 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007609 If on and using a tags file in another directory, file names in that
7610 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007611 NOTE: This option is set to the Vi default value when 'compatible' is
7612 set and to the Vim default value when 'compatible' is reset.
7613
7614 *'tags'* *'tag'* *E433*
7615'tags' 'tag' string (default "./tags,tags", when compiled with
7616 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7617 global or local to buffer |global-local|
7618 Filenames for the tag command, separated by spaces or commas. To
7619 include a space or comma in a file name, precede it with a backslash
7620 (see |option-backslash| about including spaces and backslashes).
7621 When a file name starts with "./", the '.' is replaced with the path
7622 of the current file. But only when the 'd' flag is not included in
7623 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7624 |tags-option|.
7625 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007626 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7627 find all files named "tags" below "/lib". The filename itself cannot
7628 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7629 files called "tags?". {not available when compiled without the
7630 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007631 The |tagfiles()| function can be used to get a list of the file names
7632 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007633 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7634 files are also supported. They are automatically recognized. The
7635 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7636 differences are ignored (MS-Windows). |emacs-tags|
7637 The use of |:set+=| and |:set-=| is preferred when adding or removing
7638 file names from the list. This avoids problems when a future version
7639 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007640
7641 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7642'tagstack' 'tgst' boolean (default on)
7643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 When on, the |tagstack| is used normally. When off, a ":tag" or
7645 ":tselect" command with an argument will not push the tag onto the
7646 tagstack. A following ":tag" without an argument, a ":pop" command or
7647 any other command that uses the tagstack will use the unmodified
7648 tagstack, but does change the pointer to the active entry.
7649 Resetting this option is useful when using a ":tag" command in a
7650 mapping which should not change the tagstack.
7651
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007652 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007653'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007654 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007655 {only available when compiled with the |+tcl/dyn|
7656 feature}
7657 Specifies the name of the Tcl shared library. The default is
7658 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007659 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007660 This option cannot be set from a |modeline| or in the |sandbox|, for
7661 security reasons.
7662
Bram Moolenaar071d4272004-06-13 20:20:40 +00007663 *'term'* *E529* *E530* *E531*
7664'term' string (default is $TERM, if that fails:
7665 in the GUI: "builtin_gui"
7666 on Amiga: "amiga"
7667 on BeOS: "beos-ansi"
7668 on Mac: "mac-ansi"
7669 on MiNT: "vt52"
7670 on MS-DOS: "pcterm"
7671 on OS/2: "os2ansi"
7672 on Unix: "ansi"
7673 on VMS: "ansi"
7674 on Win 32: "win32")
7675 global
7676 Name of the terminal. Used for choosing the terminal control
7677 characters. Environment variables are expanded |:set_env|.
7678 For example: >
7679 :set term=$TERM
7680< See |termcap|.
7681
7682 *'termbidi'* *'tbidi'*
7683 *'notermbidi'* *'notbidi'*
7684'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7685 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007686 {only available when compiled with the |+arabic|
7687 feature}
7688 The terminal is in charge of Bi-directionality of text (as specified
7689 by Unicode). The terminal is also expected to do the required shaping
7690 that some languages (such as Arabic) require.
7691 Setting this option implies that 'rightleft' will not be set when
7692 'arabic' is set and the value of 'arabicshape' will be ignored.
7693 Note that setting 'termbidi' has the immediate effect that
7694 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7695 This option is reset when the GUI is started.
7696 For further details see |arabic.txt|.
7697
7698 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007699'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007700 Macintosh GUI: "macroman")
7701 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007702 Encoding used for the terminal. This specifies what character
7703 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007704 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007705 display). Except for the Mac when 'macatsui' is off, then
7706 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007707 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007708 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007709 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7710 Any attempts to set a different value will be rejected, and an error
7711 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007712 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007713 because the Win32 system always passes Unicode characters.
7714 When empty, the same encoding is used as for the 'encoding' option.
7715 This is the normal value.
7716 Not all combinations for 'termencoding' and 'encoding' are valid. See
7717 |encoding-table|.
7718 The value for this option must be supported by internal conversions or
7719 iconv(). When this is not possible no conversion will be done and you
7720 will probably experience problems with non-ASCII characters.
7721 Example: You are working with the locale set to euc-jp (Japanese) and
7722 want to edit a UTF-8 file: >
7723 :let &termencoding = &encoding
7724 :set encoding=utf-8
7725< You need to do this when your system has no locale support for UTF-8.
7726
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007727 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007728'termguicolors' 'tgc' boolean (default off)
7729 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007730 {not available when compiled without the
7731 |+termguicolors| feature}
7732 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007733 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007734
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007735 Requires a ISO-8613-3 compatible terminal. If setting this option
7736 does not work (produces a colorless UI) reading |xterm-true-color|
7737 might help.
7738
7739 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7740 is required. Use this check to find out: >
7741 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007742< This requires Vim to be built with the |+vtp| feature.
7743
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007744 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007745 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007746
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007747 *'termwinkey'* *'twk'*
7748'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007749 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007750 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007751 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007752 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007753 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007754< The string must be one key stroke but can be multiple bytes.
7755 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007756 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007757 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007758
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007759 *'termwinscroll'* *'twsl'*
7760'termwinscroll' 'twsl' number (default 10000)
7761 local to buffer
7762 {not available when compiled without the
7763 |+terminal| feature}
7764 Number of scrollback lines to keep. When going over this limit the
7765 first 10% of the scrollback lines are deleted. This is just to reduce
7766 the memory usage. See |Terminal-Normal|.
7767
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007768 *'termwinsize'* *'tws'*
7769'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007770 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007771 Size of the |terminal| window. Format: {rows}x{columns} or
7772 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007773 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007774 - When set with a "x" (e.g., "24x80") the terminal size is not
7775 adjusted to the window size. If the window is smaller only the
7776 top-left part is displayed.
7777 - When set with a "*" (e.g., "10*50") the terminal size follows the
7778 window size, but will not be smaller than the specified rows and/or
7779 columns.
7780 - When rows is zero then use the height of the window.
7781 - When columns is zero then use the width of the window.
7782 - Using "0x0" or "0*0" is the same as empty.
7783
7784 Examples:
7785 "30x0" uses 30 rows and the current window width.
7786 "20*0" uses at least 20 rows and the current window width.
7787 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007788 Note that the command running in the terminal window may still change
7789 the size of the terminal. In that case the Vim window will be
7790 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007791
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007792 *'termwintype'* *'twt'*
7793'termwintype' 'twt' string (default "")
7794 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007795 {only available when compiled with the |terminal|
7796 feature on MS-Windows}
7797 Specify the virtual console (pty) used when opening the terminal
7798 window.
7799
7800 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007801 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007802 "winpty" use winpty, fail if not supported
7803 "conpty" use |ConPTY|, fail if not supported
7804
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007805 |ConPTY| support depends on the platform. Windows 10 October 2018
7806 Update is the first version that supports ConPTY, however it is still
7807 considered unstable. ConPTY might become stable in the next release
7808 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007809 supported then you cannot open a terminal window.
7810
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 *'terse'* *'noterse'*
7812'terse' boolean (default off)
7813 global
7814 When set: Add 's' flag to 'shortmess' option (this makes the message
7815 for a search that hits the start or end of the file not being
7816 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7817 shortens a lot of messages}
7818
7819 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7820'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7821 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007822 This option is obsolete. Use 'fileformats'.
7823 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7824 set to the default value for the current system. When 'textauto' is
7825 reset, 'fileformats' is made empty.
7826 NOTE: This option is set to the Vi default value when 'compatible' is
7827 set and to the Vim default value when 'compatible' is reset.
7828
7829 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7830'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7831 others: default off)
7832 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007833 This option is obsolete. Use 'fileformat'.
7834 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7835 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7836 "unix".
7837
7838 *'textwidth'* *'tw'*
7839'textwidth' 'tw' number (default 0)
7840 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007841 Maximum width of text that is being inserted. A longer line will be
7842 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007843 this.
7844 'textwidth' is set to 0 when the 'paste' option is set and restored
7845 when 'paste' is reset.
7846 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007847 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007848 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 NOTE: This option is set to 0 when 'compatible' is set.
7850
7851 *'thesaurus'* *'tsr'*
7852'thesaurus' 'tsr' string (default "")
7853 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007854 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007855 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7856
7857 Each line in the file should contain words with similar meaning,
7858 separated by non-keyword characters (white space is preferred).
7859 Maximum line length is 510 bytes.
7860
Bram Moolenaard47d5222018-12-09 20:43:55 +01007861 An English word list was added to this github issue:
7862 https://github.com/vim/vim/issues/629#issuecomment-443293282
7863 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7864 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7865 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007866
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007867 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007868 after a comma are ignored, otherwise spaces are included in the file
7869 name. See |option-backslash| about using backslashes.
7870 The use of |:set+=| and |:set-=| is preferred when adding or removing
7871 directories from the list. This avoids problems when a future version
7872 uses another default.
7873 Backticks cannot be used in this option for security reasons.
7874
7875 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7876'tildeop' 'top' boolean (default off)
7877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 When on: The tilde command "~" behaves like an operator.
7879 NOTE: This option is reset when 'compatible' is set.
7880
7881 *'timeout'* *'to'* *'notimeout'* *'noto'*
7882'timeout' 'to' boolean (default on)
7883 global
7884 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007885'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007886 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007887 These two options together determine the behavior when part of a
7888 mapped key sequence or keyboard code has been received:
7889
7890 'timeout' 'ttimeout' action ~
7891 off off do not time out
7892 on on or off time out on :mappings and key codes
7893 off on time out on key codes
7894
7895 If both options are off, Vim will wait until either the complete
7896 mapping or key sequence has been received, or it is clear that there
7897 is no mapping or key sequence for the received characters. For
7898 example: if you have mapped "vl" and Vim has received 'v', the next
7899 character is needed to see if the 'v' is followed by an 'l'.
7900 When one of the options is on, Vim will wait for about 1 second for
7901 the next character to arrive. After that the already received
7902 characters are interpreted as single characters. The waiting time can
7903 be changed with the 'timeoutlen' option.
7904 On slow terminals or very busy systems timing out may cause
7905 malfunctioning cursor keys. If both options are off, Vim waits
7906 forever after an entered <Esc> if there are key codes that start
7907 with <Esc>. You will have to type <Esc> twice. If you do not have
7908 problems with key codes, but would like to have :mapped key
7909 sequences not timing out in 1 second, set the 'ttimeout' option and
7910 reset the 'timeout' option.
7911
7912 NOTE: 'ttimeout' is reset when 'compatible' is set.
7913
7914 *'timeoutlen'* *'tm'*
7915'timeoutlen' 'tm' number (default 1000)
7916 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007917
Bram Moolenaar071d4272004-06-13 20:20:40 +00007918 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007919'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007920 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007921 The time in milliseconds that is waited for a key code or mapped key
7922 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7923 when part of a command has been typed.
7924 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7925 different timeout value for key codes is desired set 'ttimeoutlen' to
7926 a non-negative number.
7927
7928 ttimeoutlen mapping delay key code delay ~
7929 < 0 'timeoutlen' 'timeoutlen'
7930 >= 0 'timeoutlen' 'ttimeoutlen'
7931
7932 The timeout only happens when the 'timeout' and 'ttimeout' options
7933 tell so. A useful setting would be >
7934 :set timeout timeoutlen=3000 ttimeoutlen=100
7935< (time out on mapping after three seconds, time out on key codes after
7936 a tenth of a second).
7937
7938 *'title'* *'notitle'*
7939'title' boolean (default off, on when title can be restored)
7940 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007941 {not available when compiled without the |+title|
7942 feature}
7943 When on, the title of the window will be set to the value of
7944 'titlestring' (if it is not empty), or to:
7945 filename [+=-] (path) - VIM
7946 Where:
7947 filename the name of the file being edited
7948 - indicates the file cannot be modified, 'ma' off
7949 + indicates the file was modified
7950 = indicates the file is read-only
7951 =+ indicates the file is read-only and modified
7952 (path) is the path of the file being edited
7953 - VIM the server name |v:servername| or "VIM"
7954 Only works if the terminal supports setting window titles
7955 (currently Amiga console, Win32 console, all GUI versions and
7956 terminals with a non- empty 't_ts' option - these are Unix xterm and
7957 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7958 *X11*
7959 When Vim was compiled with HAVE_X11 defined, the original title will
7960 be restored if possible. The output of ":version" will include "+X11"
7961 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7962 works for the icon name |'icon'|.
7963 But: When Vim was started with the |-X| argument, restoring the title
7964 will not work (except in the GUI).
7965 If the title cannot be restored, it is set to the value of 'titleold'.
7966 You might want to restore the title outside of Vim then.
7967 When using an xterm from a remote machine you can use this command:
7968 rsh machine_name xterm -display $DISPLAY &
7969 then the WINDOWID environment variable should be inherited and the
7970 title of the window should change back to what it should be after
7971 exiting Vim.
7972
7973 *'titlelen'*
7974'titlelen' number (default 85)
7975 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007976 {not available when compiled without the |+title|
7977 feature}
7978 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007979 title. When the title is longer, only the end of the path name is
7980 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007981 Using a percentage makes this adapt to the width of the window. But
7982 it won't work perfectly, because the actual number of characters
7983 available also depends on the font used and other things in the title
7984 bar. When 'titlelen' is zero the full path is used. Otherwise,
7985 values from 1 to 30000 percent can be used.
7986 'titlelen' is also used for the 'titlestring' option.
7987
7988 *'titleold'*
7989'titleold' string (default "Thanks for flying Vim")
7990 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007991 {only available when compiled with the |+title|
7992 feature}
7993 This option will be used for the window title when exiting Vim if the
7994 original title cannot be restored. Only happens if 'title' is on or
7995 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007996 This option cannot be set from a |modeline| or in the |sandbox|, for
7997 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 *'titlestring'*
7999'titlestring' string (default "")
8000 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008001 {not available when compiled without the |+title|
8002 feature}
8003 When this option is not empty, it will be used for the title of the
8004 window. This happens only when the 'title' option is on.
8005 Only works if the terminal supports setting window titles (currently
8006 Amiga console, Win32 console, all GUI versions and terminals with a
8007 non-empty 't_ts' option).
8008 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01008009 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008010
Bram Moolenaar071d4272004-06-13 20:20:40 +00008011 When this option contains printf-style '%' items, they will be
8012 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008013 This option cannot be set in a modeline when 'modelineexpr' is off.
8014
Bram Moolenaar071d4272004-06-13 20:20:40 +00008015 Example: >
8016 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
8017 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
8018< The value of 'titlelen' is used to align items in the middle or right
8019 of the available space.
8020 Some people prefer to have the file name first: >
8021 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
8022< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008023 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00008024 separating space only when needed.
8025 NOTE: Use of special characters in 'titlestring' may cause the display
8026 to be garbled (e.g., when it contains a CR or NL character).
8027 {not available when compiled without the |+statusline| feature}
8028
8029 *'toolbar'* *'tb'*
8030'toolbar' 'tb' string (default "icons,tooltips")
8031 global
8032 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
8033 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008034 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 possible values are:
8036 icons Toolbar buttons are shown with icons.
8037 text Toolbar buttons shown with text.
8038 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008039 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008040 tooltips Tooltips are active for toolbar buttons.
8041 Tooltips refer to the popup help text which appears after the mouse
8042 cursor is placed over a toolbar button for a brief moment.
8043
8044 If you want the toolbar to be shown with icons as well as text, do the
8045 following: >
8046 :set tb=icons,text
8047< Motif and Athena cannot display icons and text at the same time. They
8048 will show icons if both are requested.
8049
8050 If none of the strings specified in 'toolbar' are valid or if
8051 'toolbar' is empty, this option is ignored. If you want to disable
8052 the toolbar, you need to set the 'guioptions' option. For example: >
8053 :set guioptions-=T
8054< Also see |gui-toolbar|.
8055
8056 *'toolbariconsize'* *'tbis'*
8057'toolbariconsize' 'tbis' string (default "small")
8058 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008059 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008060 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008061 tiny Use tiny icons.
8062 small Use small icons (default).
8063 medium Use medium-sized icons.
8064 large Use large icons.
8065 huge Use even larger icons.
8066 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008067 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008068 the current theme. Common dimensions are giant=48x48, huge=32x32,
8069 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070
8071 If 'toolbariconsize' is empty, the global default size as determined
8072 by user preferences or the current theme is used.
8073
8074 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8075'ttybuiltin' 'tbi' boolean (default on)
8076 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008077 When on, the builtin termcaps are searched before the external ones.
8078 When off the builtin termcaps are searched after the external ones.
8079 When this option is changed, you should set the 'term' option next for
8080 the change to take effect, for example: >
8081 :set notbi term=$TERM
8082< See also |termcap|.
8083 Rationale: The default for this option is "on", because the builtin
8084 termcap entries are generally better (many systems contain faulty
8085 xterm entries...).
8086
8087 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8088'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8089 sun-cmd, screen, rxvt, dtterm or
8090 iris-ansi; also on when running Vim in
8091 a DOS console)
8092 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008093 Indicates a fast terminal connection. More characters will be sent to
8094 the screen for redrawing, instead of using insert/delete line
8095 commands. Improves smoothness of redrawing when there are multiple
8096 windows and the terminal does not support a scrolling region.
8097 Also enables the extra writing of characters at the end of each screen
8098 line for lines that wrap. This helps when using copy/paste with the
8099 mouse in an xterm and other terminals.
8100
8101 *'ttymouse'* *'ttym'*
8102'ttymouse' 'ttym' string (default depends on 'term')
8103 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008104 {only in Unix and VMS, doesn't work in the GUI; not
8105 available when compiled without |+mouse|}
8106 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008107 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008108 *xterm-mouse*
8109 xterm xterm-like mouse handling. The mouse generates
8110 "<Esc>[Mscr", where "scr" is three bytes:
8111 "s" = button state
8112 "c" = column plus 33
8113 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008114 This only works up to 223 columns! See "dec",
8115 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008116 xterm2 Works like "xterm", but with the xterm reporting the
8117 mouse position while the mouse is dragged. This works
8118 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008119 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008120 work. See below for how Vim detects this
8121 automatically.
8122 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008123 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008124 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008125 for the row and column. No other mouse events are
8126 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 *dec-mouse*
8128 dec DEC terminal mouse handling. The mouse generates a
8129 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008130 This is also available for an Xterm, if it was
8131 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008132 *jsbterm-mouse*
8133 jsbterm JSB term mouse handling.
8134 *pterm-mouse*
8135 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008136 *urxvt-mouse*
8137 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008138 The mouse works only if the terminal supports this
8139 encoding style, but it does not have 223 columns limit
8140 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008141 *sgr-mouse*
8142 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008143 mouse reporting. The mouse works even in columns
8144 beyond 223. This option is backward compatible with
8145 "xterm2" because it can also decode "xterm2" style
8146 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008147
8148 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008149 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8150 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008151 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8152 recognized, if enabled at compile time. DEC terminal mouse codes
8153 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008154 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8155 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008156 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008157 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8158 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8159 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008160 Additionally, if vim is compiled with the |+termresponse| feature and
8161 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008162 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008163 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008164 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8165 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8166 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008167 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8168 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008169 :set t_RV=
8170<
8171 *'ttyscroll'* *'tsl'*
8172'ttyscroll' 'tsl' number (default 999)
8173 global
8174 Maximum number of lines to scroll the screen. If there are more lines
8175 to scroll the window is redrawn. For terminals where scrolling is
8176 very slow and redrawing is not slow this can be set to a small number,
8177 e.g., 3, to speed up displaying.
8178
8179 *'ttytype'* *'tty'*
8180'ttytype' 'tty' string (default from $TERM)
8181 global
8182 Alias for 'term', see above.
8183
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008184 *'undodir'* *'udir'*
8185'undodir' 'udir' string (default ".")
8186 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008187 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008188 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008189 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008190 "." means using the directory of the file. The undo file name for
8191 "file.txt" is ".file.txt.un~".
8192 For other directories the file name is the full path of the edited
8193 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008194 When writing: The first directory that exists is used. "." always
8195 works, no directories after "." will be used for writing.
8196 When reading all entries are tried to find an undo file. The first
8197 undo file that exists is used. When it cannot be read an error is
8198 given, no further entry is used.
8199 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008200 This option cannot be set from a |modeline| or in the |sandbox|, for
8201 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008202
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008203 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008204'undofile' 'udf' boolean (default off)
8205 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008206 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008207 When on, Vim automatically saves undo history to an undo file when
8208 writing a buffer to a file, and restores undo history from the same
8209 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008210 The directory where the undo file is stored is specified by 'undodir'.
8211 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008212 The undo file is not read when 'undoreload' causes the buffer from
8213 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008214 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008215 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008216
Bram Moolenaar071d4272004-06-13 20:20:40 +00008217 *'undolevels'* *'ul'*
8218'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8219 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008220 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008221 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008222 is kept in memory, higher numbers will cause more memory to be used.
8223 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008224 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8225 itself: >
8226 set ul=0
8227< But you can also get Vi compatibility by including the 'u' flag in
8228 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008229 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008230 Set to -1 for no undo at all. You might want to do this only for the
8231 current buffer: >
8232 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008233< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008234
8235 The local value is set to -123456 when the global value is to be used.
8236
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008237 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008238
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008239 *'undoreload'* *'ur'*
8240'undoreload' 'ur' number (default 10000)
8241 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008242 Save the whole buffer for undo when reloading it. This applies to the
8243 ":e!" command and reloading for when the buffer changed outside of
8244 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008245 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008246 of lines is smaller than the value of this option.
8247 Set this option to zero to disable undo for a reload.
8248
8249 When saving undo for a reload, any undo file is not read.
8250
8251 Note that this causes the whole buffer to be stored in memory. Set
8252 this option to a lower value if you run out of memory.
8253
Bram Moolenaar071d4272004-06-13 20:20:40 +00008254 *'updatecount'* *'uc'*
8255'updatecount' 'uc' number (default: 200)
8256 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008257 After typing this many characters the swap file will be written to
8258 disk. When zero, no swap file will be created at all (see chapter on
8259 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8260 Vim with the "-n" option, see |startup|. When editing in readonly
8261 mode this option will be initialized to 10000.
8262 The swapfile can be disabled per buffer with |'swapfile'|.
8263 When 'updatecount' is set from zero to non-zero, swap files are
8264 created for all buffers that have 'swapfile' set. When 'updatecount'
8265 is set to zero, existing swap files are not deleted.
8266 Also see |'swapsync'|.
8267 This option has no meaning in buffers where |'buftype'| is "nofile"
8268 or "nowrite".
8269
8270 *'updatetime'* *'ut'*
8271'updatetime' 'ut' number (default 4000)
8272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008273 If this many milliseconds nothing is typed the swap file will be
8274 written to disk (see |crash-recovery|). Also used for the
8275 |CursorHold| autocommand event.
8276
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008277 *'varsofttabstop'* *'vsts'*
8278'varsofttabstop' 'vsts' string (default "")
8279 local to buffer
8280 {only available when compiled with the |+vartabs|
8281 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008282 A list of the number of spaces that a <Tab> counts for while editing,
8283 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8284 width <Tab>s are being inserted, while in fact a mixture of spaces
8285 and <Tab>s is used. Tab widths are separated with commas, with the
8286 final value applying to all subsequent tabs.
8287
8288 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008289 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008290 to use the following: >
8291 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008292< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8293 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008294
8295 Note that the value of |'softtabstop'| will be ignored while
8296 'varsofttabstop' is set.
8297
8298 *'vartabstop'* *'vts'*
8299'vartabstop' 'vts' string (default "")
8300 local to buffer
8301 {only available when compiled with the |+vartabs|
8302 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008303 A list of the number of spaces that a <Tab> in the file counts for,
8304 separated by commas. Each value corresponds to one tab, with the
8305 final value applying to all subsequent tabs. For example: >
8306 :set vartabstop=4,20,10,8
8307< This will make the first tab 4 spaces wide, the second 20 spaces,
8308 the third 10 spaces, and all following tabs 8 spaces.
8309
8310 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8311 is set.
8312
Bram Moolenaar071d4272004-06-13 20:20:40 +00008313 *'verbose'* *'vbs'*
8314'verbose' 'vbs' number (default 0)
8315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 When bigger than zero, Vim will give messages about what it is doing.
8317 Currently, these messages are given:
8318 >= 1 When the viminfo file is read or written.
8319 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008320 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 >= 8 Files for which a group of autocommands is executed.
8322 >= 9 Every executed autocommand.
8323 >= 12 Every executed function.
8324 >= 13 When an exception is thrown, caught, finished, or discarded.
8325 >= 14 Anything pending in a ":finally" clause.
8326 >= 15 Every executed Ex command (truncated at 200 characters).
8327
8328 This option can also be set with the "-V" argument. See |-V|.
8329 This option is also set by the |:verbose| command.
8330
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008331 When the 'verbosefile' option is set then the verbose messages are not
8332 displayed.
8333
8334 *'verbosefile'* *'vfile'*
8335'verbosefile' 'vfile' string (default empty)
8336 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008337 When not empty all messages are written in a file with this name.
8338 When the file exists messages are appended.
8339 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008340 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008341 Setting 'verbosefile' to a new value is like making it empty first.
8342 The difference with |:redir| is that verbose messages are not
8343 displayed when 'verbosefile' is set.
8344
Bram Moolenaar071d4272004-06-13 20:20:40 +00008345 *'viewdir'* *'vdir'*
8346'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8347 "$VIM/vimfiles/view",
8348 for Unix: "~/.vim/view",
8349 for Macintosh: "$VIM:vimfiles:view"
8350 for VMS: "sys$login:vimfiles/view"
8351 for RiscOS: "Choices:vimfiles/view")
8352 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008353 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008354 feature}
8355 Name of the directory where to store files for |:mkview|.
8356 This option cannot be set from a |modeline| or in the |sandbox|, for
8357 security reasons.
8358
8359 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008360'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008361 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008362 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008363 feature}
8364 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008365 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 word save and restore ~
8367 cursor cursor position in file and in window
8368 folds manually created folds, opened/closed folds and local
8369 fold options
8370 options options and mappings local to a window or buffer (not
8371 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008372 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008373 slash backslashes in file names replaced with forward
8374 slashes
8375 unix with Unix end-of-line format (single <NL>), even when
8376 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008377 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008378
8379 "slash" and "unix" are useful on Windows when sharing view files
8380 with Unix. The Unix version of Vim cannot source dos format scripts,
8381 but the Windows version of Vim can source unix format scripts.
8382
8383 *'viminfo'* *'vi'* *E526* *E527* *E528*
8384'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008385 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8386 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8387 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008388 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008389 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008390 feature}
8391 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008392 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8393 "NONE".
8394 The string should be a comma separated list of parameters, each
8395 consisting of a single character identifying the particular parameter,
8396 followed by a number or string which specifies the value of that
8397 parameter. If a particular character is left out, then the default
8398 value is used for that parameter. The following is a list of the
8399 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008401 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008402 ! When included, save and restore global variables that start
8403 with an uppercase letter, and don't contain a lowercase
8404 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008405 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008406 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008407 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008408 " Maximum number of lines saved for each register. Old name of
8409 the '<' item, with the disadvantage that you need to put a
8410 backslash before the ", otherwise it will be recognized as the
8411 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008412 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008413 % When included, save and restore the buffer list. If Vim is
8414 started with a file name argument, the buffer list is not
8415 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008416 buffer list is restored from the viminfo file. Quickfix
8417 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8418 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008419 When followed by a number, the number specifies the maximum
8420 number of buffers that are stored. Without a number all
8421 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008422 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008423 ' Maximum number of previously edited files for which the marks
8424 are remembered. This parameter must always be included when
8425 'viminfo' is non-empty.
8426 Including this item also means that the |jumplist| and the
8427 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008428 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008429 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008430 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 patterns are also saved. When not included, the value of
8432 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008433 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008434 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008435 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008436 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008437 < Maximum number of lines saved for each register. If zero then
8438 registers are not saved. When not included, all lines are
8439 saved. '"' is the old name for this item.
8440 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008441 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008442 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008443 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008444 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008445 c When included, convert the text in the viminfo file from the
8446 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008447 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008448 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008449 f Whether file marks need to be stored. If zero, file marks ('0
8450 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008451 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008452 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008453 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008454 h Disable the effect of 'hlsearch' when loading the viminfo
8455 file. When not included, it depends on whether ":nohlsearch"
8456 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008457 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008458 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008459 the 'n'. Must be at the end of the option! If the
8460 'viminfofile' option is set, that file name overrides the one
8461 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008462 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008463 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008464 r Removable media. The argument is a string (up to the next
8465 ','). This parameter can be given several times. Each
8466 specifies the start of a path for which no marks will be
8467 stored. This is to avoid removable media. For MS-DOS you
8468 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8469 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8470 ignored. Maximum length of each 'r' argument is 50
8471 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008472 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008473 s Maximum size of an item in Kbyte. If zero then registers are
8474 not saved. Currently only applies to registers. The default
8475 "s10" will exclude registers with more than 10 Kbyte of text.
8476 Also see the '<' item above: line count limit.
8477
8478 Example: >
8479 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8480<
8481 '50 Marks will be remembered for the last 50 files you
8482 edited.
8483 <1000 Contents of registers (up to 1000 lines each) will be
8484 remembered.
8485 s100 Registers with more than 100 Kbyte text are skipped.
8486 :0 Command-line history will not be saved.
8487 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8488 no / Since '/' is not specified, the default will be used,
8489 that is, save all of the search history, and also the
8490 previous search and substitute patterns.
8491 no % The buffer list will not be saved nor read back.
8492 no h 'hlsearch' highlighting will be restored.
8493
8494 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8495 load the contents of the file, this is not done automatically.
8496
8497 This option cannot be set from a |modeline| or in the |sandbox|, for
8498 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008499 NOTE: This option is set to the Vim default value when 'compatible'
8500 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008501
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008502 *'viminfofile'* *'vif'*
8503'viminfofile' 'vif' string (default: "")
8504 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008505 {not available when compiled without the |+viminfo|
8506 feature}
8507 When non-empty, overrides the file name used for viminfo.
8508 When equal to "NONE" no viminfo file will be read or written.
8509 This option can be set with the |-i| command line flag. The |--clean|
8510 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008511 This option cannot be set from a |modeline| or in the |sandbox|, for
8512 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008513
Bram Moolenaar071d4272004-06-13 20:20:40 +00008514 *'virtualedit'* *'ve'*
8515'virtualedit' 've' string (default "")
8516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 {not available when compiled without the
8518 |+virtualedit| feature}
8519 A comma separated list of these words:
8520 block Allow virtual editing in Visual block mode.
8521 insert Allow virtual editing in Insert mode.
8522 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008523 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008524
Bram Moolenaar071d4272004-06-13 20:20:40 +00008525 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008526 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008527 of the line. Useful for selecting a rectangle in Visual mode and
8528 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008529 "onemore" is not the same, it will only allow moving the cursor just
8530 after the last character of the line. This makes some commands more
8531 consistent. Previously the cursor was always past the end of the line
8532 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008533 break some plugins or Vim scripts. For example because |l| can move
8534 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008535 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008536 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008537 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008538 It doesn't make sense to combine "all" with "onemore", but you will
8539 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008540 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541
8542 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8543'visualbell' 'vb' boolean (default off)
8544 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008545 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008546 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008547 use: >
8548 :set vb t_vb=
8549< If you want a short flash, you can use this on many terminals: >
8550 :set vb t_vb=[?5h$<100>[?5l
8551< Here $<100> specifies the time, you can use a smaller or bigger value
8552 to get a shorter or longer flash.
8553
8554 Note: Vim will limit the bell to once per half a second. This avoids
8555 having to wait for the flashing to finish when there are lots of
8556 bells, e.g. on key repeat. This also happens without 'visualbell'
8557 set.
8558
Bram Moolenaar071d4272004-06-13 20:20:40 +00008559 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8560 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8561 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008562
8563 Note: When the GUI starts, 't_vb' is reset to its default value. You
8564 might want to set it again in your |gvimrc|.
8565
Bram Moolenaar071d4272004-06-13 20:20:40 +00008566 Does not work on the Amiga, you always get a screen flash.
8567 Also see 'errorbells'.
8568
8569 *'warn'* *'nowarn'*
8570'warn' boolean (default on)
8571 global
8572 Give a warning message when a shell command is used while the buffer
8573 has been changed.
8574
8575 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8576'weirdinvert' 'wiv' boolean (default off)
8577 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008578 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 It is provided for backwards compatibility with version 4.x.
8580 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8581 vice versa. Has no effect when the GUI is running.
8582
8583 *'whichwrap'* *'ww'*
8584'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008586 Allow specified keys that move the cursor left/right to move to the
8587 previous/next line when the cursor is on the first/last character in
8588 the line. Concatenate characters to allow this for these keys:
8589 char key mode ~
8590 b <BS> Normal and Visual
8591 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008592 h "h" Normal and Visual (not recommended)
8593 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008594 < <Left> Normal and Visual
8595 > <Right> Normal and Visual
8596 ~ "~" Normal
8597 [ <Left> Insert and Replace
8598 ] <Right> Insert and Replace
8599 For example: >
8600 :set ww=<,>,[,]
8601< allows wrap only when cursor keys are used.
8602 When the movement keys are used in combination with a delete or change
8603 operator, the <EOL> also counts for a character. This makes "3h"
8604 different from "3dh" when the cursor crosses the end of a line. This
8605 is also true for "x" and "X", because they do the same as "dl" and
8606 "dh". If you use this, you may also want to use the mapping
8607 ":map <BS> X" to make backspace delete the character in front of the
8608 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008609 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008610 line (not an empty line) then it will not move to the next line. This
8611 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008612 NOTE: This option is set to the Vi default value when 'compatible' is
8613 set and to the Vim default value when 'compatible' is reset.
8614
8615 *'wildchar'* *'wc'*
8616'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8617 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008618 Character you have to type to start wildcard expansion in the
8619 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008620 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008621 The character is not recognized when used inside a macro. See
8622 'wildcharm' for that.
8623 Although 'wc' is a number option, you can set it to a special key: >
8624 :set wc=<Esc>
8625< NOTE: This option is set to the Vi default value when 'compatible' is
8626 set and to the Vim default value when 'compatible' is reset.
8627
8628 *'wildcharm'* *'wcm'*
8629'wildcharm' 'wcm' number (default: none (0))
8630 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008632 recognized when used inside a macro. You can find "spare" command-line
8633 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008634 you'll never actually type 'wildcharm', just use it in mappings that
8635 automatically invoke completion mode, e.g.: >
8636 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008637 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008638< Then after typing :ss you can use CTRL-P & CTRL-N.
8639
8640 *'wildignore'* *'wig'*
8641'wildignore' 'wig' string (default "")
8642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 {not available when compiled without the |+wildignore|
8644 feature}
8645 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008646 patterns is ignored when expanding |wildcards|, completing file or
8647 directory names, and influences the result of |expand()|, |glob()| and
8648 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008649 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8650 Also see 'suffixes'.
8651 Example: >
8652 :set wildignore=*.o,*.obj
8653< The use of |:set+=| and |:set-=| is preferred when adding or removing
8654 a pattern from the list. This avoids problems when a future version
8655 uses another default.
8656
Bram Moolenaar94950a92010-12-02 16:01:29 +01008657
Bram Moolenaar81af9252010-12-10 20:35:50 +01008658 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008659'wildignorecase' 'wic' boolean (default off)
8660 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008661 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008662 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008663 Does not apply when the shell is used to expand wildcards, which
8664 happens when there are special characters.
8665
8666
Bram Moolenaar071d4272004-06-13 20:20:40 +00008667 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008668'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008670 {not available if compiled without the |+wildmenu|
8671 feature}
8672 When 'wildmenu' is on, command-line completion operates in an enhanced
8673 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8674 the possible matches are shown just above the command line, with the
8675 first match highlighted (overwriting the status line, if there is
8676 one). Keys that show the previous/next match, such as <Tab> or
8677 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8678 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8679 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008680 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008681 If there are more matches than can fit in the line, a ">" is shown on
8682 the right and/or a "<" is shown on the left. The status line scrolls
8683 as needed.
8684 The "wildmenu" mode is abandoned when a key is hit that is not used
8685 for selecting a completion.
8686 While the "wildmenu" is active the following keys have special
8687 meanings:
8688
8689 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8690 <Down> - in filename/menu name completion: move into a
8691 subdirectory or submenu.
8692 <CR> - in menu completion, when the cursor is just after a
8693 dot: move into a submenu.
8694 <Up> - in filename/menu name completion: move up into
8695 parent directory or parent menu.
8696
8697 This makes the menus accessible from the console |console-menus|.
8698
8699 If you prefer the <Left> and <Right> keys to move the cursor instead
8700 of selecting a different match, use this: >
8701 :cnoremap <Left> <Space><BS><Left>
8702 :cnoremap <Right> <Space><BS><Right>
8703<
8704 The "WildMenu" highlighting is used for displaying the current match
8705 |hl-WildMenu|.
8706
8707 *'wildmode'* *'wim'*
8708'wildmode' 'wim' string (Vim default: "full")
8709 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008710 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008711 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008712 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008713 first part specifies the behavior for the first use of 'wildchar',
8714 The second part for the second use, etc.
8715 These are the possible values for each part:
8716 "" Complete only the first match.
8717 "full" Complete the next full match. After the last match,
8718 the original string is used and then the first match
8719 again.
8720 "longest" Complete till longest common string. If this doesn't
8721 result in a longer string, use the next part.
8722 "longest:full" Like "longest", but also start 'wildmenu' if it is
8723 enabled.
8724 "list" When more than one match, list all matches.
8725 "list:full" When more than one match, list all matches and
8726 complete first match.
8727 "list:longest" When more than one match, list all matches and
8728 complete till longest common string.
Bram Moolenaar52410572019-10-27 05:12:45 +01008729 "list:lastused" When more than one buffer matches, sort buffers
8730 by time last used (other than the current buffer).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 When there is only a single match, it is fully completed in all cases.
8732
8733 Examples: >
8734 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008735< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736 :set wildmode=longest,full
8737< Complete longest common string, then each full match >
8738 :set wildmode=list:full
8739< List all matches and complete each full match >
8740 :set wildmode=list,full
8741< List all matches without completing, then each full match >
8742 :set wildmode=longest,list
8743< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008744 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008745
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008746 *'wildoptions'* *'wop'*
8747'wildoptions' 'wop' string (default "")
8748 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008749 {not available when compiled without the |+wildignore|
8750 feature}
8751 A list of words that change how command line completion is done.
8752 Currently only one word is allowed:
8753 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008754 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008755 is displayed per line. Often used tag kinds are:
8756 d #define
8757 f function
8758 Also see |cmdline-completion|.
8759
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 *'winaltkeys'* *'wak'*
8761'winaltkeys' 'wak' string (default "menu")
8762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 {only used in Win32, Motif, GTK and Photon GUI}
8764 Some GUI versions allow the access to menu entries by using the ALT
8765 key in combination with a character that appears underlined in the
8766 menu. This conflicts with the use of the ALT key for mappings and
8767 entering special characters. This option tells what to do:
8768 no Don't use ALT keys for menus. ALT key combinations can be
8769 mapped, but there is no automatic handling. This can then be
8770 done with the |:simalt| command.
8771 yes ALT key handling is done by the windowing system. ALT key
8772 combinations cannot be mapped.
8773 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008774 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008775 keys can be mapped.
8776 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8777 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008778 This option is not used for <F10>; on Win32 and with GTK <F10> will
8779 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008780
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008781 *'wincolor'* *'wcr'*
8782'wincolor' 'wcr' string (default empty)
8783 local to window
8784 Highlight group name to use for this window instead of the Normal
8785 color |hl-Normal|.
8786
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008787 *'window'* *'wi'*
8788'window' 'wi' number (default screen height - 1)
8789 global
8790 Window height. Do not confuse this with the height of the Vim window,
8791 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008792 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8793 value is smaller than 'lines' minus one. The screen will scroll
8794 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008795 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8796 in a much smarter way, taking care of wrapping lines.
8797 When resizing the Vim window, the value is smaller than 1 or more than
8798 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008799
Bram Moolenaar071d4272004-06-13 20:20:40 +00008800 *'winheight'* *'wh'* *E591*
8801'winheight' 'wh' number (default 1)
8802 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008803 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008804 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008805 focus goes to a window that is smaller, its size is increased, at the
8806 cost of the height of other windows.
8807 Set 'winheight' to a small number for normal editing.
8808 Set it to 999 to make the current window fill most of the screen.
8809 Other windows will be only 'winminheight' high. This has the drawback
8810 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8811 to create only two windows, set the option after startup is done,
8812 using the |VimEnter| event: >
8813 au VimEnter * set winheight=999
8814< Minimum value is 1.
8815 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008816 height of the current window.
8817 'winheight' applies to the current window. Use 'winminheight' to set
8818 the minimal height for other windows.
8819
8820 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8821'winfixheight' 'wfh' boolean (default off)
8822 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008823 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008824 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8825 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008826 The height may be changed anyway when running out of room.
8827
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008828 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8829'winfixwidth' 'wfw' boolean (default off)
8830 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008831 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008832 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008833 The width may be changed anyway when running out of room.
8834
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 *'winminheight'* *'wmh'*
8836'winminheight' 'wmh' number (default 1)
8837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 The minimal height of a window, when it's not the current window.
8839 This is a hard minimum, windows will never become smaller.
8840 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8841 status bar) if necessary. They will return to at least one line when
8842 they become active (since the cursor has to have somewhere to go.)
8843 Use 'winheight' to set the minimal height of the current window.
8844 This option is only checked when making a window smaller. Don't use a
8845 large number, it will cause errors when opening more than a few
8846 windows. A value of 0 to 3 is reasonable.
8847
8848 *'winminwidth'* *'wmw'*
8849'winminwidth' 'wmw' number (default 1)
8850 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 The minimal width of a window, when it's not the current window.
8852 This is a hard minimum, windows will never become smaller.
8853 When set to zero, windows may be "squashed" to zero columns (i.e. just
8854 a vertical separator) if necessary. They will return to at least one
8855 line when they become active (since the cursor has to have somewhere
8856 to go.)
8857 Use 'winwidth' to set the minimal width of the current window.
8858 This option is only checked when making a window smaller. Don't use a
8859 large number, it will cause errors when opening more than a few
8860 windows. A value of 0 to 12 is reasonable.
8861
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008862 *'winptydll'*
8863'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8864 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008865 {only available when compiled with the |terminal|
8866 feature on MS-Windows}
8867 Specifies the name of the winpty shared library, used for the
8868 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008869 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008870 a fallback.
8871 Environment variables are expanded |:set_env|.
8872 This option cannot be set from a |modeline| or in the |sandbox|, for
8873 security reasons.
8874
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875 *'winwidth'* *'wiw'* *E592*
8876'winwidth' 'wiw' number (default 20)
8877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008878 Minimal number of columns for the current window. This is not a hard
8879 minimum, Vim will use fewer columns if there is not enough room. If
8880 the current window is smaller, its size is increased, at the cost of
8881 the width of other windows. Set it to 999 to make the current window
8882 always fill the screen. Set it to a small number for normal editing.
8883 The width is not adjusted after one of the commands to change the
8884 width of the current window.
8885 'winwidth' applies to the current window. Use 'winminwidth' to set
8886 the minimal width for other windows.
8887
8888 *'wrap'* *'nowrap'*
8889'wrap' boolean (default on)
8890 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008891 This option changes how text is displayed. It doesn't change the text
8892 in the buffer, see 'textwidth' for that.
8893 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008894 displaying continues on the next line. When off lines will not wrap
8895 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008896 moved to a part that is not shown, the screen will scroll
8897 horizontally.
8898 The line will be broken in the middle of a word if necessary. See
8899 'linebreak' to get the break at a word boundary.
8900 To make scrolling horizontally a bit more useful, try this: >
8901 :set sidescroll=5
8902 :set listchars+=precedes:<,extends:>
8903< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008904 This option can't be set from a |modeline| when the 'diff' option is
8905 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008906
8907 *'wrapmargin'* *'wm'*
8908'wrapmargin' 'wm' number (default 0)
8909 local to buffer
8910 Number of characters from the right window border where wrapping
8911 starts. When typing text beyond this limit, an <EOL> will be inserted
8912 and inserting continues on the next line.
8913 Options that add a margin, such as 'number' and 'foldcolumn', cause
8914 the text width to be further reduced. This is Vi compatible.
8915 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008916 This option is set to 0 when 'paste' is set and restored when 'paste'
8917 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008918 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008919
8920 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8921'wrapscan' 'ws' boolean (default on) *E384* *E385*
8922 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008923 Searches wrap around the end of the file. Also applies to |]s| and
8924 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008925
8926 *'write'* *'nowrite'*
8927'write' boolean (default on)
8928 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008929 Allows writing files. When not set, writing a file is not allowed.
8930 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008931 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008932 argument. Filtering text is still possible, even though this requires
8933 writing a temporary file.
8934
8935 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8936'writeany' 'wa' boolean (default off)
8937 global
8938 Allows writing to any file with no need for "!" override.
8939
8940 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8941'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8942 otherwise)
8943 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008944 Make a backup before overwriting a file. The backup is removed after
8945 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008946 also on.
8947 WARNING: Switching this option off means that when Vim fails to write
8948 your buffer correctly and then, for whatever reason, Vim exits, you
8949 lose both the original file and what you were writing. Only reset
8950 this option if your file system is almost full and it makes the write
8951 fail (and make sure not to exit Vim until the write was successful).
8952 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008953 When the 'backupskip' pattern matches, a backup is not made anyway.
Bram Moolenaar0c0734d2019-11-26 21:44:46 +01008954 Depending on 'backupcopy' the backup is a new file or the original
8955 file renamed (and a new file is written).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008956 NOTE: This option is set to the default value when 'compatible' is
8957 set.
8958
8959 *'writedelay'* *'wd'*
8960'writedelay' 'wd' number (default 0)
8961 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008962 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008963 screen. When non-zero, characters are sent to the terminal one by
8964 one. For MS-DOS pcterm this does not work. For debugging purposes.
8965
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008966 vim:tw=78:ts=8:noet:ft=help:norl: