blob: 9f3d1dae67382c27266daef610876f6f787ca755 [file] [log] [blame]
Bram Moolenaar589edb32019-09-20 14:38:13 +02001*options.txt* For Vim version 8.1. Last change: 2019 Sep 18
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200859 If the GUI supports a dark them, you can use the "d" flag in
860 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200862 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200863 color from the terminal. If the returned RGB value is dark/light and
864 'background' is not dark/light, 'background' will be set and the
865 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200866 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100867 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When starting the GUI, the default value for 'background' will be
870 "light". When the value is not set in the .gvimrc, and Vim detects
871 that the background is actually quite dark, 'background' is set to
872 "dark". But this happens only AFTER the .gvimrc file has been read
873 (because the window needs to be opened to find the actual background
874 color). To get around this, force the GUI window to be opened by
875 putting a ":gui" command in the .gvimrc file, before where the value
876 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200877
878 For MS-DOS, Windows and OS/2 the default is "dark".
879 For other systems "dark" is used when 'term' is "linux",
880 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
881 background. Otherwise the default is "light".
882
Bram Moolenaarc572da52017-08-27 16:52:01 +0200883 The |:terminal| command and the |term_start()| function use the
884 'background' value to decide whether the terminal window will start
885 with a white or black background.
886
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 Normally this option would be set in the .vimrc file. Possibly
888 depending on the terminal name. Example: >
889 :if &term == "pcterm"
890 : set background=dark
891 :endif
892< When this option is set, the default settings for the highlight groups
893 will change. To use other settings, place ":highlight" commands AFTER
894 the setting of the 'background' option.
895 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
896 to select the colors for syntax highlighting. After changing this
897 option, you must load syntax.vim again to see the result. This can be
898 done with ":syntax on".
899
900 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200901'backspace' 'bs' string (default "", set to "indent,eol,start"
902 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
905 mode. This is a list of items, separated by commas. Each item allows
906 a way to backspace over something:
907 value effect ~
908 indent allow backspacing over autoindent
909 eol allow backspacing over line breaks (join lines)
910 start allow backspacing over the start of insert; CTRL-W and CTRL-U
911 stop once at the start of insert.
912
913 When the value is empty, Vi compatible backspacing is used.
914
915 For backwards compatibility with version 5.4 and earlier:
916 value effect ~
917 0 same as ":set backspace=" (Vi compatible)
918 1 same as ":set backspace=indent,eol"
919 2 same as ":set backspace=indent,eol,start"
920
921 See |:fixdel| if your <BS> or <Del> key does not do what you want.
922 NOTE: This option is set to "" when 'compatible' is set.
923
924 *'backup'* *'bk'* *'nobackup'* *'nobk'*
925'backup' 'bk' boolean (default off)
926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 Make a backup before overwriting a file. Leave it around after the
928 file has been successfully written. If you do not want to keep the
929 backup file, but you do want a backup while the file is being
930 written, reset this option and set the 'writebackup' option (this is
931 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000932 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 |backup-table| for more explanations.
934 When the 'backupskip' pattern matches, a backup is not made anyway.
935 When 'patchmode' is set, the backup may be renamed to become the
936 oldest version of a file.
937 NOTE: This option is reset when 'compatible' is set.
938
939 *'backupcopy'* *'bkc'*
940'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200941 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 When writing a file and a backup is made, this option tells how it's
943 done. This is a comma separated list of words.
944
945 The main values are:
946 "yes" make a copy of the file and overwrite the original one
947 "no" rename the file and write a new one
948 "auto" one of the previous, what works best
949
950 Extra values that can be combined with the ones above are:
951 "breaksymlink" always break symlinks when writing
952 "breakhardlink" always break hardlinks when writing
953
954 Making a copy and overwriting the original file:
955 - Takes extra time to copy the file.
956 + When the file has special attributes, is a (hard/symbolic) link or
957 has a resource fork, all this is preserved.
958 - When the file is a link the backup will have the name of the link,
959 not of the real file.
960
961 Renaming the file and writing a new one:
962 + It's fast.
963 - Sometimes not all attributes of the file can be copied to the new
964 file.
965 - When the file is a link the new file will not be a link.
966
967 The "auto" value is the middle way: When Vim sees that renaming file
968 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000969 the file is not a link) that is used. When problems are expected, a
970 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 The "breaksymlink" and "breakhardlink" values can be used in
973 combination with any of "yes", "no" and "auto". When included, they
974 force Vim to always break either symbolic or hard links by doing
975 exactly what the "no" option does, renaming the original file to
976 become the backup and writing a new file in its place. This can be
977 useful for example in source trees where all the files are symbolic or
978 hard links and any changes should stay in the local source tree, not
979 be propagated back to the original source.
980 *crontab*
981 One situation where "no" and "auto" will cause problems: A program
982 that opens a file, invokes Vim to edit that file, and then tests if
983 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000984 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 example.
986
987 When a copy is made, the original file is truncated and then filled
988 with the new text. This means that protection bits, owner and
989 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000990 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 group of the backup is set to the group of the original file. If this
992 fails, the protection bits for the group are made the same as for
993 others.
994
995 When the file is renamed this is the other way around: The backup has
996 the same attributes of the original file, and the newly written file
997 is owned by the current user. When the file was a (hard/symbolic)
998 link, the new file will not! That's why the "auto" value doesn't
999 rename when the file is a link. The owner and group of the newly
1000 written file will be set to the same ones as the original file, but
1001 the system may refuse to do this. In that case the "auto" value will
1002 again not rename the file.
1003
Bram Moolenaar036986f2017-03-16 17:41:02 +01001004 NOTE: This option is set to the Vi default value when 'compatible' is
1005 set and to the Vim default value when 'compatible' is reset.
1006
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 *'backupdir'* *'bdir'*
1008'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001009 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 for Unix: ".,~/tmp,~/")
1011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 List of directories for the backup file, separated with commas.
1013 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001014 where this is possible. The directory must exist, Vim will not
1015 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001016 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 impossible!). Writing may fail because of this.
1018 - A directory "." means to put the backup file in the same directory
1019 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001020 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 put the backup file relative to where the edited file is. The
1022 leading "." is replaced with the path name of the edited file.
1023 ("." inside a directory name has no special meaning).
1024 - Spaces after the comma are ignored, other spaces are considered part
1025 of the directory name. To have a space at the start of a directory
1026 name, precede it with a backslash.
1027 - To include a comma in a directory name precede it with a backslash.
1028 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001029 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001030 the backup file name will be built from the complete path to the
1031 file with all path separators changed to percent '%' signs. This
1032 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001033 On Win32, it is also possible to end with "\\". However, When a
1034 separating comma is following, you must use "//", since "\\" will
1035 include the comma in the file name. Therefore it is recommended to
1036 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 - Environment variables are expanded |:set_env|.
1038 - Careful with '\' characters, type one before a space, type two to
1039 get one in the option (see |option-backslash|), for example: >
1040 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1041< - For backwards compatibility with Vim version 3.0 a '>' at the start
1042 of the option is removed.
1043 See also 'backup' and 'writebackup' options.
1044 If you want to hide your backup files on Unix, consider this value: >
1045 :set backupdir=./.backup,~/.backup,.,/tmp
1046< You must create a ".backup" directory in each directory and in your
1047 home directory for this to work properly.
1048 The use of |:set+=| and |:set-=| is preferred when adding or removing
1049 directories from the list. This avoids problems when a future version
1050 uses another default.
1051 This option cannot be set from a |modeline| or in the |sandbox|, for
1052 security reasons.
1053
1054 *'backupext'* *'bex'* *E589*
1055'backupext' 'bex' string (default "~", for VMS: "_")
1056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 String which is appended to a file name to make the name of the
1058 backup file. The default is quite unusual, because this avoids
1059 accidentally overwriting existing files with a backup file. You might
1060 prefer using ".bak", but make sure that you don't have files with
1061 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001062 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001064 If you like to keep a lot of backups, you could use a BufWritePre
1065 autocommand to change 'backupext' just before writing the file to
1066 include a timestamp. >
1067 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1068< Use 'backupdir' to put the backup in a different directory.
1069
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001071'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1072 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1073 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 {not available when compiled without the |+wildignore|
1076 feature}
1077 A list of file patterns. When one of the patterns matches with the
1078 name of the file which is written, no backup file is created. Both
1079 the specified file name and the full path name of the file are used.
1080 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1081 Watch out for special characters, see |option-backslash|.
1082 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001083 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001084
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001085 WARNING: Not having a backup file means that when Vim fails to write
1086 your buffer correctly and then, for whatever reason, Vim exits, you
1087 lose both the original file and what you were writing. Only disable
1088 backups if you don't care about losing the file.
1089
Bram Moolenaar02467872007-05-06 13:22:01 +00001090 Note that environment variables are not expanded. If you want to use
1091 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001092 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001093
1094< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001095 backup would be made by renaming the original file crontab won't see
1096 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097
1098 *'balloondelay'* *'bdlay'*
1099'balloondelay' 'bdlay' number (default: 600)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 {only available when compiled with the |+balloon_eval|
1102 feature}
1103 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1104
1105 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1106'ballooneval' 'beval' boolean (default off)
1107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001109 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001110 Switch on the |balloon-eval| functionality for the GUI.
1111
1112 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1113 *'nobevalterm'*
1114'balloonevalterm' 'bevalterm' boolean (default off)
1115 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001116 {only available when compiled with the
1117 |+balloon_eval_term| feature}
1118 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 *'balloonexpr'* *'bexpr'*
1121'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001122 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123 {only available when compiled with the |+balloon_eval|
1124 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001125 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001126 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1127 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128
1129 v:beval_bufnr number of the buffer in which balloon is going to show
1130 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001131 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 v:beval_lnum line number
1133 v:beval_col column number (byte index)
1134 v:beval_text word under or after the mouse pointer
1135
Bram Moolenaar54775062019-07-31 21:07:14 +02001136 Instead of showing a balloon, which is limited to plain text, consider
1137 using a popup window, see |popup_beval_example|. A popup window can
1138 use highlighting and show a border.
1139
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140 The evaluation of the expression must not have side effects!
1141 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001142 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001143 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 \', column ' . v:beval_col .
1145 \ ' of file ' . bufname(v:beval_bufnr) .
1146 \ ' on word "' . v:beval_text . '"'
1147 endfunction
1148 set bexpr=MyBalloonExpr()
1149 set ballooneval
1150<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001151 Also see |balloon_show()|, it can be used if the content of the balloon
1152 is to be fetched asynchronously. In that case evaluating
1153 'balloonexpr' should result in an empty string. If you get a balloon
1154 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001155
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156 NOTE: The balloon is displayed only if the cursor is on a text
1157 character. If the result of evaluating 'balloonexpr' is not empty,
1158 Vim does not try to send a message to an external debugger (Netbeans
1159 or Sun Workshop).
1160
Bram Moolenaar30b65812012-07-12 22:01:11 +02001161 The expression will be evaluated in the |sandbox| when set from a
1162 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001163 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001164
1165 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001166 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001167
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001169 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001170< When they are supported "\n" characters will start a new line. If the
1171 expression evaluates to a |List| this is equal to using each List item
1172 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001173 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001174
Bram Moolenaar165bc692015-07-21 17:53:25 +02001175 *'belloff'* *'bo'*
1176'belloff' 'bo' string (default "")
1177 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001178 Specifies for which events the bell will not be rung. It is a comma
1179 separated list of items. For each item that is present, the bell
1180 will be silenced. This is most useful to specify specific events in
1181 insert mode to be silenced.
1182
1183 item meaning when present ~
1184 all All events.
1185 backspace When hitting <BS> or <Del> and deleting results in an
1186 error.
1187 cursor Fail to move around using the cursor keys or
1188 <PageUp>/<PageDown> in |Insert-mode|.
1189 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1190 |i_CTRL-X_CTRL-T|.
1191 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1192 |i_CTRL-E|.
1193 ctrlg Unknown Char after <C-G> in Insert mode.
1194 error Other Error occurred (e.g. try to join last line)
1195 (mostly used in |Normal-mode| or |Cmdline-mode|).
1196 esc hitting <Esc> in |Normal-mode|.
1197 ex In |Visual-mode|, hitting |Q| results in an error.
1198 hangul Error occurred when using hangul input.
1199 insertmode Pressing <Esc> in 'insertmode'.
1200 lang Calling the beep module for Lua/Mzscheme/TCL.
1201 mess No output available for |g<|.
1202 showmatch Error occurred for 'showmatch' function.
1203 operator Empty region error |cpo-E|.
1204 register Unknown register after <C-R> in |Insert-mode|.
1205 shell Bell from shell output |:!|.
1206 spell Error happened on spell suggest.
1207 wildmode More matches in |cmdline-completion| available
1208 (depends on the 'wildmode' setting).
1209
Bram Moolenaar036986f2017-03-16 17:41:02 +01001210 This is most useful to fine tune when in Insert mode the bell should
1211 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001212 indicate that an error occurred. It can be silenced by adding the
1213 "error" keyword.
1214
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1216'binary' 'bin' boolean (default off)
1217 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 This option should be set before editing a binary file. You can also
1219 use the |-b| Vim argument. When this option is switched on a few
1220 options will be changed (also when it already was on):
1221 'textwidth' will be set to 0
1222 'wrapmargin' will be set to 0
1223 'modeline' will be off
1224 'expandtab' will be off
1225 Also, 'fileformat' and 'fileformats' options will not be used, the
1226 file is read and written like 'fileformat' was "unix" (a single <NL>
1227 separates lines).
1228 The 'fileencoding' and 'fileencodings' options will not be used, the
1229 file is read without conversion.
1230 NOTE: When you start editing a(nother) file while the 'bin' option is
1231 on, settings from autocommands may change the settings again (e.g.,
1232 'textwidth'), causing trouble when editing. You might want to set
1233 'bin' again when the file has been loaded.
1234 The previous values of these options are remembered and restored when
1235 'bin' is switched from on to off. Each buffer has its own set of
1236 saved option values.
1237 To edit a file with 'binary' set you can use the |++bin| argument.
1238 This avoids you have to do ":set bin", which would have effect for all
1239 files you edit.
1240 When writing a file the <EOL> for the last line is only written if
1241 there was one in the original file (normally Vim appends an <EOL> to
1242 the last line if there is none; this would make the file longer). See
1243 the 'endofline' option.
1244
1245 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1246'bioskey' 'biosk' boolean (default on)
1247 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001248 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001249 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
1251 *'bomb'* *'nobomb'*
1252'bomb' boolean (default off)
1253 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 When writing a file and the following conditions are met, a BOM (Byte
1255 Order Mark) is prepended to the file:
1256 - this option is on
1257 - the 'binary' option is off
1258 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1259 endian variants.
1260 Some applications use the BOM to recognize the encoding of the file.
1261 Often used for UCS-2 files on MS-Windows. For other applications it
1262 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001263 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1265 check for the presence of the BOM is done and 'bomb' set accordingly.
1266 Unless 'binary' is set, it is removed from the first line, so that you
1267 don't see it when editing. When you don't change the options, the BOM
1268 will be restored when writing the file.
1269
1270 *'breakat'* *'brk'*
1271'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1272 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001273 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 feature}
1275 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001276 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1277 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001279 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280'breakindent' 'bri' boolean (default off)
1281 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001282 {not available when compiled without the |+linebreak|
1283 feature}
1284 Every wrapped line will continue visually indented (same amount of
1285 space as the beginning of that line), thus preserving horizontal blocks
1286 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001287 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288
1289 *'breakindentopt'* *'briopt'*
1290'breakindentopt' 'briopt' string (default empty)
1291 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 {not available when compiled without the |+linebreak|
1293 feature}
1294 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001295 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001296 min:{n} Minimum text width that will be kept after
1297 applying 'breakindent', even if the resulting
1298 text should normally be narrower. This prevents
1299 text indented almost to the right window border
1300 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001301 shift:{n} After applying 'breakindent', the wrapped line's
1302 beginning will be shifted by the given number of
1303 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001304 indentation (negative) or emphasizing the line
1305 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001306 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001307 additional indent.
1308 The default value for min is 20 and shift is 0.
1309
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001311'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001313 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001315 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001316 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 buffer Use the directory of the related buffer.
1318 current Use the current directory.
1319 {path} Use the specified directory
1320
1321 *'bufhidden'* *'bh'*
1322'bufhidden' 'bh' string (default: "")
1323 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 This option specifies what happens when a buffer is no longer
1325 displayed in a window:
1326 <empty> follow the global 'hidden' option
1327 hide hide the buffer (don't unload it), also when 'hidden'
1328 is not set
1329 unload unload the buffer, also when 'hidden' is set or using
1330 |:hide|
1331 delete delete the buffer from the buffer list, also when
1332 'hidden' is set or using |:hide|, like using
1333 |:bdelete|
1334 wipe wipe out the buffer from the buffer list, also when
1335 'hidden' is set or using |:hide|, like using
1336 |:bwipeout|
1337
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001338 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001339 are lost without a warning. Also, these values may break autocommands
1340 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 This option is used together with 'buftype' and 'swapfile' to specify
1342 special kinds of buffers. See |special-buffers|.
1343
1344 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1345'buflisted' 'bl' boolean (default: on)
1346 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 When this option is set, the buffer shows up in the buffer list. If
1348 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1349 This option is reset by Vim for buffers that are only used to remember
1350 a file name or marks. Vim sets it when starting to edit a buffer.
1351 But not when moving to a buffer with ":buffer".
1352
1353 *'buftype'* *'bt'* *E382*
1354'buftype' 'bt' string (default: "")
1355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 The value of this option specifies the type of a buffer:
1357 <empty> normal buffer
1358 nofile buffer which is not related to a file and will not be
1359 written
1360 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001361 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001362 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001364 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 help help buffer (you are not supposed to set this
1366 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001367 terminal buffer for a |terminal| (you are not supposed to set
1368 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001369 prompt buffer where only the last line can be edited, meant
1370 to be used by a plugin, see |prompt-buffer|
1371 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001372 popup buffer used in a popup window, see |popup|.
1373 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374
1375 This option is used together with 'bufhidden' and 'swapfile' to
1376 specify special kinds of buffers. See |special-buffers|.
1377
1378 Be careful with changing this option, it can have many side effects!
1379
Bram Moolenaar280f1262006-01-30 00:14:18 +00001380 A "quickfix" buffer is only used for the error list and the location
1381 list. This value is set by the |:cwindow| and |:lwindow| commands and
1382 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383
1384 "nofile" and "nowrite" buffers are similar:
1385 both: The buffer is not to be written to disk, ":w" doesn't
1386 work (":w filename" does work though).
1387 both: The buffer is never considered to be |'modified'|.
1388 There is no warning when the changes will be lost, for
1389 example when you quit Vim.
1390 both: A swap file is only created when using too much memory
1391 (when 'swapfile' has been reset there is never a swap
1392 file).
1393 nofile only: The buffer name is fixed, it is not handled like a
1394 file name. It is not modified in response to a |:cd|
1395 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001396 both: When using ":e bufname" and already editing "bufname"
1397 the buffer is made empty and autocommands are
1398 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001399 *E676*
1400 "acwrite" implies that the buffer name is not related to a file, like
1401 "nofile", but it will be written. Thus, in contrast to "nofile" and
1402 "nowrite", ":w" does work and a modified buffer can't be abandoned
1403 without saving. For writing there must be matching |BufWriteCmd|,
1404 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 *'casemap'* *'cmp'*
1407'casemap' 'cmp' string (default: "internal,keepascii")
1408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 Specifies details about changing the case of letters. It may contain
1410 these words, separated by a comma:
1411 internal Use internal case mapping functions, the current
1412 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001413 matters when 'encoding' is a Unicode encoding,
1414 "latin1" or "iso-8859-15". When "internal" is
1415 omitted, the towupper() and towlower() system library
1416 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1418 case mapping, the current locale is not effective.
1419 This probably only matters for Turkish.
1420
1421 *'cdpath'* *'cd'* *E344* *E346*
1422'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 {not available when compiled without the
1425 |+file_in_path| feature}
1426 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001427 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1428 searched for has a relative path, not an absolute part starting with
1429 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 The 'cdpath' option's value has the same form and semantics as
1431 |'path'|. Also see |file-searching|.
1432 The default value is taken from $CDPATH, with a "," prepended to look
1433 in the current directory first.
1434 If the default value taken from $CDPATH is not what you want, include
1435 a modified version of the following command in your vimrc file to
1436 override it: >
1437 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1438< This option cannot be set from a |modeline| or in the |sandbox|, for
1439 security reasons.
1440 (parts of 'cdpath' can be passed to the shell to expand file names).
1441
1442 *'cedit'*
1443'cedit' string (Vi default: "", Vim default: CTRL-F)
1444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 The key used in Command-line Mode to open the command-line window.
1446 The default is CTRL-F when 'compatible' is off.
1447 Only non-printable keys are allowed.
1448 The key can be specified as a single character, but it is difficult to
1449 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001450 :exe "set cedit=\<C-Y>"
1451 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452< |Nvi| also has this option, but it only uses the first character.
1453 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001454 NOTE: This option is set to the Vim default value when 'compatible'
1455 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1458'charconvert' 'ccv' string (default "")
1459 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001460 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 An expression that is used for character encoding conversion. It is
1462 evaluated when a file that is to be read or has been written has a
1463 different encoding from what is desired.
1464 'charconvert' is not used when the internal iconv() function is
1465 supported and is able to do the conversion. Using iconv() is
1466 preferred, because it is much faster.
1467 'charconvert' is not used when reading stdin |--|, because there is no
1468 file to convert from. You will have to save the text in a file first.
1469 The expression must return zero or an empty string for success,
1470 non-zero for failure.
1471 The possible encoding names encountered are in 'encoding'.
1472 Additionally, names given in 'fileencodings' and 'fileencoding' are
1473 used.
1474 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1475 is done internally by Vim, 'charconvert' is not used for this.
1476 'charconvert' is also used to convert the viminfo file, if the 'c'
1477 flag is present in 'viminfo'. Also used for Unicode conversion.
1478 Example: >
1479 set charconvert=CharConvert()
1480 fun CharConvert()
1481 system("recode "
1482 \ . v:charconvert_from . ".." . v:charconvert_to
1483 \ . " <" . v:fname_in . " >" v:fname_out)
1484 return v:shell_error
1485 endfun
1486< The related Vim variables are:
1487 v:charconvert_from name of the current encoding
1488 v:charconvert_to name of the desired encoding
1489 v:fname_in name of the input file
1490 v:fname_out name of the output file
1491 Note that v:fname_in and v:fname_out will never be the same.
1492 Note that v:charconvert_from and v:charconvert_to may be different
1493 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1494 Encryption is not done by Vim when using 'charconvert'. If you want
1495 to encrypt the file after conversion, 'charconvert' should take care
1496 of this.
1497 This option cannot be set from a |modeline| or in the |sandbox|, for
1498 security reasons.
1499
1500 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1501'cindent' 'cin' boolean (default off)
1502 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 {not available when compiled without the |+cindent|
1504 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001505 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 that trigger reindenting in insert mode and 'cinoptions' to set your
1507 preferred indent style.
1508 If 'indentexpr' is not empty, it overrules 'cindent'.
1509 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1510 the "=" operator indents using this algorithm rather than calling an
1511 external program.
1512 See |C-indenting|.
1513 When you don't like the way 'cindent' works, try the 'smartindent'
1514 option or 'indentexpr'.
1515 This option is not used when 'paste' is set.
1516 NOTE: This option is reset when 'compatible' is set.
1517
1518 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001519'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 {not available when compiled without the |+cindent|
1522 feature}
1523 A list of keys that, when typed in Insert mode, cause reindenting of
1524 the current line. Only used if 'cindent' is on and 'indentexpr' is
1525 empty.
1526 For the format of this option see |cinkeys-format|.
1527 See |C-indenting|.
1528
1529 *'cinoptions'* *'cino'*
1530'cinoptions' 'cino' string (default "")
1531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 {not available when compiled without the |+cindent|
1533 feature}
1534 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1535 program. See |cinoptions-values| for the values of this option, and
1536 |C-indenting| for info on C indenting in general.
1537
1538
1539 *'cinwords'* *'cinw'*
1540'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 {not available when compiled without both the
1543 |+cindent| and the |+smartindent| features}
1544 These keywords start an extra indent in the next line when
1545 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1546 an appropriate place (inside {}).
1547 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1548 matter, include the keyword both the uppercase and lowercase:
1549 "if,If,IF".
1550
1551 *'clipboard'* *'cb'*
1552'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1553 for X-windows, "" otherwise)
1554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 {only in GUI versions or when the |+xterm_clipboard|
1556 feature is included}
1557 This option is a list of comma separated names.
1558 These names are recognized:
1559
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001560 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 unnamed When included, Vim will use the clipboard register '*'
1562 for all yank, delete, change and put operations which
1563 would normally go to the unnamed register. When a
1564 register is explicitly specified, it will always be
1565 used regardless of whether "unnamed" is in 'clipboard'
1566 or not. The clipboard register can always be
1567 explicitly accessed using the "* notation. Also see
1568 |gui-clipboard|.
1569
Bram Moolenaar30b65812012-07-12 22:01:11 +02001570 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001571 unnamedplus A variant of the "unnamed" flag which uses the
1572 clipboard register '+' (|quoteplus|) instead of
1573 register '*' for all yank, delete, change and put
1574 operations which would normally go to the unnamed
1575 register. When "unnamed" is also included to the
1576 option, yank operations (but not delete, change or
1577 put) will additionally copy the text into register
1578 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001579 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001580 Availability can be checked with: >
1581 if has('unnamedplus')
1582<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001583 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 autoselect Works like the 'a' flag in 'guioptions': If present,
1585 then whenever Visual mode is started, or the Visual
1586 area extended, Vim tries to become the owner of the
1587 windowing system's global selection or put the
1588 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001589 register "*. See |'go-a'| and |quotestar| for details.
1590 When the GUI is active, the 'a' flag in 'guioptions'
1591 is used, when the GUI is not active, this "autoselect"
1592 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 Also applies to the modeless selection.
1594
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001595 *clipboard-autoselectplus*
1596 autoselectplus Like "autoselect" but using the + register instead of
1597 the * register. Compare to the 'P' flag in
1598 'guioptions'.
1599
1600 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 autoselectml Like "autoselect", but for the modeless selection
1602 only. Compare to the 'A' flag in 'guioptions'.
1603
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001604 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001605 html When the clipboard contains HTML, use this when
1606 pasting. When putting text on the clipboard, mark it
1607 as HTML. This works to copy rendered HTML from
1608 Firefox, paste it as raw HTML in Vim, select the HTML
1609 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001610 You probably want to add this only temporarily,
1611 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001612 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 exclude:{pattern}
1616 Defines a pattern that is matched against the name of
1617 the terminal 'term'. If there is a match, no
1618 connection will be made to the X server. This is
1619 useful in this situation:
1620 - Running Vim in a console.
1621 - $DISPLAY is set to start applications on another
1622 display.
1623 - You do not want to connect to the X server in the
1624 console, but do want this in a terminal emulator.
1625 To never connect to the X server use: >
1626 exclude:.*
1627< This has the same effect as using the |-X| argument.
1628 Note that when there is no connection to the X server
1629 the window title won't be restored and the clipboard
1630 cannot be accessed.
1631 The value of 'magic' is ignored, {pattern} is
1632 interpreted as if 'magic' was on.
1633 The rest of the option value will be used for
1634 {pattern}, this must be the last entry.
1635
1636 *'cmdheight'* *'ch'*
1637'cmdheight' 'ch' number (default 1)
1638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 Number of screen lines to use for the command-line. Helps avoiding
1640 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001641 The value of this option is stored with the tab page, so that each tab
1642 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643
1644 *'cmdwinheight'* *'cwh'*
1645'cmdwinheight' 'cwh' number (default 7)
1646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 Number of screen lines to use for the command-line window. |cmdwin|
1648
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001649 *'colorcolumn'* *'cc'*
1650'colorcolumn' 'cc' string (default "")
1651 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001652 {not available when compiled without the |+syntax|
1653 feature}
1654 'colorcolumn' is a comma separated list of screen columns that are
1655 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1656 text. Will make screen redrawing slower.
1657 The screen column can be an absolute number, or a number preceded with
1658 '+' or '-', which is added to or subtracted from 'textwidth'. >
1659
1660 :set cc=+1 " highlight column after 'textwidth'
1661 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1662 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1663<
1664 When 'textwidth' is zero then the items with '-' and '+' are not used.
1665 A maximum of 256 columns are highlighted.
1666
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 *'columns'* *'co'* *E594*
1668'columns' 'co' number (default 80 or terminal width)
1669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001671 initialization and does not have to be set by hand. Also see
1672 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 When Vim is running in the GUI or in a resizable window, setting this
1674 option will cause the window size to be changed. When you only want
1675 to use the size for the GUI, put the command in your |gvimrc| file.
1676 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001677 number of columns of the display, the display may be messed up. For
1678 the GUI it is always possible and Vim limits the number of columns to
1679 what fits on the screen. You can use this command to get the widest
1680 window possible: >
1681 :set columns=9999
1682< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683
1684 *'comments'* *'com'* *E524* *E525*
1685'comments' 'com' string (default
1686 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1687 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 {not available when compiled without the |+comments|
1689 feature}
1690 A comma separated list of strings that can start a comment line. See
1691 |format-comments|. See |option-backslash| about using backslashes to
1692 insert a space.
1693
1694 *'commentstring'* *'cms'* *E537*
1695'commentstring' 'cms' string (default "/*%s*/")
1696 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001697 {not available when compiled without the |+folding|
1698 feature}
1699 A template for a comment. The "%s" in the value is replaced with the
1700 comment text. Currently only used to add markers for folding, see
1701 |fold-marker|.
1702
1703 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001704'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001705 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001707 This option has the effect of making Vim either more Vi-compatible, or
1708 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709
Bram Moolenaar071d4272004-06-13 20:20:40 +00001710 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001711 other options are also changed as a side effect.
1712 NOTE: Setting or resetting this option can have a lot of unexpected
1713 effects: Mappings are interpreted in another way, undo behaves
1714 differently, etc. If you set this option in your vimrc file, you
1715 should probably put it at the very start.
1716
Bram Moolenaar071d4272004-06-13 20:20:40 +00001717 By default this option is on and the Vi defaults are used for the
1718 options. This default was chosen for those people who want to use Vim
1719 just like Vi, and don't even (want to) know about the 'compatible'
1720 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001721 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001722 this option is switched off, and all options that have not been
1723 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001724 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001725 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001726 happen for the system-wide vimrc or gvimrc file, nor for a file given
1727 with the |-u| argument). Also see |compatible-default| and
1728 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001729 You can also set this option with the "-C" argument, and reset it with
1730 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001732
Bram Moolenaar214641f2017-03-05 17:04:09 +01001733 When this option is set, numerous other options are set to make Vim as
1734 Vi-compatible as possible. When this option is unset, various options
1735 are set to make Vim more useful. The table below lists all the
1736 options affected.
1737 The {?} column indicates when the options are affected:
1738 + Means that the option is set to the value given in {set value} when
1739 'compatible' is set.
1740 & Means that the option is set to the value given in {set value} when
1741 'compatible' is set AND is set to its Vim default value when
1742 'compatible' is unset.
1743 - Means the option is NOT changed when setting 'compatible' but IS
1744 set to its Vim default when 'compatible' is unset.
1745 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001746
Bram Moolenaar036986f2017-03-16 17:41:02 +01001747 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001748
1749 'allowrevins' + off no CTRL-_ command
1750 'antialias' + off don't use antialiased fonts
1751 'arabic' + off reset arabic-related options
1752 'arabicshape' + on correct character shapes
1753 'backspace' + "" normal backspace
1754 'backup' + off no backup file
1755 'backupcopy' & Unix: "yes" backup file is a copy
1756 else: "auto" copy or rename backup file
1757 'balloonexpr' + "" text to show in evaluation balloon
1758 'breakindent' + off don't indent when wrapping lines
1759 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1760 'cindent' + off no C code indentation
1761 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1762 'copyindent' + off don't copy indent structure
1763 'cpoptions' & (all flags) Vi-compatible flags
1764 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001765 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001767 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001768 'cscopeverbose' + off see |cscopeverbose|
1769 'delcombine' + off unicode: delete whole char combination
1770 'digraph' + off no digraphs
1771 'esckeys' & off no <Esc>-keys in Insert mode
1772 'expandtab' + off tabs not expanded to spaces
1773 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001774 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001775 'formatexpr' + "" use 'formatprg' for auto-formatting
1776 'formatoptions' & "vt" Vi compatible formatting
1777 'gdefault' + off no default 'g' flag for ":s"
1778 'history' & 0 no commandline history
1779 'hkmap' + off no Hebrew keyboard mapping
1780 'hkmapp' + off no phonetic Hebrew keyboard mapping
1781 'hlsearch' + off no highlighting of search matches
1782 'incsearch' + off no incremental searching
1783 'indentexpr' + "" no indenting by expression
1784 'insertmode' + off do not start in Insert mode
1785 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001786 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001787 'joinspaces' + on insert 2 spaces after period
1788 'modeline' & off no modelines
1789 'more' & off no pauses in listings
1790 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1791 'numberwidth' & 8 min number of columns for line number
1792 'preserveindent'+ off don't preserve current indent structure
1793 when changing it
1794 'revins' + off no reverse insert
1795 'ruler' + off no ruler
1796 'scrolljump' + 1 no jump scroll
1797 'scrolloff' + 0 no scroll offset
1798 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1799 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001800 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001801 'showcmd' & off command characters not shown
1802 'showmode' & off current mode not shown
1803 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1804 'smartcase' + off no automatic ignore case switch
1805 'smartindent' + off no smart indentation
1806 'smarttab' + off no smart tab size
1807 'softtabstop' + 0 tabs are always 'tabstop' positions
1808 'startofline' + on goto startofline with some commands
1809 'tagcase' & "followic" 'ignorecase' when searching tags file
1810 'tagrelative' & off tag file names are not relative
1811 'termguicolors' + off don't use highlight-(guifg|guibg)
1812 'textauto' & off no automatic textmode detection
1813 'textwidth' + 0 no automatic line wrap
1814 'tildeop' + off tilde is not an operator
1815 'ttimeout' + off no terminal timeout
1816 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001817 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001818 'virtualedit' + "" cursor can only be placed on characters
1819 'whichwrap' & "" left-right movements don't wrap
1820 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001822 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001823
1824 *'complete'* *'cpt'* *E535*
1825'complete' 'cpt' string (default: ".,w,b,u,t,i")
1826 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001827 This option specifies how keyword completion |ins-completion| works
1828 when CTRL-P or CTRL-N are used. It is also used for whole-line
1829 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1830 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001831 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001832 w scan buffers from other windows
1833 b scan other loaded buffers that are in the buffer list
1834 u scan the unloaded buffers that are in the buffer list
1835 U scan the buffers that are not in the buffer list
1836 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001837 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001838 k{dict} scan the file {dict}. Several "k" flags can be given,
1839 patterns are valid too. For example: >
1840 :set cpt=k/usr/dict/*,k~/spanish
1841< s scan the files given with the 'thesaurus' option
1842 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1843 are valid too.
1844 i scan current and included files
1845 d scan current and included files for defined name or macro
1846 |i_CTRL-X_CTRL-D|
1847 ] tag completion
1848 t same as "]"
1849
1850 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1851 not executed, this may lead to unexpected completions from some files
1852 (gzipped files for example). Unloaded buffers are not scanned for
1853 whole-line completion.
1854
1855 The default is ".,w,b,u,t,i", which means to scan:
1856 1. the current buffer
1857 2. buffers in other windows
1858 3. other loaded buffers
1859 4. unloaded buffers
1860 5. tags
1861 6. included files
1862
1863 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001864 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1865 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001866
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001867 *'completefunc'* *'cfu'*
1868'completefunc' 'cfu' string (default: empty)
1869 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001870 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001871 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001872 This option specifies a function to be used for Insert mode completion
1873 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001874 See |complete-functions| for an explanation of how the function is
1875 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001876 This option cannot be set from a |modeline| or in the |sandbox|, for
1877 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001878
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001879 *'completeslash'* *'csl'*
1880'completeslash' 'csl' string (default: "")
1881 local to buffer
1882 {not in Vi} {only for MS-Windows}
1883 When this option is set it overrules 'shellslash' for completion:
1884 - When this option is set to "slash", a forward slash is used for path
1885 completion in insert mode. This is useful when editing HTML tag, or
1886 Makefile with 'noshellslash' on Windows.
1887 - When this option is set to "backslash", backslash is used. This is
1888 useful when editing a batch file with 'shellslash' set on Windows.
1889 - When this option is empty, same character is used as for
1890 'shellslash'.
1891 For Insert mode completion the buffer-local value is used. For
1892 command line completion the global value is used.
1893
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001895'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001896 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001897 A comma separated list of options for Insert mode completion
1898 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001899
1900 menu Use a popup menu to show the possible completions. The
1901 menu is only shown when there is more than one match and
1902 sufficient colors are available. |ins-completion-menu|
1903
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001905 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001906 match, e.g., what file it comes from.
1907
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001908 longest Only insert the longest common text of the matches. If
1909 the menu is displayed you can use CTRL-L to add more
1910 characters. Whether case is ignored depends on the kind
1911 of completion. For buffer text the 'ignorecase' option is
1912 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001913
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001914 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001915 completion in the preview window. Only works in
1916 combination with "menu" or "menuone".
1917
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001918 popup Show extra information about the currently selected
1919 completion in a popup window. Only works in combination
1920 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001921 See |'completepopup'| for specifying properties.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001922 {only works when compiled with the +textprop feature}
1923
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001924 noinsert Do not insert any text for a match until the user selects
1925 a match from the menu. Only works in combination with
1926 "menu" or "menuone". No effect if "longest" is present.
1927
1928 noselect Do not select a match in the menu, force the user to
1929 select one from the menu. Only works in combination with
1930 "menu" or "menuone".
1931
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001932
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001933 *'completepopup'* *'cpp'*
1934'completepopup' 'cpp' string (default empty)
1935 global
1936 {not available when compiled without the |+textprop|
1937 or |+quickfix| feature}
1938 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001939 properties of the info popup when it is created. You can also use
1940 |popup_findinfo()| and then set properties for an existing info popup
1941 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001942
1943
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001944 *'concealcursor'* *'cocu'*
1945'concealcursor' 'cocu' string (default: "")
1946 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001947 {not available when compiled without the |+conceal|
1948 feature}
1949 Sets the modes in which text in the cursor line can also be concealed.
1950 When the current mode is listed then concealing happens just like in
1951 other lines.
1952 n Normal mode
1953 v Visual mode
1954 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001955 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001956
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001957 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001958 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001959 are moving around text is concealed, but when starting to insert text
1960 or selecting a Visual area the concealed text is displayed, so that
1961 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001962 Keep in mind that the cursor position is not always where it's
1963 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964
1965
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001966 *'conceallevel'* *'cole'*
1967'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001968 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001969 {not available when compiled without the |+conceal|
1970 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001971 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1972 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001974 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001975 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001976 1 Each block of concealed text is replaced with one
1977 character. If the syntax item does not have a custom
1978 replacement character defined (see |:syn-cchar|) the
1979 character defined in 'listchars' is used (default is a
1980 space).
1981 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001982 2 Concealed text is completely hidden unless it has a
1983 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001984 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001985 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001986
Bram Moolenaara7781e02010-07-19 20:13:22 +02001987 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001988 edit and copy the text. This can be changed with the 'concealcursor'
1989 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001990
Bram Moolenaar071d4272004-06-13 20:20:40 +00001991 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1992'confirm' 'cf' boolean (default off)
1993 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001994 When 'confirm' is on, certain operations that would normally
1995 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
1996 instead raise a |dialog| asking if you wish to save the current
1997 file(s). You can still use a ! to unconditionally |abandon| a buffer.
1998 If 'confirm' is off you can still activate confirmation for one
1999 command only (this is most useful in mappings) with the |:confirm|
2000 command.
2001 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2002
2003 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2004'conskey' 'consk' boolean (default off)
2005 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002006 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002007
2008 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2009'copyindent' 'ci' boolean (default off)
2010 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002011 Copy the structure of the existing lines indent when autoindenting a
2012 new line. Normally the new indent is reconstructed by a series of
2013 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2014 in which case only spaces are used). Enabling this option makes the
2015 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002016 existing line. 'expandtab' has no effect on these characters, a Tab
2017 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002018 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002019 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002020 Also see 'preserveindent'.
2021
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002022 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023'cpoptions' 'cpo' string (Vim default: "aABceFs",
2024 Vi default: all flags)
2025 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002026 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002027 this indicates Vi-compatible behavior. This is used for things where
2028 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002029 'cpoptions' stands for "compatible-options".
2030 Commas can be added for readability.
2031 To avoid problems with flags that are added in the future, use the
2032 "+=" and "-=" feature of ":set" |add-option-flags|.
2033 NOTE: This option is set to the Vi default value when 'compatible' is
2034 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002035 NOTE: This option is set to the POSIX default value at startup when
2036 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002037 variable exists |posix|. This means Vim tries to behave like the
2038 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002039
2040 contains behavior ~
2041 *cpo-a*
2042 a When included, a ":read" command with a file name
2043 argument will set the alternate file name for the
2044 current window.
2045 *cpo-A*
2046 A When included, a ":write" command with a file name
2047 argument will set the alternate file name for the
2048 current window.
2049 *cpo-b*
2050 b "\|" in a ":map" command is recognized as the end of
2051 the map command. The '\' is included in the mapping,
2052 the text after the '|' is interpreted as the next
2053 command. Use a CTRL-V instead of a backslash to
2054 include the '|' in the mapping. Applies to all
2055 mapping, abbreviation, menu and autocmd commands.
2056 See also |map_bar|.
2057 *cpo-B*
2058 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002059 abbreviations, user commands and the "to" part of the
2060 menu commands. Remove this flag to be able to use a
2061 backslash like a CTRL-V. For example, the command
2062 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002063 'B' included: "\^[" (^[ is a real <Esc>)
2064 'B' excluded: "<Esc>" (5 characters)
2065 ('<' excluded in both cases)
2066 *cpo-c*
2067 c Searching continues at the end of any match at the
2068 cursor position, but not further than the start of the
2069 next line. When not present searching continues
2070 one character from the cursor position. With 'c'
2071 "abababababab" only gets three matches when repeating
2072 "/abab", without 'c' there are five matches.
2073 *cpo-C*
2074 C Do not concatenate sourced lines that start with a
2075 backslash. See |line-continuation|.
2076 *cpo-d*
2077 d Using "./" in the 'tags' option doesn't mean to use
2078 the tags file relative to the current file, but the
2079 tags file in the current directory.
2080 *cpo-D*
2081 D Can't use CTRL-K to enter a digraph after Normal mode
2082 commands with a character argument, like |r|, |f| and
2083 |t|.
2084 *cpo-e*
2085 e When executing a register with ":@r", always add a
2086 <CR> to the last line, also when the register is not
2087 linewise. If this flag is not present, the register
2088 is not linewise and the last line does not end in a
2089 <CR>, then the last line is put on the command-line
2090 and can be edited before hitting <CR>.
2091 *cpo-E*
2092 E It is an error when using "y", "d", "c", "g~", "gu" or
2093 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002094 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002095 This makes "y0" fail in the first column.
2096 *cpo-f*
2097 f When included, a ":read" command with a file name
2098 argument will set the file name for the current buffer,
2099 if the current buffer doesn't have a file name yet.
2100 *cpo-F*
2101 F When included, a ":write" command with a file name
2102 argument will set the file name for the current
2103 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002104 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002105 *cpo-g*
2106 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002107 *cpo-H*
2108 H When using "I" on a line with only blanks, insert
2109 before the last blank. Without this flag insert after
2110 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002111 *cpo-i*
2112 i When included, interrupting the reading of a file will
2113 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002114 *cpo-I*
2115 I When moving the cursor up or down just after inserting
2116 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002117 *cpo-j*
2118 j When joining lines, only add two spaces after a '.',
2119 not after '!' or '?'. Also see 'joinspaces'.
2120 *cpo-J*
2121 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002122 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002123 white space.
2124 *cpo-k*
2125 k Disable the recognition of raw key codes in
2126 mappings, abbreviations, and the "to" part of menu
2127 commands. For example, if <Key> sends ^[OA (where ^[
2128 is <Esc>), the command ":map X ^[OA" results in X
2129 being mapped to:
2130 'k' included: "^[OA" (3 characters)
2131 'k' excluded: "<Key>" (one key code)
2132 Also see the '<' flag below.
2133 *cpo-K*
2134 K Don't wait for a key code to complete when it is
2135 halfway a mapping. This breaks mapping <F1><F1> when
2136 only part of the second <F1> has been read. It
2137 enables cancelling the mapping by typing <F1><Esc>.
2138 *cpo-l*
2139 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002140 literally, only "\]", "\^", "\-" and "\\" are special.
2141 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002142 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2143 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002144 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002145 *cpo-L*
2146 L When the 'list' option is set, 'wrapmargin',
2147 'textwidth', 'softtabstop' and Virtual Replace mode
2148 (see |gR|) count a <Tab> as two characters, instead of
2149 the normal behavior of a <Tab>.
2150 *cpo-m*
2151 m When included, a showmatch will always wait half a
2152 second. When not included, a showmatch will wait half
2153 a second or until a character is typed. |'showmatch'|
2154 *cpo-M*
2155 M When excluded, "%" matching will take backslashes into
2156 account. Thus in "( \( )" and "\( ( \)" the outer
2157 parenthesis match. When included "%" ignores
2158 backslashes, which is Vi compatible.
2159 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002160 n When included, the column used for 'number' and
2161 'relativenumber' will also be used for text of wrapped
2162 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002163 *cpo-o*
2164 o Line offset to search command is not remembered for
2165 next search.
2166 *cpo-O*
2167 O Don't complain if a file is being overwritten, even
2168 when it didn't exist when editing it. This is a
2169 protection against a file unexpectedly created by
2170 someone else. Vi didn't complain about this.
2171 *cpo-p*
2172 p Vi compatible Lisp indenting. When not present, a
2173 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002174 *cpo-P*
2175 P When included, a ":write" command that appends to a
2176 file will set the file name for the current buffer, if
2177 the current buffer doesn't have a file name yet and
2178 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002179 *cpo-q*
2180 q When joining multiple lines leave the cursor at the
2181 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002182 *cpo-r*
2183 r Redo ("." command) uses "/" to repeat a search
2184 command, instead of the actually used search string.
2185 *cpo-R*
2186 R Remove marks from filtered lines. Without this flag
2187 marks are kept like |:keepmarks| was used.
2188 *cpo-s*
2189 s Set buffer options when entering the buffer for the
2190 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002191 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002192 set when the buffer is created.
2193 *cpo-S*
2194 S Set buffer options always when entering a buffer
2195 (except 'readonly', 'fileformat', 'filetype' and
2196 'syntax'). This is the (most) Vi compatible setting.
2197 The options are set to the values in the current
2198 buffer. When you change an option and go to another
2199 buffer, the value is copied. Effectively makes the
2200 buffer options global to all buffers.
2201
2202 's' 'S' copy buffer options
2203 no no when buffer created
2204 yes no when buffer first entered (default)
2205 X yes each time when buffer entered (vi comp.)
2206 *cpo-t*
2207 t Search pattern for the tag command is remembered for
2208 "n" command. Otherwise Vim only puts the pattern in
2209 the history for search pattern, but doesn't change the
2210 last used search pattern.
2211 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002212 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002213 *cpo-v*
2214 v Backspaced characters remain visible on the screen in
2215 Insert mode. Without this flag the characters are
2216 erased from the screen right away. With this flag the
2217 screen newly typed text overwrites backspaced
2218 characters.
2219 *cpo-w*
2220 w When using "cw" on a blank character, only change one
2221 character and not all blanks until the start of the
2222 next word.
2223 *cpo-W*
2224 W Don't overwrite a readonly file. When omitted, ":w!"
2225 overwrites a readonly file, if possible.
2226 *cpo-x*
2227 x <Esc> on the command-line executes the command-line.
2228 The default in Vim is to abandon the command-line,
2229 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002230 *cpo-X*
2231 X When using a count with "R" the replaced text is
2232 deleted only once. Also when repeating "R" with "."
2233 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002234 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002235 y A yank command can be redone with ".". Think twice if
2236 you really want to use this, it may break some
2237 plugins, since most people expect "." to only repeat a
2238 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002239 *cpo-Z*
2240 Z When using "w!" while the 'readonly' option is set,
2241 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002242 *cpo-!*
2243 ! When redoing a filter command, use the last used
2244 external command, whatever it was. Otherwise the last
2245 used -filter- command is used.
2246 *cpo-$*
2247 $ When making a change to one line, don't redisplay the
2248 line, but put a '$' at the end of the changed text.
2249 The changed text will be overwritten when you type the
2250 new text. The line is redisplayed if you type any
2251 command that moves the cursor from the insertion
2252 point.
2253 *cpo-%*
2254 % Vi-compatible matching is done for the "%" command.
2255 Does not recognize "#if", "#endif", etc.
2256 Does not recognize "/*" and "*/".
2257 Parens inside single and double quotes are also
2258 counted, causing a string that contains a paren to
2259 disturb the matching. For example, in a line like
2260 "if (strcmp("foo(", s))" the first paren does not
2261 match the last one. When this flag is not included,
2262 parens inside single and double quotes are treated
2263 specially. When matching a paren outside of quotes,
2264 everything inside quotes is ignored. When matching a
2265 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002266 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002267 This flag is also used for other features, such as
2268 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002269 *cpo--*
2270 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002271 it would go above the first line or below the last
2272 line. Without it the cursor moves to the first or
2273 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002274 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002275 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002276 *cpo-+*
2277 + When included, a ":write file" command will reset the
2278 'modified' flag of the buffer, even though the buffer
2279 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002280 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002281 * Use ":*" in the same way as ":@". When not included,
2282 ":*" is an alias for ":'<,'>", select the Visual area.
2283 *cpo-<*
2284 < Disable the recognition of special key codes in |<>|
2285 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002286 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002287 ":map X <Tab>" results in X being mapped to:
2288 '<' included: "<Tab>" (5 characters)
2289 '<' excluded: "^I" (^I is a real <Tab>)
2290 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002291 *cpo->*
2292 > When appending to a register, put a line break before
2293 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002294 *cpo-;*
2295 ; When using |,| or |;| to repeat the last |t| search
2296 and the cursor is right in front of the searched
2297 character, the cursor won't move. When not included,
2298 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002299 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002300
2301 POSIX flags. These are not included in the Vi default value, except
2302 when $VIM_POSIX was set on startup. |posix|
2303
2304 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002305 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002306 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002307 *cpo-&*
2308 & When ":preserve" was used keep the swap file when
2309 exiting normally while this buffer is still loaded.
2310 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002311 *cpo-\*
2312 \ Backslash in a [] range in a search pattern is taken
2313 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002314 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2315 '\' excluded: "/[ \-]" finds <Space> and '-'
2316 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002317 *cpo-/*
2318 / When "%" is used as the replacement string in a |:s|
2319 command, use the previous replacement string. |:s%|
2320 *cpo-{*
2321 { The |{| and |}| commands also stop at a "{" character
2322 at the start of a line.
2323 *cpo-.*
2324 . The ":chdir" and ":cd" commands fail if the current
2325 buffer is modified, unless ! is used. Vim doesn't
2326 need this, since it remembers the full path of an
2327 opened file.
2328 *cpo-bar*
2329 | The value of the $LINES and $COLUMNS environment
2330 variables overrule the terminal size values obtained
2331 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002332
Bram Moolenaar071d4272004-06-13 20:20:40 +00002333
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002334 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002335'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002336 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002337 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002338 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002339 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002340 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002341 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002342 blowfish Blowfish method. Medium strong encryption but it has
2343 an implementation flaw. Requires Vim 7.3 or later,
2344 files can NOT be read by Vim 7.2 and older. This adds
2345 a "seed" to the file, every time you write the file
2346 the encrypted bytes will be different.
2347 *blowfish2*
2348 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002349 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002350 and older. This adds a "seed" to the file, every time
2351 you write the file the encrypted bytes will be
2352 different. The whole undo file is encrypted, not just
2353 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002354
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002355 You should use "blowfish2", also to re-encrypt older files.
2356
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002357 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002358 to the detected method of the file being read. Thus if you write it
2359 without changing 'cryptmethod' the same method will be used.
2360 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002361 explicitly write it, you don't get a warning unless there are other
2362 modifications. Also see |:X|.
2363
2364 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002365 the value "blowfish2". When setting the local value to an empty
2366 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002367
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002368 When a new encryption method is added in a later version of Vim, and
2369 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002370 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002371
2372
Bram Moolenaar071d4272004-06-13 20:20:40 +00002373 *'cscopepathcomp'* *'cspc'*
2374'cscopepathcomp' 'cspc' number (default 0)
2375 global
2376 {not available when compiled without the |+cscope|
2377 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 Determines how many components of the path to show in a list of tags.
2379 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002380 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002381
2382 *'cscopeprg'* *'csprg'*
2383'cscopeprg' 'csprg' string (default "cscope")
2384 global
2385 {not available when compiled without the |+cscope|
2386 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002387 Specifies the command to execute cscope. See |cscopeprg|.
2388 This option cannot be set from a |modeline| or in the |sandbox|, for
2389 security reasons.
2390
2391 *'cscopequickfix'* *'csqf'*
2392'cscopequickfix' 'csqf' string (default "")
2393 global
2394 {not available when compiled without the |+cscope|
2395 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002396 Specifies whether to use quickfix window to show cscope results.
2397 See |cscopequickfix|.
2398
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002399 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002400'cscoperelative' 'csre' boolean (default off)
2401 global
2402 {not available when compiled without the |+cscope|
2403 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002404 In the absence of a prefix (-P) for cscope. setting this option enables
2405 to use the basename of cscope.out path as the prefix.
2406 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002407 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002408
Bram Moolenaar071d4272004-06-13 20:20:40 +00002409 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2410'cscopetag' 'cst' boolean (default off)
2411 global
2412 {not available when compiled without the |+cscope|
2413 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 Use cscope for tag commands. See |cscope-options|.
2415 NOTE: This option is reset when 'compatible' is set.
2416
2417 *'cscopetagorder'* *'csto'*
2418'cscopetagorder' 'csto' number (default 0)
2419 global
2420 {not available when compiled without the |+cscope|
2421 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002422 Determines the order in which ":cstag" performs a search. See
2423 |cscopetagorder|.
2424 NOTE: This option is set to 0 when 'compatible' is set.
2425
2426 *'cscopeverbose'* *'csverb'*
2427 *'nocscopeverbose'* *'nocsverb'*
2428'cscopeverbose' 'csverb' boolean (default off)
2429 global
2430 {not available when compiled without the |+cscope|
2431 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002432 Give messages when adding a cscope database. See |cscopeverbose|.
2433 NOTE: This option is reset when 'compatible' is set.
2434
Bram Moolenaar860cae12010-06-05 23:22:07 +02002435 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2436'cursorbind' 'crb' boolean (default off)
2437 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002438 When this option is set, as the cursor in the current
2439 window moves other cursorbound windows (windows that also have
2440 this option set) move their cursors to the corresponding line and
2441 column. This option is useful for viewing the
2442 differences between two versions of a file (see 'diff'); in diff mode,
2443 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002444 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002445
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002446
2447 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2448'cursorcolumn' 'cuc' boolean (default off)
2449 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002450 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002451 feature}
2452 Highlight the screen column of the cursor with CursorColumn
2453 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2454 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002455 If you only want the highlighting in the current window you can use
2456 these autocommands: >
2457 au WinLeave * set nocursorline nocursorcolumn
2458 au WinEnter * set cursorline cursorcolumn
2459<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002460
2461 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2462'cursorline' 'cul' boolean (default off)
2463 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002464 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002465 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002466 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2467 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002468 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002469 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470
2471
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002472 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002473'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002474 local to window
2475 {not in Vi}
2476 {not available when compiled without the |+syntax|
2477 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002478 Comma separated list of settings for how 'cursorline' is displayed.
2479 Valid values:
2480 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002481 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002482 "screenline" Highlight only the screen line of the cursor with
2483 CursorLine |hl-CursorLine|.
2484 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002486
2487 Special value:
2488 "both" Alias for the values "line,number".
2489
2490 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002491
2492
Bram Moolenaar071d4272004-06-13 20:20:40 +00002493 *'debug'*
2494'debug' string (default "")
2495 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002496 These values can be used:
2497 msg Error messages that would otherwise be omitted will be given
2498 anyway.
2499 throw Error messages that would otherwise be omitted will be given
2500 anyway and also throw an exception and set |v:errmsg|.
2501 beep A message will be given when otherwise only a beep would be
2502 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002503 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002504 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2505 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002506
2507 *'define'* *'def'*
2508'define' 'def' string (default "^\s*#\s*define")
2509 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002510 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002511 pattern, just like for the "/" command. This option is used for the
2512 commands like "[i" and "[d" |include-search|. The 'isident' option is
2513 used to recognize the defined name after the match:
2514 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2515 See |option-backslash| about inserting backslashes to include a space
2516 or backslash.
2517 The default value is for C programs. For C++ this value would be
2518 useful, to include const type declarations: >
2519 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002520< You can also use "\ze" just before the name and continue the pattern
2521 to check what is following. E.g. for Javascript, if a function is
2522 defined with "func_name = function(args)": >
2523 ^\s*\ze\i\+\s*=\s*function(
2524< If the function is defined with "func_name : function() {...": >
2525 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002526< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002527 To avoid that use `:let` with a single quote string: >
2528 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002529<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530
2531 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2532'delcombine' 'deco' boolean (default off)
2533 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534 If editing Unicode and this option is set, backspace and Normal mode
2535 "x" delete each combining character on its own. When it is off (the
2536 default) the character along with its combining characters are
2537 deleted.
2538 Note: When 'delcombine' is set "xx" may work different from "2x"!
2539
2540 This is useful for Arabic, Hebrew and many other languages where one
2541 may have combining characters overtop of base characters, and want
2542 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002543 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002544
2545 *'dictionary'* *'dict'*
2546'dictionary' 'dict' string (default "")
2547 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548 List of file names, separated by commas, that are used to lookup words
2549 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2550 contain a list of words. This can be one word per line, or several
2551 words per line, separated by non-keyword characters (white space is
2552 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002553
2554 When this option is empty or an entry "spell" is present, and spell
2555 checking is enabled, words in the word lists for the currently active
2556 'spelllang' are used. See |spell|.
2557
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002558 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002559 after a comma are ignored, otherwise spaces are included in the file
2560 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002561 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002562 Where to find a list of words?
2563 - On FreeBSD, there is the file "/usr/share/dict/words".
2564 - In the Simtel archive, look in the "msdos/linguist" directory.
2565 - In "miscfiles" of the GNU collection.
2566 The use of |:set+=| and |:set-=| is preferred when adding or removing
2567 directories from the list. This avoids problems when a future version
2568 uses another default.
2569 Backticks cannot be used in this option for security reasons.
2570
2571 *'diff'* *'nodiff'*
2572'diff' boolean (default off)
2573 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002574 {not available when compiled without the |+diff|
2575 feature}
2576 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002577 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578
2579 *'dex'* *'diffexpr'*
2580'diffexpr' 'dex' string (default "")
2581 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582 {not available when compiled without the |+diff|
2583 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002584 Expression which is evaluated to obtain a diff file (either ed-style
2585 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 This option cannot be set from a |modeline| or in the |sandbox|, for
2587 security reasons.
2588
2589 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002590'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002591 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002592 {not available when compiled without the |+diff|
2593 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002594 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 All are optional. Items must be separated by a comma.
2596
2597 filler Show filler lines, to keep the text
2598 synchronized with a window that has inserted
2599 lines at the same position. Mostly useful
2600 when windows are side-by-side and 'scrollbind'
2601 is set.
2602
2603 context:{n} Use a context of {n} lines between a change
2604 and a fold that contains unchanged lines.
2605 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002606 When using zero the context is actually one,
2607 since folds require a line in between, also
2608 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002609 See |fold-diff|.
2610
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002611 iblank Ignore changes where lines are all blank. Adds
2612 the "-B" flag to the "diff" command if
2613 'diffexpr' is empty. Check the documentation
2614 of the "diff" command for what this does
2615 exactly.
2616 NOTE: the diff windows will get out of sync,
2617 because no differences between blank lines are
2618 taken into account.
2619
Bram Moolenaar071d4272004-06-13 20:20:40 +00002620 icase Ignore changes in case of text. "a" and "A"
2621 are considered the same. Adds the "-i" flag
2622 to the "diff" command if 'diffexpr' is empty.
2623
2624 iwhite Ignore changes in amount of white space. Adds
2625 the "-b" flag to the "diff" command if
2626 'diffexpr' is empty. Check the documentation
2627 of the "diff" command for what this does
2628 exactly. It should ignore adding trailing
2629 white space, but not leading white space.
2630
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002631 iwhiteall Ignore all white space changes. Adds
2632 the "-w" flag to the "diff" command if
2633 'diffexpr' is empty. Check the documentation
2634 of the "diff" command for what this does
2635 exactly.
2636
2637 iwhiteeol Ignore white space changes at end of line.
2638 Adds the "-Z" flag to the "diff" command if
2639 'diffexpr' is empty. Check the documentation
2640 of the "diff" command for what this does
2641 exactly.
2642
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002643 horizontal Start diff mode with horizontal splits (unless
2644 explicitly specified otherwise).
2645
2646 vertical Start diff mode with vertical splits (unless
2647 explicitly specified otherwise).
2648
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002649 hiddenoff Do not use diff mode for a buffer when it
2650 becomes hidden.
2651
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002652 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2653 starting diff mode. Without this 2 is used.
2654
Bram Moolenaare828b762018-09-10 17:51:58 +02002655 internal Use the internal diff library. This is
2656 ignored when 'diffexpr' is set. *E960*
2657 When running out of memory when writing a
2658 buffer this item will be ignored for diffs
2659 involving that buffer. Set the 'verbose'
2660 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002661
Bram Moolenaare828b762018-09-10 17:51:58 +02002662 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002663 Use the indent heuristic for the internal
2664 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002665
2666 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002667 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002668 algorithms are:
2669 myers the default algorithm
2670 minimal spend extra time to generate the
2671 smallest possible diff
2672 patience patience diff algorithm
2673 histogram histogram diff algorithm
2674
2675 Examples: >
2676 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002677 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002678 :set diffopt=internal,filler,foldcolumn:3
2679 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002680<
2681 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2682'digraph' 'dg' boolean (default off)
2683 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684 {not available when compiled without the |+digraphs|
2685 feature}
2686 Enable the entering of digraphs in Insert mode with {char1} <BS>
2687 {char2}. See |digraphs|.
2688 NOTE: This option is reset when 'compatible' is set.
2689
2690 *'directory'* *'dir'*
2691'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002692 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002693 for Unix: ".,~/tmp,/var/tmp,/tmp")
2694 global
2695 List of directory names for the swap file, separated with commas.
2696 - The swap file will be created in the first directory where this is
2697 possible.
2698 - Empty means that no swap file will be used (recovery is
2699 impossible!).
2700 - A directory "." means to put the swap file in the same directory as
2701 the edited file. On Unix, a dot is prepended to the file name, so
2702 it doesn't show in a directory listing. On MS-Windows the "hidden"
2703 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002704 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002705 put the swap file relative to where the edited file is. The leading
2706 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002707 - For Unix and Win32, if a directory ends in two path separators "//",
2708 the swap file name will be built from the complete path to the file
2709 with all path separators substituted to percent '%' signs. This will
2710 ensure file name uniqueness in the preserve directory.
2711 On Win32, it is also possible to end with "\\". However, When a
2712 separating comma is following, you must use "//", since "\\" will
2713 include the comma in the file name. Therefore it is recommended to
2714 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002715 - Spaces after the comma are ignored, other spaces are considered part
2716 of the directory name. To have a space at the start of a directory
2717 name, precede it with a backslash.
2718 - To include a comma in a directory name precede it with a backslash.
2719 - A directory name may end in an ':' or '/'.
2720 - Environment variables are expanded |:set_env|.
2721 - Careful with '\' characters, type one before a space, type two to
2722 get one in the option (see |option-backslash|), for example: >
2723 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2724< - For backwards compatibility with Vim version 3.0 a '>' at the start
2725 of the option is removed.
2726 Using "." first in the list is recommended. This means that editing
2727 the same file twice will result in a warning. Using "/tmp" on Unix is
2728 discouraged: When the system crashes you lose the swap file.
2729 "/var/tmp" is often not cleared when rebooting, thus is a better
2730 choice than "/tmp". But it can contain a lot of files, your swap
2731 files get lost in the crowd. That is why a "tmp" directory in your
2732 home directory is tried first.
2733 The use of |:set+=| and |:set-=| is preferred when adding or removing
2734 directories from the list. This avoids problems when a future version
2735 uses another default.
2736 This option cannot be set from a |modeline| or in the |sandbox|, for
2737 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002738
2739 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002740'display' 'dy' string (default "", set to "truncate" in
2741 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002743 Change the way text is displayed. This is comma separated list of
2744 flags:
2745 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002746 in a window will be displayed. "@@@" is put in the
2747 last columns of the last screen line to indicate the
2748 rest of the line is not displayed.
2749 truncate Like "lastline", but "@@@" is displayed in the first
2750 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002751 uhex Show unprintable characters hexadecimal as <xx>
2752 instead of using ^C and ~C.
2753
Bram Moolenaard0796902016-09-16 20:02:31 +02002754 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002755 doesn't fit is replaced with "@" lines.
2756
Bram Moolenaar071d4272004-06-13 20:20:40 +00002757 *'eadirection'* *'ead'*
2758'eadirection' 'ead' string (default "both")
2759 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002760 Tells when the 'equalalways' option applies:
2761 ver vertically, width of windows is not affected
2762 hor horizontally, height of windows is not affected
2763 both width and height of windows is affected
2764
2765 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2766'edcompatible' 'ed' boolean (default off)
2767 global
2768 Makes the 'g' and 'c' flags of the ":substitute" command to be
2769 toggled each time the flag is given. See |complex-change|. See
2770 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002771 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002772
Bram Moolenaar03413f42016-04-12 21:07:15 +02002773 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002774'emoji' 'emo' boolean (default: on)
2775 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002776 When on all Unicode emoji characters are considered to be full width.
2777
2778
Bram Moolenaar071d4272004-06-13 20:20:40 +00002779 *'encoding'* *'enc'* *E543*
2780'encoding' 'enc' string (default: "latin1" or value from $LANG)
2781 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002782 Sets the character encoding used inside Vim. It applies to text in
2783 the buffers, registers, Strings in expressions, text stored in the
2784 viminfo file, etc. It sets the kind of characters which Vim can work
2785 with. See |encoding-names| for the possible values.
2786
2787 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002788 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002789 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002790 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002791
Bram Moolenaar865242e2010-07-14 21:12:05 +02002792 This option cannot be set from a |modeline|. It would most likely
2793 corrupt the text.
2794
Bram Moolenaar3df01732017-02-17 22:47:16 +01002795 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2796 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002797 'encoding', "utf-8" is the natural choice for the environment and
2798 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002799 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002800 versions, and to avoid changing the encoding of newly created files
2801 without your knowledge (in case 'fileencodings' is empty).
2802
2803 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002804 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002805 iconv() or as specified with 'charconvert'.
2806
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002807 If you need to know whether 'encoding' is a multi-byte encoding, you
2808 can use: >
2809 if has("multi_byte_encoding")
2810<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002811 Normally 'encoding' will be equal to your current locale. This will
2812 be the default if Vim recognizes your environment settings. If
2813 'encoding' is not set to the current locale, 'termencoding' must be
2814 set to convert typed and displayed text. See |encoding-table|.
2815
2816 When you set this option, it fires the |EncodingChanged| autocommand
2817 event so that you can set up fonts if necessary.
2818
2819 When the option is set, the value is converted to lowercase. Thus
2820 you can set it with uppercase values too. Underscores are translated
2821 to '-' signs.
2822 When the encoding is recognized, it is changed to the standard name.
2823 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2824 "iso-8859-2" and "utf8" becomes "utf-8".
2825
2826 Note: "latin1" is also used when the encoding could not be detected.
2827 This only works when editing files in the same encoding! When the
2828 actual character set is not latin1, make sure 'fileencoding' and
2829 'fileencodings' are empty. When conversion is needed, switch to using
2830 utf-8.
2831
2832 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2833 You don't notice this while editing, but it does matter for the
2834 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2835 setting 'encoding' to one of these values instead of utf-8 only has
2836 effect for encoding used for files when 'fileencoding' is empty.
2837
Bram Moolenaar661b1822005-07-28 22:36:45 +00002838 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2839 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002840
2841 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2842'endofline' 'eol' boolean (default on)
2843 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002845 is on, or 'fixeol' option is off, no <EOL> will be written for the
2846 last line in the file. This option is automatically set or reset when
2847 starting to edit a new file, depending on whether file has an <EOL>
2848 for the last line in the file. Normally you don't have to set or
2849 reset this option.
2850 When 'binary' is off and 'fixeol' is on the value is not used when
2851 writing the file. When 'binary' is on or 'fixeol' is off it is used
2852 to remember the presence of a <EOL> for the last line in the file, so
2853 that when you write the file the situation from the original file can
2854 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002855
2856 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2857'equalalways' 'ea' boolean (default on)
2858 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002860 splitting or closing a window. This also happens the moment the
2861 option is switched on. When off, splitting a window will reduce the
2862 size of the current window and leave the other windows the same. When
2863 closing a window the extra lines are given to the window next to it
2864 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002865 When mixing vertically and horizontally split windows, a minimal size
2866 is computed and some windows may be larger if there is room. The
2867 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002868 Changing the height and width of a window can be avoided by setting
2869 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002870 If a window size is specified when creating a new window sizes are
2871 currently not equalized (it's complicated, but may be implemented in
2872 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002873
2874 *'equalprg'* *'ep'*
2875'equalprg' 'ep' string (default "")
2876 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002878 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002879 or 'indentexpr'. When Vim was compiled without internal formatting,
2880 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002881 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002882 about including spaces and backslashes.
2883 This option cannot be set from a |modeline| or in the |sandbox|, for
2884 security reasons.
2885
2886 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2887'errorbells' 'eb' boolean (default off)
2888 global
2889 Ring the bell (beep or screen flash) for error messages. This only
2890 makes a difference for error messages, the bell will be used always
2891 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002892 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002893 screen flash or do nothing. See 'belloff' to finetune when to ring the
2894 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002895
2896 *'errorfile'* *'ef'*
2897'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2898 others: "errors.err")
2899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002900 {not available when compiled without the |+quickfix|
2901 feature}
2902 Name of the errorfile for the QuickFix mode (see |:cf|).
2903 When the "-q" command-line argument is used, 'errorfile' is set to the
2904 following argument. See |-q|.
2905 NOT used for the ":make" command. See 'makeef' for that.
2906 Environment variables are expanded |:set_env|.
2907 See |option-backslash| about including spaces and backslashes.
2908 This option cannot be set from a |modeline| or in the |sandbox|, for
2909 security reasons.
2910
2911 *'errorformat'* *'efm'*
2912'errorformat' 'efm' string (default is very long)
2913 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002914 {not available when compiled without the |+quickfix|
2915 feature}
2916 Scanf-like description of the format for the lines in the error file
2917 (see |errorformat|).
2918
2919 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2920'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002922 Function keys that start with an <Esc> are recognized in Insert
2923 mode. When this option is off, the cursor and function keys cannot be
2924 used in Insert mode if they start with an <Esc>. The advantage of
2925 this is that the single <Esc> is recognized immediately, instead of
2926 after one second. Instead of resetting this option, you might want to
2927 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2928 when 'esckeys' is off, you can still map anything, but the cursor keys
2929 won't work by default.
2930 NOTE: This option is set to the Vi default value when 'compatible' is
2931 set and to the Vim default value when 'compatible' is reset.
2932
2933 *'eventignore'* *'ei'*
2934'eventignore' 'ei' string (default "")
2935 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002936 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002937 When set to "all" or when "all" is one of the items, all autocommand
2938 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002939 Otherwise this is a comma separated list of event names. Example: >
2940 :set ei=WinEnter,WinLeave
2941<
2942 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2943'expandtab' 'et' boolean (default off)
2944 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002945 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002946 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002947 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2948 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002949 This option is reset when the 'paste' option is set and restored when
2950 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 NOTE: This option is reset when 'compatible' is set.
2952
2953 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2954'exrc' 'ex' boolean (default off)
2955 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002956 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002957 directory.
2958
2959 Setting this option is a potential security leak. E.g., consider
2960 unpacking a package or fetching files from github, a .vimrc in there
2961 might be a trojan horse. BETTER NOT SET THIS OPTION!
2962 Instead, define an autocommand in your .vimrc to set options for a
2963 matching directory.
2964
2965 If you do switch this option on you should also consider setting the
2966 'secure' option (see |initialization|).
2967 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002968 This option cannot be set from a |modeline| or in the |sandbox|, for
2969 security reasons.
2970
2971 *'fileencoding'* *'fenc'* *E213*
2972'fileencoding' 'fenc' string (default: "")
2973 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002974 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002975
Bram Moolenaar071d4272004-06-13 20:20:40 +00002976 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002977 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 When 'fileencoding' is empty, the same value as 'encoding' will be
2979 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002980 No error will be given when the value is set, only when it is used,
2981 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002982 Conversion will also be done when 'encoding' and 'fileencoding' are
2983 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2984 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002985 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002986 'encoding' is "utf-8" or another Unicode encoding, conversion
2987 is most likely done in a way that the reverse conversion
2988 results in the same text. When 'encoding' is not "utf-8" some
2989 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002990
Bram Moolenaar071d4272004-06-13 20:20:40 +00002991 See 'encoding' for the possible values. Additionally, values may be
2992 specified that can be handled by the converter, see
2993 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 When reading a file 'fileencoding' will be set from 'fileencodings'.
2996 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00002997 'fileencoding', use the |++enc| argument. One exception: when
2998 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00002999 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003000
Bram Moolenaar071d4272004-06-13 20:20:40 +00003001 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3002 When the option is set, the value is converted to lowercase. Thus
3003 you can set it with uppercase values too. '_' characters are
3004 replaced with '-'. If a name is recognized from the list for
3005 'encoding', it is replaced by the standard name. For example
3006 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003007
Bram Moolenaar071d4272004-06-13 20:20:40 +00003008 When this option is set, after starting to edit a file, the 'modified'
3009 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003010
3011 Keep in mind that changing 'fenc' from a modeline happens
3012 AFTER the text has been read, thus it applies to when the file will be
3013 written. If you do set 'fenc' in a modeline, you might want to set
3014 'nomodified' to avoid not being able to ":q".
3015
Bram Moolenaar071d4272004-06-13 20:20:40 +00003016 This option can not be changed when 'modifiable' is off.
3017
3018 *'fe'*
3019 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003020 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003021 old short name was 'fe', which is no longer used.
3022
3023 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003024'fileencodings' 'fencs' string (default: "ucs-bom",
3025 "ucs-bom,utf-8,default,latin1" when
3026 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003028 This is a list of character encodings considered when starting to edit
3029 an existing file. When a file is read, Vim tries to use the first
3030 mentioned character encoding. If an error is detected, the next one
3031 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003032 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003033 an empty string, which means the value of 'encoding' is used.
3034 WARNING: Conversion can cause loss of information! When
3035 'encoding' is "utf-8" (or one of the other Unicode variants)
3036 conversion is most likely done in a way that the reverse
3037 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003038 "utf-8" some non-ASCII characters may be lost! You can use
3039 the |++bad| argument to specify what is done with characters
3040 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003041 For an empty file or a file with only ASCII characters most encodings
3042 will work and the first entry of 'fileencodings' will be used (except
3043 "ucs-bom", which requires the BOM to be present). If you prefer
3044 another encoding use an BufReadPost autocommand event to test if your
3045 preferred encoding is to be used. Example: >
3046 au BufReadPost * if search('\S', 'w') == 0 |
3047 \ set fenc=iso-2022-jp | endif
3048< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3049 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003050 When the |++enc| argument is used then the value of 'fileencodings' is
3051 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003052 Note that 'fileencodings' is not used for a new file, the global value
3053 of 'fileencoding' is used instead. You can set it with: >
3054 :setglobal fenc=iso-8859-2
3055< This means that a non-existing file may get a different encoding than
3056 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003057 The special value "ucs-bom" can be used to check for a Unicode BOM
3058 (Byte Order Mark) at the start of the file. It must not be preceded
3059 by "utf-8" or another Unicode encoding for this to work properly.
3060 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3061 because Vim cannot detect an error, thus the encoding is always
3062 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003063 The special value "default" can be used for the encoding from the
3064 environment. This is the default value for 'encoding'. It is useful
3065 when 'encoding' is set to "utf-8" and your environment uses a
3066 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003067 When 'encoding' is "utf-8" and a file contains an illegal byte
3068 sequence it won't be recognized as UTF-8. You can use the |8g8|
3069 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003070 WRONG VALUES: WHAT'S WRONG:
3071 latin1,utf-8 "latin1" will always be used
3072 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3073 file
3074 cp1250,latin1 "cp1250" will always be used
3075 If 'fileencodings' is empty, 'fileencoding' is not modified.
3076 See 'fileencoding' for the possible values.
3077 Setting this option does not have an effect until the next time a file
3078 is read.
3079
3080 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003081'fileformat' 'ff' string (MS-Windows default: "dos",
3082 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003083 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003084 This gives the <EOL> of the current buffer, which is used for
3085 reading/writing the buffer from/to a file:
3086 dos <CR> <NL>
3087 unix <NL>
3088 mac <CR>
3089 When "dos" is used, CTRL-Z at the end of a file is ignored.
3090 See |file-formats| and |file-read|.
3091 For the character encoding of the file see 'fileencoding'.
3092 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003093 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003094 This option is set automatically when starting to edit a file and
3095 'fileformats' is not empty and 'binary' is off.
3096 When this option is set, after starting to edit a file, the 'modified'
3097 option is set, because the file would be different when written.
3098 This option can not be changed when 'modifiable' is off.
3099 For backwards compatibility: When this option is set to "dos",
3100 'textmode' is set, otherwise 'textmode' is reset.
3101
3102 *'fileformats'* *'ffs'*
3103'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003104 Vim+Vi MS-Windows: "dos,unix",
3105 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003106 Vi Cygwin: "unix,dos",
3107 Vi others: "")
3108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003109 This gives the end-of-line (<EOL>) formats that will be tried when
3110 starting to edit a new buffer and when reading a file into an existing
3111 buffer:
3112 - When empty, the format defined with 'fileformat' will be used
3113 always. It is not set automatically.
3114 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003115 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003116 'fileformats' name will be used when a file is read into an existing
3117 buffer, no matter what 'fileformat' for that buffer is set to.
3118 - When more than one name is present, separated by commas, automatic
3119 <EOL> detection will be done when reading a file. When starting to
3120 edit a file, a check is done for the <EOL>:
3121 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3122 'fileformat' is set to "dos".
3123 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003124 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003125 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003126 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3127 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003128 This means that "mac" is only chosen when:
3129 "unix" is not present or no <NL> is found in the file, and
3130 "dos" is not present or no <CR><NL> is found in the file.
3131 Except: if "unix" was chosen, but there is a <CR> before
3132 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003133 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003134 4. If 'fileformat' is still not set, the first name from
3135 'fileformats' is used.
3136 When reading a file into an existing buffer, the same is done, but
3137 this happens like 'fileformat' has been set appropriately for that
3138 file only, the option is not changed.
3139 When 'binary' is set, the value of 'fileformats' is not used.
3140
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003141 When Vim starts up with an empty buffer the first item is used. You
3142 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003143
Bram Moolenaar071d4272004-06-13 20:20:40 +00003144 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3145 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3146 done:
3147 - When 'fileformats' is empty, there is no automatic detection. Dos
3148 format will be used.
3149 - When 'fileformats' is set to one or more names, automatic detection
3150 is done. This is based on the first <NL> in the file: If there is a
3151 <CR> in front of it, Dos format is used, otherwise Unix format is
3152 used.
3153 Also see |file-formats|.
3154 For backwards compatibility: When this option is set to an empty
3155 string or one format (no comma is included), 'textauto' is reset,
3156 otherwise 'textauto' is set.
3157 NOTE: This option is set to the Vi default value when 'compatible' is
3158 set and to the Vim default value when 'compatible' is reset.
3159
Bram Moolenaarbf884932013-04-05 22:26:15 +02003160 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3161'fileignorecase' 'fic' boolean (default on for systems where case in file
3162 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003163 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003164 When set case is ignored when using file names and directories.
3165 See 'wildignorecase' for only ignoring case when doing completion.
3166
Bram Moolenaar071d4272004-06-13 20:20:40 +00003167 *'filetype'* *'ft'*
3168'filetype' 'ft' string (default: "")
3169 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003170 When this option is set, the FileType autocommand event is triggered.
3171 All autocommands that match with the value of this option will be
3172 executed. Thus the value of 'filetype' is used in place of the file
3173 name.
3174 Otherwise this option does not always reflect the current file type.
3175 This option is normally set when the file type is detected. To enable
3176 this use the ":filetype on" command. |:filetype|
3177 Setting this option to a different value is most useful in a modeline,
3178 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003179 Example, for in an IDL file:
3180 /* vim: set filetype=idl : */ ~
3181 |FileType| |filetypes|
3182 When a dot appears in the value then this separates two filetype
3183 names. Example:
3184 /* vim: set filetype=c.doxygen : */ ~
3185 This will use the "c" filetype first, then the "doxygen" filetype.
3186 This works both for filetype plugins and for syntax files. More than
3187 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003188 This option is not copied to another buffer, independent of the 's' or
3189 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003190 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003191
3192 *'fillchars'* *'fcs'*
3193'fillchars' 'fcs' string (default "vert:|,fold:-")
3194 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003195 {not available when compiled without the |+folding|
3196 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003197 Characters to fill the statuslines and vertical separators.
3198 It is a comma separated list of items:
3199
3200 item default Used for ~
3201 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003202 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003203 vert:c '|' vertical separators |:vsplit|
3204 fold:c '-' filling 'foldtext'
3205 diff:c '-' deleted lines of the 'diff' option
3206
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003207 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003208 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003209 otherwise.
3210
3211 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003212 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213< This is similar to the default, except that these characters will also
3214 be used when there is highlighting.
3215
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003216 for "stl" and "stlnc" only single-byte values are supported.
3217
Bram Moolenaar071d4272004-06-13 20:20:40 +00003218 The highlighting used for these items:
3219 item highlight group ~
3220 stl:c StatusLine |hl-StatusLine|
3221 stlnc:c StatusLineNC |hl-StatusLineNC|
3222 vert:c VertSplit |hl-VertSplit|
3223 fold:c Folded |hl-Folded|
3224 diff:c DiffDelete |hl-DiffDelete|
3225
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003226 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3227'fixendofline' 'fixeol' boolean (default on)
3228 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003229 When writing a file and this option is on, <EOL> at the end of file
3230 will be restored if missing. Turn this option off if you want to
3231 preserve the situation from the original file.
3232 When the 'binary' option is set the value of this option doesn't
3233 matter.
3234 See the 'endofline' option.
3235
Bram Moolenaar071d4272004-06-13 20:20:40 +00003236 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3237'fkmap' 'fk' boolean (default off) *E198*
3238 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003239 {only available when compiled with the |+rightleft|
3240 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003241 This option was for using Farsi, which has been removed. See
3242 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243
3244 *'foldclose'* *'fcl'*
3245'foldclose' 'fcl' string (default "")
3246 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247 {not available when compiled without the |+folding|
3248 feature}
3249 When set to "all", a fold is closed when the cursor isn't in it and
3250 its level is higher than 'foldlevel'. Useful if you want folds to
3251 automatically close when moving out of them.
3252
3253 *'foldcolumn'* *'fdc'*
3254'foldcolumn' 'fdc' number (default 0)
3255 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003256 {not available when compiled without the |+folding|
3257 feature}
3258 When non-zero, a column with the specified width is shown at the side
3259 of the window which indicates open and closed folds. The maximum
3260 value is 12.
3261 See |folding|.
3262
3263 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3264'foldenable' 'fen' boolean (default on)
3265 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003266 {not available when compiled without the |+folding|
3267 feature}
3268 When off, all folds are open. This option can be used to quickly
3269 switch between showing all text unfolded and viewing the text with
3270 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003271 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003272 'foldenable' is off.
3273 This option is set by commands that create a new fold or close a fold.
3274 See |folding|.
3275
3276 *'foldexpr'* *'fde'*
3277'foldexpr' 'fde' string (default: "0")
3278 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003279 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003280 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003281 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003282 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003283
Bram Moolenaar30b65812012-07-12 22:01:11 +02003284 The expression will be evaluated in the |sandbox| if set from a
3285 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003286 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003287 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003288
3289 It is not allowed to change text or jump to another window while
3290 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003291
3292 *'foldignore'* *'fdi'*
3293'foldignore' 'fdi' string (default: "#")
3294 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295 {not available when compiled without the |+folding|
3296 feature}
3297 Used only when 'foldmethod' is "indent". Lines starting with
3298 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003299 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003300 The default "#" works well for C programs. See |fold-indent|.
3301
3302 *'foldlevel'* *'fdl'*
3303'foldlevel' 'fdl' number (default: 0)
3304 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003305 {not available when compiled without the |+folding|
3306 feature}
3307 Sets the fold level: Folds with a higher level will be closed.
3308 Setting this option to zero will close all folds. Higher numbers will
3309 close fewer folds.
3310 This option is set by commands like |zm|, |zM| and |zR|.
3311 See |fold-foldlevel|.
3312
3313 *'foldlevelstart'* *'fdls'*
3314'foldlevelstart' 'fdls' number (default: -1)
3315 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003316 {not available when compiled without the |+folding|
3317 feature}
3318 Sets 'foldlevel' when starting to edit another buffer in a window.
3319 Useful to always start editing with all folds closed (value zero),
3320 some folds closed (one) or no folds closed (99).
3321 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003322 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003323 ignores this option and closes all folds.
3324 It is also done before BufReadPre autocommands, to allow an autocmd to
3325 overrule the 'foldlevel' value for specific files.
3326 When the value is negative, it is not used.
3327
3328 *'foldmarker'* *'fmr'* *E536*
3329'foldmarker' 'fmr' string (default: "{{{,}}}")
3330 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003331 {not available when compiled without the |+folding|
3332 feature}
3333 The start and end marker used when 'foldmethod' is "marker". There
3334 must be one comma, which separates the start and end marker. The
3335 marker is a literal string (a regular expression would be too slow).
3336 See |fold-marker|.
3337
3338 *'foldmethod'* *'fdm'*
3339'foldmethod' 'fdm' string (default: "manual")
3340 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003341 {not available when compiled without the |+folding|
3342 feature}
3343 The kind of folding used for the current window. Possible values:
3344 |fold-manual| manual Folds are created manually.
3345 |fold-indent| indent Lines with equal indent form a fold.
3346 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3347 |fold-marker| marker Markers are used to specify folds.
3348 |fold-syntax| syntax Syntax highlighting items specify folds.
3349 |fold-diff| diff Fold text that is not changed.
3350
3351 *'foldminlines'* *'fml'*
3352'foldminlines' 'fml' number (default: 1)
3353 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003354 {not available when compiled without the |+folding|
3355 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003356 Sets the number of screen lines above which a fold can be displayed
3357 closed. Also for manually closed folds. With the default value of
3358 one a fold can only be closed if it takes up two or more screen lines.
3359 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003360 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003361 "zc" to close a fold, which is displayed open because it's smaller
3362 than 'foldminlines', a following "zc" may close a containing fold.
3363
3364 *'foldnestmax'* *'fdn'*
3365'foldnestmax' 'fdn' number (default: 20)
3366 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003367 {not available when compiled without the |+folding|
3368 feature}
3369 Sets the maximum nesting of folds for the "indent" and "syntax"
3370 methods. This avoids that too many folds will be created. Using more
3371 than 20 doesn't work, because the internal limit is 20.
3372
3373 *'foldopen'* *'fdo'*
3374'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3375 search,tag,undo")
3376 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003377 {not available when compiled without the |+folding|
3378 feature}
3379 Specifies for which type of commands folds will be opened, if the
3380 command moves the cursor into a closed fold. It is a comma separated
3381 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003382 NOTE: When the command is part of a mapping this option is not used.
3383 Add the |zv| command to the mapping to get the same effect.
3384 (rationale: the mapping may want to control opening folds itself)
3385
Bram Moolenaar071d4272004-06-13 20:20:40 +00003386 item commands ~
3387 all any
3388 block "(", "{", "[[", "[{", etc.
3389 hor horizontal movements: "l", "w", "fx", etc.
3390 insert any command in Insert mode
3391 jump far jumps: "G", "gg", etc.
3392 mark jumping to a mark: "'m", CTRL-O, etc.
3393 percent "%"
3394 quickfix ":cn", ":crew", ":make", etc.
3395 search search for a pattern: "/", "n", "*", "gd", etc.
3396 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003397 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003398 tag jumping to a tag: ":ta", CTRL-T, etc.
3399 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003400 When a movement command is used for an operator (e.g., "dl" or "y%")
3401 this option is not used. This means the operator will include the
3402 whole closed fold.
3403 Note that vertical movements are not here, because it would make it
3404 very difficult to move onto a closed fold.
3405 In insert mode the folds containing the cursor will always be open
3406 when text is inserted.
3407 To close folds you can re-apply 'foldlevel' with the |zx| command or
3408 set the 'foldclose' option to "all".
3409
3410 *'foldtext'* *'fdt'*
3411'foldtext' 'fdt' string (default: "foldtext()")
3412 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003413 {not available when compiled without the |+folding|
3414 feature}
3415 An expression which is used to specify the text displayed for a closed
3416 fold. See |fold-foldtext|.
3417
Bram Moolenaar30b65812012-07-12 22:01:11 +02003418 The expression will be evaluated in the |sandbox| if set from a
3419 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003420 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003421
3422 It is not allowed to change text or jump to another window while
3423 evaluating 'foldtext' |textlock|.
3424
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003425 *'formatexpr'* *'fex'*
3426'formatexpr' 'fex' string (default "")
3427 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003428 {not available when compiled without the |+eval|
3429 feature}
3430 Expression which is evaluated to format a range of lines for the |gq|
3431 operator or automatic formatting (see 'formatoptions'). When this
3432 option is empty 'formatprg' is used.
3433
3434 The |v:lnum| variable holds the first line to be formatted.
3435 The |v:count| variable holds the number of lines to be formatted.
3436 The |v:char| variable holds the character that is going to be
3437 inserted if the expression is being evaluated due to
3438 automatic formatting. This can be empty. Don't insert
3439 it yet!
3440
3441 Example: >
3442 :set formatexpr=mylang#Format()
3443< This will invoke the mylang#Format() function in the
3444 autoload/mylang.vim file in 'runtimepath'. |autoload|
3445
3446 The expression is also evaluated when 'textwidth' is set and adding
3447 text beyond that limit. This happens under the same conditions as
3448 when internal formatting is used. Make sure the cursor is kept in the
3449 same spot relative to the text then! The |mode()| function will
3450 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003451
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003452 When the expression evaluates to non-zero Vim will fall back to using
3453 the internal format mechanism.
3454
3455 The expression will be evaluated in the |sandbox| when set from a
3456 modeline, see |sandbox-option|. That stops the option from working,
3457 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003458 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003459 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003460
Bram Moolenaar86b68352004-12-27 21:59:20 +00003461 *'formatlistpat'* *'flp'*
3462'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3463 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003464 A pattern that is used to recognize a list header. This is used for
3465 the "n" flag in 'formatoptions'.
3466 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003467 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003468 while still checking more characters. There must be a character
3469 following the pattern, when it matches the whole line it is handled
3470 like there is no match.
3471 The default recognizes a number, followed by an optional punctuation
3472 character and white space.
3473
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003474 *'formatoptions'* *'fo'*
3475'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3476 local to buffer
3477 This is a sequence of letters which describes how automatic
3478 formatting is to be done. See |fo-table|. When the 'paste' option is
3479 on, no formatting is done (like 'formatoptions' is empty). Commas can
3480 be inserted for readability.
3481 To avoid problems with flags that are added in the future, use the
3482 "+=" and "-=" feature of ":set" |add-option-flags|.
3483 NOTE: This option is set to the Vi default value when 'compatible' is
3484 set and to the Vim default value when 'compatible' is reset.
3485
Bram Moolenaar071d4272004-06-13 20:20:40 +00003486 *'formatprg'* *'fp'*
3487'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003488 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003489 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003490 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003491 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003492 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003493 If the 'formatexpr' option is not empty it will be used instead.
3494 Otherwise, if 'formatprg' option is an empty string, the internal
3495 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003496 Environment variables are expanded |:set_env|. See |option-backslash|
3497 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003498 This option cannot be set from a |modeline| or in the |sandbox|, for
3499 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003500
Bram Moolenaard94464e2015-11-02 15:28:18 +01003501 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003502'fsync' 'fs' boolean (default on)
3503 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003504 When on, the library function fsync() will be called after writing a
3505 file. This will flush a file to disk, ensuring that it is safely
3506 written even on filesystems which do metadata-only journaling. This
3507 will force the harddrive to spin up on Linux systems running in laptop
3508 mode, so it may be undesirable in some situations. Be warned that
3509 turning this off increases the chances of data loss after a crash. On
3510 systems without an fsync() implementation, this variable is always
3511 off.
3512 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003513 'fsync' also applies to |writefile()|, unless a flag is used to
3514 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003515 This option cannot be set from a |modeline| or in the |sandbox|, for
3516 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003517
Bram Moolenaar071d4272004-06-13 20:20:40 +00003518 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3519'gdefault' 'gd' boolean (default off)
3520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003521 When on, the ":substitute" flag 'g' is default on. This means that
3522 all matches in a line are substituted instead of one. When a 'g' flag
3523 is given to a ":substitute" command, this will toggle the substitution
3524 of all or one match. See |complex-change|.
3525
3526 command 'gdefault' on 'gdefault' off ~
3527 :s/// subst. all subst. one
3528 :s///g subst. one subst. all
3529 :s///gg subst. all subst. one
3530
3531 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003532 DEPRECATED: Setting this option may break plugins that are not aware
3533 of this option. Also, many users get confused that adding the /g flag
3534 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003535
3536 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003537'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003538 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539 Format to recognize for the ":grep" command output.
3540 This is a scanf-like string that uses the same format as the
3541 'errorformat' option: see |errorformat|.
3542
3543 *'grepprg'* *'gp'*
3544'grepprg' 'gp' string (default "grep -n ",
3545 Unix: "grep -n $* /dev/null",
3546 Win32: "findstr /n" or "grep -n",
3547 VMS: "SEARCH/NUMBERS ")
3548 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003549 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003550 and '#' characters, which are expanded like when used in a command-
3551 line. The placeholder "$*" is allowed to specify where the arguments
3552 will be included. Environment variables are expanded |:set_env|. See
3553 |option-backslash| about including spaces and backslashes.
3554 When your "grep" accepts the "-H" argument, use this to make ":grep"
3555 also work well with a single file: >
3556 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003557< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003558 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3559 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003560 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003561 apply equally to 'grepprg'.
3562 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3563 otherwise it's "grep -n".
3564 This option cannot be set from a |modeline| or in the |sandbox|, for
3565 security reasons.
3566
3567 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3568'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3569 ve:ver35-Cursor,
3570 o:hor50-Cursor,
3571 i-ci:ver25-Cursor/lCursor,
3572 r-cr:hor20-Cursor/lCursor,
3573 sm:block-Cursor
3574 -blinkwait175-blinkoff150-blinkon175",
3575 for MS-DOS and Win32 console:
3576 "n-v-c:block,o:hor50,i-ci:hor15,
3577 r-cr:hor30,sm:block")
3578 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003579 {only available when compiled with GUI enabled, and
3580 for MS-DOS and Win32 console}
3581 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003582 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 the height of the cursor can be changed. This can be done by
3584 specifying a block cursor, or a percentage for a vertical or
3585 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003586 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3587 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003588
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003589 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003590 mode-list and an argument-list:
3591 mode-list:argument-list,mode-list:argument-list,..
3592 The mode-list is a dash separated list of these modes:
3593 n Normal mode
3594 v Visual mode
3595 ve Visual mode with 'selection' "exclusive" (same as 'v',
3596 if not specified)
3597 o Operator-pending mode
3598 i Insert mode
3599 r Replace mode
3600 c Command-line Normal (append) mode
3601 ci Command-line Insert mode
3602 cr Command-line Replace mode
3603 sm showmatch in Insert mode
3604 a all modes
3605 The argument-list is a dash separated list of these arguments:
3606 hor{N} horizontal bar, {N} percent of the character height
3607 ver{N} vertical bar, {N} percent of the character width
3608 block block cursor, fills the whole character
3609 [only one of the above three should be present]
3610 blinkwait{N} *cursor-blinking*
3611 blinkon{N}
3612 blinkoff{N}
3613 blink times for cursor: blinkwait is the delay before
3614 the cursor starts blinking, blinkon is the time that
3615 the cursor is shown and blinkoff is the time that the
3616 cursor is not shown. The times are in msec. When one
3617 of the numbers is zero, there is no blinking. The
3618 default is: "blinkwait700-blinkon400-blinkoff250".
3619 These numbers are used for a missing entry. This
3620 means that blinking is enabled by default. To switch
3621 blinking off you can use "blinkon0". The cursor only
3622 blinks when Vim is waiting for input, not while
3623 executing a command.
3624 To make the cursor blink in an xterm, see
3625 |xterm-blink|.
3626 {group-name}
3627 a highlight group name, that sets the color and font
3628 for the cursor
3629 {group-name}/{group-name}
3630 Two highlight group names, the first is used when
3631 no language mappings are used, the other when they
3632 are. |language-mapping|
3633
3634 Examples of parts:
3635 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3636 block cursor with colors from the "nCursor"
3637 highlight group
3638 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3639 In Insert and Command-line Insert mode, use a
3640 30% vertical bar cursor with colors from the
3641 "iCursor" highlight group. Blink a bit
3642 faster.
3643
3644 The 'a' mode is different. It will set the given argument-list for
3645 all modes. It does not reset anything to defaults. This can be used
3646 to do a common setting for all modes. For example, to switch off
3647 blinking: "a:blinkon0"
3648
3649 Examples of cursor highlighting: >
3650 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3651 :highlight Cursor gui=NONE guifg=bg guibg=fg
3652<
3653 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003654 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003655'guifont' 'gfn' string (default "")
3656 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003657 {only available when compiled with GUI enabled}
3658 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003659 In its simplest form the value is just one font name.
3660 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661
3662 *'guifontset'* *'gfs'*
3663 *E250* *E252* *E234* *E597* *E598*
3664'guifontset' 'gfs' string (default "")
3665 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003666 {only available when compiled with GUI enabled and
3667 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003668 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003669 When not empty, specifies two (or more) fonts to be used. The first
3670 one for normal English, the second one for your special language. See
3671 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003672
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3674'guifontwide' 'gfw' string (default "")
3675 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003676 {only available when compiled with GUI enabled}
3677 When not empty, specifies a comma-separated list of fonts to be used
3678 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003679 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003680
Bram Moolenaar071d4272004-06-13 20:20:40 +00003681 *'guiheadroom'* *'ghr'*
3682'guiheadroom' 'ghr' number (default 50)
3683 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003684 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 The number of pixels subtracted from the screen height when fitting
3686 the GUI window on the screen. Set this before the GUI is started,
3687 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003688 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 lines will be left for window decorations and other items on the
3690 screen. Set it to a negative value to allow windows taller than the
3691 screen.
3692
3693 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003694'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3695 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003696 "aegimrLtT" (GTK, Motif and Athena),
3697 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003698 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003699 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003700 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003701 sequence of letters which describes what components and options of the
3702 GUI should be used.
3703 To avoid problems with flags that are added in the future, use the
3704 "+=" and "-=" feature of ":set" |add-option-flags|.
3705
Bram Moolenaar13568252018-03-16 20:46:58 +01003706 Valid characters are as follows:
3707 *'go-!'*
3708 '!' External commands are executed in a terminal window. Without
3709 this flag the MS-Windows GUI will open a console window to
3710 execute the command. The Unix GUI will simulate a dumb
3711 terminal to list the command output.
3712 The terminal window will be positioned at the bottom, and grow
3713 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003714 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003715 'a' Autoselect: If present, then whenever VISUAL mode is started,
3716 or the Visual area extended, Vim tries to become the owner of
3717 the windowing system's global selection. This means that the
3718 Visually highlighted text is available for pasting into other
3719 applications as well as into Vim itself. When the Visual mode
3720 ends, possibly due to an operation on the text, or when an
3721 application wants to paste the selection, the highlighted text
3722 is automatically yanked into the "* selection register.
3723 Thus the selection is still available for pasting into other
3724 applications after the VISUAL mode has ended.
3725 If not present, then Vim won't become the owner of the
3726 windowing system's global selection unless explicitly told to
3727 by a yank or delete operation for the "* register.
3728 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003729 *'go-P'*
3730 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003731 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003732 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003733 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003734 applies to the modeless selection.
3735
3736 'guioptions' autoselect Visual autoselect modeless ~
3737 "" - -
3738 "a" yes yes
3739 "A" - yes
3740 "aA" yes yes
3741
Bram Moolenaar02467872007-05-06 13:22:01 +00003742 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003743 'c' Use console dialogs instead of popup dialogs for simple
3744 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003745 *'go-d'*
3746 'd' Use dark theme variant if available. Currently only works for
3747 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003748 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003749 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003750 'guitablabel' can be used to change the text in the labels.
3751 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003752 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003753 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003754 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003755 'f' Foreground: Don't use fork() to detach the GUI from the shell
3756 where it was started. Use this for programs that wait for the
3757 editor to finish (e.g., an e-mail program). Alternatively you
3758 can use "gvim -f" or ":gui -f" to start the GUI in the
3759 foreground. |gui-fork|
3760 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003761 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003762 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003763 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3764 corner of the window. It's black&white on non-GTK, because of
3765 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003766 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003768 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003769 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003770 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003771 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003772 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003773 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003774 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003775 'g' Grey menu items: Make menu items that are not active grey. If
3776 'g' is not included inactive menu items are not shown at all.
3777 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003778 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 't' Include tearoff menu items. Currently only works for Win32,
3780 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003781 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003782 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003783 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003784 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003785 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003786 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003787 'R' Right-hand scrollbar is present when there is a vertically
3788 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003789 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003790 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003791 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003792 'L' Left-hand scrollbar is present when there is a vertically
3793 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003794 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003795 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3796 the longest visible line, or on the cursor line if the 'h'
3797 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003798 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'h' Limit horizontal scrollbar size to the length of the cursor
3800 line. Reduces computations. |gui-horiz-scroll|
3801
3802 And yes, you may even have scrollbars on the left AND the right if
3803 you really want to :-). See |gui-scrollbars| for more information.
3804
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003805 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003806 'v' Use a vertical button layout for dialogs. When not included,
3807 a horizontal layout is preferred, but when it doesn't fit a
3808 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003809 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 'p' Use Pointer callbacks for X11 GUI. This is required for some
3811 window managers. If the cursor is not blinking or hollow at
3812 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003813 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003815 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003816 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003817 *'go-k'*
3818 'k' Keep the GUI window size when adding/removing a scrollbar, or
3819 toolbar, tabline, etc. Instead, the behavior is similar to
3820 when the window is maximized and will adjust 'lines' and
3821 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003822 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003823 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003824
Bram Moolenaar071d4272004-06-13 20:20:40 +00003825 *'guipty'* *'noguipty'*
3826'guipty' boolean (default on)
3827 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003828 {only available when compiled with GUI enabled}
3829 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3830 I/O to/from shell commands. See |gui-pty|.
3831
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003832 *'guitablabel'* *'gtl'*
3833'guitablabel' 'gtl' string (default empty)
3834 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003835 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003836 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003837 pages line. When empty and when the result is empty Vim will use a
3838 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003839
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003840 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003841 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003842 The expression will be evaluated in the |sandbox| when set from a
3843 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003844 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003845
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003846 Only used when the GUI tab pages line is displayed. 'e' must be
3847 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3848 used.
3849
Bram Moolenaar57657d82006-04-21 22:12:41 +00003850 *'guitabtooltip'* *'gtt'*
3851'guitabtooltip' 'gtt' string (default empty)
3852 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003853 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003854 When nonempty describes the text to use in a tooltip for the GUI tab
3855 pages line. When empty Vim will use a default tooltip.
3856 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003857 You can include a line break. Simplest method is to use |:let|: >
3858 :let &guitabtooltip = "line one\nline two"
3859<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003860
Bram Moolenaar071d4272004-06-13 20:20:40 +00003861 *'helpfile'* *'hf'*
3862'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3863 (others) "$VIMRUNTIME/doc/help.txt")
3864 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 Name of the main help file. All distributed help files should be
3866 placed together in one directory. Additionally, all "doc" directories
3867 in 'runtimepath' will be used.
3868 Environment variables are expanded |:set_env|. For example:
3869 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003870 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003871 spaces and backslashes.
3872 This option cannot be set from a |modeline| or in the |sandbox|, for
3873 security reasons.
3874
3875 *'helpheight'* *'hh'*
3876'helpheight' 'hh' number (default 20)
3877 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003878 Minimal initial height of the help window when it is opened with the
3879 ":help" command. The initial height of the help window is half of the
3880 current window, or (when the 'ea' option is on) the same as other
3881 windows. When the height is less than 'helpheight', the height is
3882 set to 'helpheight'. Set to zero to disable.
3883
3884 *'helplang'* *'hlg'*
3885'helplang' 'hlg' string (default: messages language or empty)
3886 global
3887 {only available when compiled with the |+multi_lang|
3888 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003889 Comma separated list of languages. Vim will use the first language
3890 for which the desired help can be found. The English help will always
3891 be used as a last resort. You can add "en" to prefer English over
3892 another language, but that will only find tags that exist in that
3893 language and not in the English help.
3894 Example: >
3895 :set helplang=de,it
3896< This will first search German, then Italian and finally English help
3897 files.
3898 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3899 try to find the tag in the current language before using this option.
3900 See |help-translated|.
3901
3902 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3903'hidden' 'hid' boolean (default off)
3904 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003905 When off a buffer is unloaded when it is |abandon|ed. When on a
3906 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3907 displayed in another window, it does not become hidden, of course.
3908 The commands that move through the buffer list sometimes make a buffer
3909 hidden although the 'hidden' option is off: When the buffer is
3910 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003911 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003912 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003913 This option is set for one command with ":hide {command}" |:hide|.
3914 WARNING: It's easy to forget that you have changes in hidden buffers.
3915 Think twice when using ":q!" or ":qa!".
3916
3917 *'highlight'* *'hl'*
3918'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003919 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3920 d:Directory,e:ErrorMsg,i:IncSearch,
3921 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3922 N:CursorLineNr,r:Question,s:StatusLine,
3923 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003924 v:Visual,V:VisualNOS,w:WarningMsg,
3925 W:WildMenu,f:Folded,F:FoldColumn,
3926 A:DiffAdd,C:DiffChange,D:DiffDelete,
3927 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003928 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003929 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003930 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3931 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003932 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003933 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003934 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003935 This option can be used to set highlighting mode for various
3936 occasions. It is a comma separated list of character pairs. The
3937 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003938 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003940 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3941 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003942 characters from 'showbreak'
3943 |hl-Directory| d directories in CTRL-D listing and other special
3944 things in listings
3945 |hl-ErrorMsg| e error messages
3946 h (obsolete, ignored)
3947 |hl-IncSearch| i 'incsearch' highlighting
3948 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3949 |hl-MoreMsg| m |more-prompt|
3950 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003951 |hl-LineNr| n line number for ":number" and ":#" commands, and
3952 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003953 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3954 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003955 |hl-Question| r |hit-enter| prompt and yes/no questions
3956 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003957 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003958 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3959 |hl-VertSplit| c column used to separate vertically split windows
3960 |hl-Visual| v Visual mode
3961 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3962 Selection" Only X11 Gui's |gui-x11| and
3963 |xterm-clipboard|.
3964 |hl-WarningMsg| w warning messages
3965 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3966 |hl-Folded| f line used for closed folds
3967 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003968 |hl-DiffAdd| A added line in diff mode
3969 |hl-DiffChange| C changed line in diff mode
3970 |hl-DiffDelete| D deleted line in diff mode
3971 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003972 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003973 |hl-Conceal| - the placeholders used for concealed characters
3974 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003975 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003976 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003977 |hl-SpellRare| R rare word |spell|
3978 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003979 |hl-Pmenu| + popup menu normal line
3980 |hl-PmenuSel| = popup menu selected line
3981 |hl-PmenuSbar| x popup menu scrollbar
3982 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003983
3984 The display modes are:
3985 r reverse (termcap entry "mr" and "me")
3986 i italic (termcap entry "ZH" and "ZR")
3987 b bold (termcap entry "md" and "me")
3988 s standout (termcap entry "so" and "se")
3989 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003990 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003991 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003992 n no highlighting
3993 - no highlighting
3994 : use a highlight group
3995 The default is used for occasions that are not included.
3996 If you want to change what the display modes do, see |dos-colors|
3997 for an example.
3998 When using the ':' display mode, this must be followed by the name of
3999 a highlight group. A highlight group can be used to define any type
4000 of highlighting, including using color. See |:highlight| on how to
4001 define one. The default uses a different group for each occasion.
4002 See |highlight-default| for the default highlight groups.
4003
Bram Moolenaar071d4272004-06-13 20:20:40 +00004004 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004005'history' 'hi' number (Vim default: 50, Vi default: 0,
4006 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004007 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004009 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004010 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004011 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 NOTE: This option is set to the Vi default value when 'compatible' is
4013 set and to the Vim default value when 'compatible' is reset.
4014
4015 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4016'hkmap' 'hk' boolean (default off)
4017 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004018 {only available when compiled with the |+rightleft|
4019 feature}
4020 When on, the keyboard is mapped for the Hebrew character set.
4021 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4022 toggle this option. See |rileft.txt|.
4023 NOTE: This option is reset when 'compatible' is set.
4024
4025 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4026'hkmapp' 'hkp' boolean (default off)
4027 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004028 {only available when compiled with the |+rightleft|
4029 feature}
4030 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4031 This is useful if you have a non-Hebrew keyboard.
4032 See |rileft.txt|.
4033 NOTE: This option is reset when 'compatible' is set.
4034
Bram Moolenaar036986f2017-03-16 17:41:02 +01004035 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4036'hlsearch' 'hls' boolean (default off)
4037 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004038 {not available when compiled without the
4039 |+extra_search| feature}
4040 When there is a previous search pattern, highlight all its matches.
4041 The type of highlighting used can be set with the 'l' occasion in the
4042 'highlight' option. This uses the "Search" highlight group by
4043 default. Note that only the matching text is highlighted, any offsets
4044 are not applied.
4045 See also: 'incsearch' and |:match|.
4046 When you get bored looking at the highlighted matches, you can turn it
4047 off with |:nohlsearch|. This does not change the option value, as
4048 soon as you use a search command, the highlighting comes back.
4049 'redrawtime' specifies the maximum time spent on finding matches.
4050 When the search pattern can match an end-of-line, Vim will try to
4051 highlight all of the matched text. However, this depends on where the
4052 search starts. This will be the first line in the window or the first
4053 line below a closed fold. A match in a previous line which is not
4054 drawn may not continue in a newly drawn line.
4055 You can specify whether the highlight status is restored on startup
4056 with the 'h' flag in 'viminfo' |viminfo-h|.
4057 NOTE: This option is reset when 'compatible' is set.
4058
Bram Moolenaar071d4272004-06-13 20:20:40 +00004059 *'icon'* *'noicon'*
4060'icon' boolean (default off, on when title can be restored)
4061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004062 {not available when compiled without the |+title|
4063 feature}
4064 When on, the icon text of the window will be set to the value of
4065 'iconstring' (if it is not empty), or to the name of the file
4066 currently being edited. Only the last part of the name is used.
4067 Overridden by the 'iconstring' option.
4068 Only works if the terminal supports setting window icons (currently
4069 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4070 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4071 builtin termcap).
4072 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004073 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004074 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004075 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004076
4077 *'iconstring'*
4078'iconstring' string (default "")
4079 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080 {not available when compiled without the |+title|
4081 feature}
4082 When this option is not empty, it will be used for the icon text of
4083 the window. This happens only when the 'icon' option is on.
4084 Only works if the terminal supports setting window icon text
4085 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4086 Does not work for MS Windows.
4087 When Vim was compiled with HAVE_X11 defined, the original icon will be
4088 restored if possible |X11|.
4089 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004090 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004091 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004092 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004093 {not available when compiled without the |+statusline| feature}
4094
4095 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4096'ignorecase' 'ic' boolean (default off)
4097 global
4098 Ignore case in search patterns. Also used when searching in the tags
4099 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004100 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004101 Can be overruled by using "\c" or "\C" in the pattern, see
4102 |/ignorecase|.
4103
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004104 *'imactivatefunc'* *'imaf'*
4105'imactivatefunc' 'imaf' string (default "")
4106 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004107 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004108 activate or deactivate the Input Method.
4109 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004110 The expression will be evaluated in the |sandbox| when set from a
4111 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004112
4113 Example: >
4114 function ImActivateFunc(active)
4115 if a:active
4116 ... do something
4117 else
4118 ... do something
4119 endif
4120 " return value is not used
4121 endfunction
4122 set imactivatefunc=ImActivateFunc
4123<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004124 *'imactivatekey'* *'imak'*
4125'imactivatekey' 'imak' string (default "")
4126 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004127 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004128 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004129 Specifies the key that your Input Method in X-Windows uses for
4130 activation. When this is specified correctly, vim can fully control
4131 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4132 You can't use this option to change the activation key, the option
4133 tells Vim what the key is.
4134 Format:
4135 [MODIFIER_FLAG-]KEY_STRING
4136
4137 These characters can be used for MODIFIER_FLAG (case is ignored):
4138 S Shift key
4139 L Lock key
4140 C Control key
4141 1 Mod1 key
4142 2 Mod2 key
4143 3 Mod3 key
4144 4 Mod4 key
4145 5 Mod5 key
4146 Combinations are allowed, for example "S-C-space" or "SC-space" are
4147 both shift+ctrl+space.
4148 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4149
4150 Example: >
4151 :set imactivatekey=S-space
4152< "S-space" means shift+space. This is the activation key for kinput2 +
4153 canna (Japanese), and ami (Korean).
4154
4155 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4156'imcmdline' 'imc' boolean (default off)
4157 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004158 When set the Input Method is always on when starting to edit a command
4159 line, unless entering a search pattern (see 'imsearch' for that).
4160 Setting this option is useful when your input method allows entering
4161 English characters directly, e.g., when it's used to type accented
4162 characters with dead keys.
4163
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004164 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004165'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4166 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004167 When set the Input Method is never used. This is useful to disable
4168 the IM when it doesn't work properly.
4169 Currently this option is on by default for SGI/IRIX machines. This
4170 may change in later releases.
4171
4172 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004173'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004174 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004175 Specifies whether :lmap or an Input Method (IM) is to be used in
4176 Insert mode. Valid values:
4177 0 :lmap is off and IM is off
4178 1 :lmap is ON and IM is off
4179 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004180 To always reset the option to zero when leaving Insert mode with <Esc>
4181 this can be used: >
4182 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4183< This makes :lmap and IM turn off automatically when leaving Insert
4184 mode.
4185 Note that this option changes when using CTRL-^ in Insert mode
4186 |i_CTRL-^|.
4187 The value is set to 1 when setting 'keymap' to a valid keymap name.
4188 It is also used for the argument of commands like "r" and "f".
4189 The value 0 may not work correctly with Athena and Motif with some XIM
4190 methods. Use 'imdisable' to disable XIM then.
4191
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004192 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004193 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004194 |+multi_byte_ime| or |global-ime|.
4195
Bram Moolenaar071d4272004-06-13 20:20:40 +00004196 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004197'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004198 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004199 Specifies whether :lmap or an Input Method (IM) is to be used when
4200 entering a search pattern. Valid values:
4201 -1 the value of 'iminsert' is used, makes it look like
4202 'iminsert' is also used when typing a search pattern
4203 0 :lmap is off and IM is off
4204 1 :lmap is ON and IM is off
4205 2 :lmap is off and IM is ON
4206 Note that this option changes when using CTRL-^ in Command-line mode
4207 |c_CTRL-^|.
4208 The value is set to 1 when it is not -1 and setting the 'keymap'
4209 option to a valid keymap name.
4210 The value 0 may not work correctly with Athena and Motif with some XIM
4211 methods. Use 'imdisable' to disable XIM then.
4212
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004213 *'imstatusfunc'* *'imsf'*
4214'imstatusfunc' 'imsf' string (default "")
4215 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004216 This option specifies a function that is called to obtain the status
4217 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004218 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004219
4220 Example: >
4221 function ImStatusFunc()
4222 let is_active = ...do something
4223 return is_active ? 1 : 0
4224 endfunction
4225 set imstatusfunc=ImStatusFunc
4226<
4227 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004228 The expression will be evaluated in the |sandbox| when set from a
4229 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004230
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004231 *'imstyle'* *'imst'*
4232'imstyle' 'imst' number (default 1)
4233 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004234 {only available when compiled with |+xim| and
4235 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004236 This option specifies the input style of Input Method:
4237 0 use on-the-spot style
4238 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004239 See: |xim-input-style|
4240
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004241 For a long time on-the-spot style had been used in the GTK version of
4242 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004243 |single-repeat|, etc. Therefore over-the-spot style becomes the
4244 default now. This should work fine for most people, however if you
4245 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004246 The expression will be evaluated in the |sandbox| when set from a
4247 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004248
Bram Moolenaar071d4272004-06-13 20:20:40 +00004249 *'include'* *'inc'*
4250'include' 'inc' string (default "^\s*#\s*include")
4251 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004252 {not available when compiled without the
4253 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004254 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004255 pattern, just like for the "/" command (See |pattern|). The default
4256 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004257 "]I", "[d", etc.
4258 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004259 comes after the matched pattern. But if "\zs" appears in the pattern
4260 then the text matched from "\zs" to the end, or until "\ze" if it
4261 appears, is used as the file name. Use this to include characters
4262 that are not in 'isfname', such as a space. You can then use
4263 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004264 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004265
4266 *'includeexpr'* *'inex'*
4267'includeexpr' 'inex' string (default "")
4268 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004270 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004271 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004272 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 :set includeexpr=substitute(v:fname,'\\.','/','g')
4274< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004275
Bram Moolenaar071d4272004-06-13 20:20:40 +00004276 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004277 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004278 Also used for |<cfile>|.
4279
Bram Moolenaar30b65812012-07-12 22:01:11 +02004280 The expression will be evaluated in the |sandbox| when set from a
4281 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004282 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004283
4284 It is not allowed to change text or jump to another window while
4285 evaluating 'includeexpr' |textlock|.
4286
Bram Moolenaar071d4272004-06-13 20:20:40 +00004287 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004288'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4289 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004290 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004292 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004293 While typing a search command, show where the pattern, as it was typed
4294 so far, matches. The matched string is highlighted. If the pattern
4295 is invalid or not found, nothing is shown. The screen will be updated
4296 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004297 Also applies to the pattern in commands: >
4298 :global
4299 :lvimgrep
4300 :lvimgrepadd
4301 :smagic
4302 :snomagic
4303 :sort
4304 :substitute
4305 :vglobal
4306 :vimgrep
4307 :vimgrepadd
4308< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004309 original position when no match is found and when pressing <Esc>. You
4310 still need to finish the search command with <Enter> to move the
4311 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004312 You can use the CTRL-G and CTRL-T keys to move to the next and
4313 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004314 When compiled with the |+reltime| feature Vim only searches for about
4315 half a second. With a complicated pattern and/or a lot of text the
4316 match may not be found. This is to avoid that Vim hangs while you
4317 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004318 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004319 When 'hlsearch' is on, all matched strings are highlighted too while
4320 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004321 If you don't want to turn 'hlsearch' on, but want to highlight all
4322 matches while searching, you can turn on and off 'hlsearch' with
4323 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004324 augroup vimrc-incsearch-highlight
4325 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004326 autocmd CmdlineEnter /,\? :set hlsearch
4327 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004328 augroup END
4329<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004330 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004331 to the command line. If 'ignorecase' and 'smartcase' are set and the
4332 command line has no uppercase characters, the added character is
4333 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004334 CTRL-R CTRL-W can be used to add the word at the end of the current
4335 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004336 NOTE: This option is reset when 'compatible' is set.
4337
4338 *'indentexpr'* *'inde'*
4339'indentexpr' 'inde' string (default "")
4340 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004341 {not available when compiled without the |+cindent|
4342 or |+eval| features}
4343 Expression which is evaluated to obtain the proper indent for a line.
4344 It is used when a new line is created, for the |=| operator and
4345 in Insert mode as specified with the 'indentkeys' option.
4346 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004347 'smartindent' indenting. When 'lisp' is set, this option is
4348 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004349 When 'paste' is set this option is not used for indenting.
4350 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004351 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004352 when the expression is evaluated (but it may be moved around).
4353 The expression must return the number of spaces worth of indent. It
4354 can return "-1" to keep the current indent (this means 'autoindent' is
4355 used for the indent).
4356 Functions useful for computing the indent are |indent()|, |cindent()|
4357 and |lispindent()|.
4358 The evaluation of the expression must not have side effects! It must
4359 not change the text, jump to another window, etc. Afterwards the
4360 cursor position is always restored, thus the cursor may be moved.
4361 Normally this option would be set to call a function: >
4362 :set indentexpr=GetMyIndent()
4363< Error messages will be suppressed, unless the 'debug' option contains
4364 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004365 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004366 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004367
Bram Moolenaar30b65812012-07-12 22:01:11 +02004368 The expression will be evaluated in the |sandbox| when set from a
4369 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004370 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004371
4372 It is not allowed to change text or jump to another window while
4373 evaluating 'indentexpr' |textlock|.
4374
4375
Bram Moolenaar071d4272004-06-13 20:20:40 +00004376 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004377'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004378 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004379 {not available when compiled without the |+cindent|
4380 feature}
4381 A list of keys that, when typed in Insert mode, cause reindenting of
4382 the current line. Only happens if 'indentexpr' isn't empty.
4383 The format is identical to 'cinkeys', see |indentkeys-format|.
4384 See |C-indenting| and |indent-expression|.
4385
4386 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4387'infercase' 'inf' boolean (default off)
4388 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004389 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004390 'ignorecase' is also on, the case of the match is adjusted depending
4391 on the typed text. If the typed text contains a lowercase letter
4392 where the match has an upper case letter, the completed part is made
4393 lowercase. If the typed text has no lowercase letters and the match
4394 has a lowercase letter where the typed text has an uppercase letter,
4395 and there is a letter before it, the completed part is made uppercase.
4396 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004397
4398 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4399'insertmode' 'im' boolean (default off)
4400 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401 Makes Vim work in a way that Insert mode is the default mode. Useful
4402 if you want to use Vim as a modeless editor. Used for |evim|.
4403 These Insert mode commands will be useful:
4404 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004405 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004406 this is a mapping, it is executed as if 'insertmode' was off.
4407 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004408 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004409 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4410 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004411
4412 These items change when 'insertmode' is set:
4413 - when starting to edit of a file, Vim goes to Insert mode.
4414 - <Esc> in Insert mode is a no-op and beeps.
4415 - <Esc> in Normal mode makes Vim go to Insert mode.
4416 - CTRL-L in Insert mode is a command, it is not inserted.
4417 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4418 However, when <Esc> is used inside a mapping, it behaves like
4419 'insertmode' was not set. This was done to be able to use the same
4420 mappings with 'insertmode' set or not set.
4421 When executing commands with |:normal| 'insertmode' is not used.
4422
4423 NOTE: This option is reset when 'compatible' is set.
4424
4425 *'isfname'* *'isf'*
4426'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4427 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4428 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4429 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4430 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4431 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4432 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004433 The characters specified by this option are included in file names and
4434 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004435 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004436 Multi-byte characters 256 and above are always included, only the
4437 characters up to 255 are specified with this option.
4438 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004439 Think twice before adding white space to this option. Although a
4440 space may appear inside a file name, the effect will be that Vim
4441 doesn't know where a file name starts or ends when doing completion.
4442 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004443
4444 Note that on systems using a backslash as path separator, Vim tries to
4445 do its best to make it work as you would expect. That is a bit
4446 tricky, since Vi originally used the backslash to escape special
4447 characters. Vim will not remove a backslash in front of a normal file
4448 name character on these systems, but it will on Unix and alikes. The
4449 '&' and '^' are not included by default, because these are special for
4450 cmd.exe.
4451
4452 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004453 Each part can be a single character number or a range. A range is two
4454 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004455 decimal number between 0 and 255 or the ASCII character itself (does
4456 not work for digits). Example:
4457 "_,-,128-140,#-43" (include '_' and '-' and the range
4458 128 to 140 and '#' to 43)
4459 If a part starts with '^', the following character number or range
4460 will be excluded from the option. The option is interpreted from left
4461 to right. Put the excluded character after the range where it is
4462 included. To include '^' itself use it as the last character of the
4463 option or the end of a range. Example:
4464 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4465 If the character is '@', all characters where isalpha() returns TRUE
4466 are included. Normally these are the characters a to z and A to Z,
4467 plus accented characters. To include '@' itself use "@-@". Examples:
4468 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004469 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004470 "a-z,A-Z,@-@" All letters plus the '@' character.
4471 A comma can be included by using it where a character number is
4472 expected. Example:
4473 "48-57,,,_" Digits, comma and underscore.
4474 A comma can be excluded by prepending a '^'. Example:
4475 " -~,^,,9" All characters from space to '~', excluding
4476 comma, plus <Tab>.
4477 See |option-backslash| about including spaces and backslashes.
4478
4479 *'isident'* *'isi'*
4480'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4481 "@,48-57,_,128-167,224-235"
4482 otherwise: "@,48-57,_,192-255")
4483 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004484 The characters given by this option are included in identifiers.
4485 Identifiers are used in recognizing environment variables and after a
4486 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004487 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004488 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004489 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004490 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004491 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4492
4493 *'iskeyword'* *'isk'*
4494'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4495 "@,48-57,_,128-167,224-235"
4496 otherwise: "@,48-57,_,192-255"
4497 Vi default: "@,48-57,_")
4498 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004499 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004500 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004501 'isfname' for a description of the format of this option. For '@'
4502 characters above 255 check the "word" character class.
4503 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004504 For a help file it is set to all non-blank printable characters except
4505 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4506 command).
4507 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004508 This option also influences syntax highlighting, unless the syntax
4509 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004510 NOTE: This option is set to the Vi default value when 'compatible' is
4511 set and to the Vim default value when 'compatible' is reset.
4512
4513 *'isprint'* *'isp'*
4514'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4515 "@,~-255"; otherwise: "@,161-255")
4516 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004517 The characters given by this option are displayed directly on the
4518 screen. It is also used for "\p" in a |pattern|. The characters from
4519 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4520 even when they are not included in 'isprint' or excluded. See
4521 'isfname' for a description of the format of this option.
4522
4523 Non-printable characters are displayed with two characters:
4524 0 - 31 "^@" - "^_"
4525 32 - 126 always single characters
4526 127 "^?"
4527 128 - 159 "~@" - "~_"
4528 160 - 254 "| " - "|~"
4529 255 "~?"
4530 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4531 displayed as <xx>, with the hexadecimal value of the byte.
4532 When 'display' contains "uhex" all unprintable characters are
4533 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004534 The SpecialKey highlighting will be used for unprintable characters.
4535 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004536
4537 Multi-byte characters 256 and above are always included, only the
4538 characters up to 255 are specified with this option. When a character
4539 is printable but it is not available in the current font, a
4540 replacement character will be shown.
4541 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4542 There is no option to specify these characters.
4543
4544 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4545'joinspaces' 'js' boolean (default on)
4546 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004547 Insert two spaces after a '.', '?' and '!' with a join command.
4548 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4549 Otherwise only one space is inserted.
4550 NOTE: This option is set when 'compatible' is set.
4551
4552 *'key'*
4553'key' string (default "")
4554 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004555 {only available when compiled with the |+cryptv|
4556 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004557 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004558 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004559 Careful: Do not set the key value by hand, someone might see the typed
4560 key. Use the |:X| command. But you can make 'key' empty: >
4561 :set key=
4562< It is not possible to get the value of this option with ":set key" or
4563 "echo &key". This is to avoid showing it to someone who shouldn't
4564 know. It also means you cannot see it yourself once you have set it,
4565 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004566 You can use "&key" in an expression to detect whether encryption is
4567 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004568
4569 *'keymap'* *'kmp'* *E544*
4570'keymap' 'kmp' string (default "")
4571 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572 {only available when compiled with the |+keymap|
4573 feature}
4574 Name of a keyboard mapping. See |mbyte-keymap|.
4575 Setting this option to a valid keymap name has the side effect of
4576 setting 'iminsert' to one, so that the keymap becomes effective.
4577 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004578 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004579
4580 *'keymodel'* *'km'*
4581'keymodel' 'km' string (default "")
4582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583 List of comma separated words, which enable special things that keys
4584 can do. These values can be used:
4585 startsel Using a shifted special key starts selection (either
4586 Select mode or Visual mode, depending on "key" being
4587 present in 'selectmode').
4588 stopsel Using a not-shifted special key stops selection.
4589 Special keys in this context are the cursor keys, <End>, <Home>,
4590 <PageUp> and <PageDown>.
4591 The 'keymodel' option is set by the |:behave| command.
4592
4593 *'keywordprg'* *'kp'*
4594'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004595 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004596 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004597 Program to use for the |K| command. Environment variables are
4598 expanded |:set_env|. ":help" may be used to access the Vim internal
4599 help. (Note that previously setting the global option to the empty
4600 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004601 When the first character is ":", the command is invoked as a Vim
4602 Ex command prefixed with [count].
4603 When "man", "man -s" or an Ex command is used, Vim will automatically
4604 translate a count for the "K" command and pass it as the first
4605 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004606 See |option-backslash| about including spaces and backslashes.
4607 Example: >
4608 :set keywordprg=man\ -s
4609< This option cannot be set from a |modeline| or in the |sandbox|, for
4610 security reasons.
4611
4612 *'langmap'* *'lmap'* *E357* *E358*
4613'langmap' 'lmap' string (default "")
4614 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004615 {only available when compiled with the |+langmap|
4616 feature}
4617 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004618 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004619 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004620 care of translating these special characters to the original meaning
4621 of the key. This means you don't have to change the keyboard mode to
4622 be able to execute Normal mode commands.
4623 This is the opposite of the 'keymap' option, where characters are
4624 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004625 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004626 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004627 This option cannot be set from a |modeline| or in the |sandbox|, for
4628 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004629
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004630 Example (for Greek, in UTF-8): *greek* >
4631 :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 +00004632< Example (exchanges meaning of z and y for commands): >
4633 :set langmap=zy,yz,ZY,YZ
4634<
4635 The 'langmap' option is a list of parts, separated with commas. Each
4636 part can be in one of two forms:
4637 1. A list of pairs. Each pair is a "from" character immediately
4638 followed by the "to" character. Examples: "aA", "aAbBcC".
4639 2. A list of "from" characters, a semi-colon and a list of "to"
4640 characters. Example: "abc;ABC"
4641 Example: "aA,fgh;FGH,cCdDeE"
4642 Special characters need to be preceded with a backslash. These are
4643 ";", ',' and backslash itself.
4644
4645 This will allow you to activate vim actions without having to switch
4646 back and forth between the languages. Your language characters will
4647 be understood as normal vim English characters (according to the
4648 langmap mappings) in the following cases:
4649 o Normal/Visual mode (commands, buffer/register names, user mappings)
4650 o Insert/Replace Mode: Register names after CTRL-R
4651 o Insert/Replace Mode: Mappings
4652 Characters entered in Command-line mode will NOT be affected by
4653 this option. Note that this option can be changed at any time
4654 allowing to switch between mappings for different languages/encodings.
4655 Use a mapping to avoid having to type it each time!
4656
4657 *'langmenu'* *'lm'*
4658'langmenu' 'lm' string (default "")
4659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004660 {only available when compiled with the |+menu| and
4661 |+multi_lang| features}
4662 Language to use for menu translation. Tells which file is loaded
4663 from the "lang" directory in 'runtimepath': >
4664 "lang/menu_" . &langmenu . ".vim"
4665< (without the spaces). For example, to always use the Dutch menus, no
4666 matter what $LANG is set to: >
4667 :set langmenu=nl_NL.ISO_8859-1
4668< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004669 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004670 If your $LANG is set to a non-English language but you do want to use
4671 the English menus: >
4672 :set langmenu=none
4673< This option must be set before loading menus, switching on filetype
4674 detection or syntax highlighting. Once the menus are defined setting
4675 this option has no effect. But you could do this: >
4676 :source $VIMRUNTIME/delmenu.vim
4677 :set langmenu=de_DE.ISO_8859-1
4678 :source $VIMRUNTIME/menu.vim
4679< Warning: This deletes all menus that you defined yourself!
4680
Bram Moolenaard94464e2015-11-02 15:28:18 +01004681 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004682'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004683 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004684 {only available when compiled with the |+langmap|
4685 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004686 This is just like 'langremap' but with the value inverted. It only
4687 exists for backwards compatibility. When setting 'langremap' then
4688 'langnoremap' is set to the inverted value, and the other way around.
4689
4690 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4691'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4692 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004693 {only available when compiled with the |+langmap|
4694 feature}
4695 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004696 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004697 'langmap' disables some of your mappings, try resetting this option.
4698 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004699 that works for you to avoid mappings to break.
4700
Bram Moolenaar071d4272004-06-13 20:20:40 +00004701 *'laststatus'* *'ls'*
4702'laststatus' 'ls' number (default 1)
4703 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004704 The value of this option influences when the last window will have a
4705 status line:
4706 0: never
4707 1: only if there are at least two windows
4708 2: always
4709 The screen looks nicer with a status line if you have several
4710 windows, but it takes another screen line. |status-line|
4711
4712 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4713'lazyredraw' 'lz' boolean (default off)
4714 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004715 When this option is set, the screen will not be redrawn while
4716 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004717 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004718 update use |:redraw|.
4719
4720 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4721'linebreak' 'lbr' boolean (default off)
4722 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004723 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004724 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004725 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004726 than at the last character that fits on the screen. Unlike
4727 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004728 it only affects the way the file is displayed, not its contents.
4729 If 'breakindent' is set, line is visually indented. Then, the value
4730 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004731 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004732 Note that <Tab> characters after an <EOL> are mostly not displayed
4733 with the right amount of white space.
4734
4735 *'lines'* *E593*
4736'lines' number (default 24 or terminal height)
4737 global
4738 Number of lines of the Vim window.
4739 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004740 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004741 When Vim is running in the GUI or in a resizable window, setting this
4742 option will cause the window size to be changed. When you only want
4743 to use the size for the GUI, put the command in your |gvimrc| file.
4744 Vim limits the number of lines to what fits on the screen. You can
4745 use this command to get the tallest window possible: >
4746 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004747< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004748 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004749 When you set this option and Vim is unable to change the physical
4750 number of lines of the display, the display may be messed up.
4751
4752 *'linespace'* *'lsp'*
4753'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4754 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004755 {only in the GUI}
4756 Number of pixel lines inserted between characters. Useful if the font
4757 uses the full character cell height, making lines touch each other.
4758 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004759 With some fonts there can be too much room between lines (to have
4760 space for ascents and descents). Then it makes sense to set
4761 'linespace' to a negative value. This may cause display problems
4762 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004763
4764 *'lisp'* *'nolisp'*
4765'lisp' boolean (default off)
4766 local to buffer
4767 {not available when compiled without the |+lispindent|
4768 feature}
4769 Lisp mode: When <Enter> is typed in insert mode set the indent for
4770 the next line to Lisp standards (well, sort of). Also happens with
4771 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4772 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4773 better. Also see 'lispwords'.
4774 The '-' character is included in keyword characters. Redefines the
4775 "=" operator to use this same indentation algorithm rather than
4776 calling an external program if 'equalprg' is empty.
4777 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004778
4779 *'lispwords'* *'lw'*
4780'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004781 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782 {not available when compiled without the |+lispindent|
4783 feature}
4784 Comma separated list of words that influence the Lisp indenting.
4785 |'lisp'|
4786
4787 *'list'* *'nolist'*
4788'list' boolean (default off)
4789 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004790 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4791 line. Useful to see the difference between tabs and spaces and for
4792 trailing blanks. Further changed by the 'listchars' option.
4793
4794 The cursor is displayed at the start of the space a Tab character
4795 occupies, not at the end as usual in Normal mode. To get this cursor
4796 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004797 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004798<
4799 Note that list mode will also affect formatting (set with 'textwidth'
4800 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004801 changing the way tabs are displayed.
4802
4803 *'listchars'* *'lcs'*
4804'listchars' 'lcs' string (default "eol:$")
4805 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004806 Strings to use in 'list' mode and for the |:list| command. It is a
4807 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004808 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004809 eol:c Character to show at the end of each line. When
4810 omitted, there is no extra character at the end of the
4811 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004812 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004813 tab:xy[z] Two or three characters to be used to show a tab.
4814 The third character is optional.
4815
4816 tab:xy The 'x' is always used, then 'y' as many times as will
4817 fit. Thus "tab:>-" displays:
4818 >
4819 >-
4820 >--
4821 etc.
4822
4823 tab:xyz The 'z' is always used, then 'x' is prepended, and
4824 then 'y' is used as many times as will fit. Thus
4825 "tab:<->" displays:
4826 >
4827 <>
4828 <->
4829 <-->
4830 etc.
4831
4832 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004833 *lcs-space*
4834 space:c Character to show for a space. When omitted, spaces
4835 are left blank.
4836 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004837 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004838 trailing spaces are blank. Overrides the "space"
4839 setting for trailing spaces.
4840 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004841 extends:c Character to show in the last column, when 'wrap' is
4842 off and the line continues beyond the right of the
4843 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004844 *lcs-precedes*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 precedes:c Character to show in the first column, when 'wrap'
4846 is off and there is text preceding the character
4847 visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004848 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004849 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004850 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004851 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004852 nbsp:c Character to show for a non-breakable space character
4853 (0xA0 (160 decimal) and U+202F). Left blank when
4854 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004855
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004856 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004857 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004858 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859
4860 Examples: >
4861 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004862 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863 :set lcs=extends:>,precedes:<
4864< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004865 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004866 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867
4868 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4869'loadplugins' 'lpl' boolean (default on)
4870 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871 When on the plugin scripts are loaded when starting up |load-plugins|.
4872 This option can be reset in your |vimrc| file to disable the loading
4873 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004874 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4875 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004876
Bram Moolenaard94464e2015-11-02 15:28:18 +01004877 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004878'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004879 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004880 {only available when compiled with the |+lua/dyn|
4881 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004882 Specifies the name of the Lua shared library. The default is
4883 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004884 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004885 This option cannot be set from a |modeline| or in the |sandbox|, for
4886 security reasons.
4887
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004888 *'macatsui'* *'nomacatsui'*
4889'macatsui' boolean (default on)
4890 global
4891 {only available in Mac GUI version}
4892 This is a workaround for when drawing doesn't work properly. When set
4893 and compiled with multi-byte support ATSUI text drawing is used. When
4894 not set ATSUI text drawing is not used. Switch this option off when
4895 you experience drawing problems. In a future version the problems may
4896 be solved and this option becomes obsolete. Therefore use this method
4897 to unset it: >
4898 if exists('&macatsui')
4899 set nomacatsui
4900 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004901< Another option to check if you have drawing problems is
4902 'termencoding'.
4903
Bram Moolenaar071d4272004-06-13 20:20:40 +00004904 *'magic'* *'nomagic'*
4905'magic' boolean (default on)
4906 global
4907 Changes the special characters that can be used in search patterns.
4908 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004909 WARNING: Switching this option off most likely breaks plugins! That
4910 is because many patterns assume it's on and will fail when it's off.
4911 Only switch it off when working with old Vi scripts. In any other
4912 situation write patterns that work when 'magic' is on. Include "\M"
4913 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004914
4915 *'makeef'* *'mef'*
4916'makeef' 'mef' string (default: "")
4917 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918 {not available when compiled without the |+quickfix|
4919 feature}
4920 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4921 and the |:grep| command.
4922 When it is empty, an internally generated temp file will be used.
4923 When "##" is included, it is replaced by a number to make the name
4924 unique. This makes sure that the ":make" command doesn't overwrite an
4925 existing file.
4926 NOT used for the ":cf" command. See 'errorfile' for that.
4927 Environment variables are expanded |:set_env|.
4928 See |option-backslash| about including spaces and backslashes.
4929 This option cannot be set from a |modeline| or in the |sandbox|, for
4930 security reasons.
4931
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004932 *'makeencoding'* *'menc'*
4933'makeencoding' 'menc' string (default "")
4934 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004935 Encoding used for reading the output of external commands. When empty,
4936 encoding is not converted.
4937 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4938 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4939 and `:laddfile`.
4940
4941 This would be mostly useful when you use MS-Windows and set 'encoding'
4942 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4943 'makeencoding' to "char" has the same effect as setting to the system
4944 locale encoding. Example: >
4945 :set encoding=utf-8
4946 :set makeencoding=char " system locale is used
4947<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004948 *'makeprg'* *'mp'*
4949'makeprg' 'mp' string (default "make", VMS: "MMS")
4950 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004951 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004952 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4953 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004954 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004955 Environment variables are expanded |:set_env|. See |option-backslash|
4956 about including spaces and backslashes.
4957 Note that a '|' must be escaped twice: once for ":set" and once for
4958 the interpretation of a command. When you use a filter called
4959 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004960 :set makeprg=gmake\ \\\|\ myfilter
4961< The placeholder "$*" can be given (even multiple times) to specify
4962 where the arguments will be included, for example: >
4963 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4964< This option cannot be set from a |modeline| or in the |sandbox|, for
4965 security reasons.
4966
4967 *'matchpairs'* *'mps'*
4968'matchpairs' 'mps' string (default "(:),{:},[:]")
4969 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004970 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004971 other.
4972 Only character pairs are allowed that are different, thus you cannot
4973 jump between two double quotes.
4974 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004975 The pairs must be separated by a comma. Example for including '<' and
4976 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004977 :set mps+=<:>
4978
4979< A more exotic example, to jump between the '=' and ';' in an
4980 assignment, useful for languages like C and Java: >
4981 :au FileType c,cpp,java set mps+==:;
4982
4983< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004984 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004985
4986 *'matchtime'* *'mat'*
4987'matchtime' 'mat' number (default 5)
4988 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989 Tenths of a second to show the matching paren, when 'showmatch' is
4990 set. Note that this is not in milliseconds, like other options that
4991 set a time. This is to be compatible with Nvi.
4992
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004993 *'maxcombine'* *'mco'*
4994'maxcombine' 'mco' number (default 2)
4995 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004996 The maximum number of combining characters supported for displaying.
4997 Only used when 'encoding' is "utf-8".
4998 The default is OK for most languages. Hebrew may require 4.
4999 Maximum value is 6.
5000 Even when this option is set to 2 you can still edit text with more
5001 combining characters, you just can't see them. Use |g8| or |ga|.
5002 See |mbyte-combining|.
5003
Bram Moolenaar071d4272004-06-13 20:20:40 +00005004 *'maxfuncdepth'* *'mfd'*
5005'maxfuncdepth' 'mfd' number (default 100)
5006 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005007 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005008 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005009 Maximum depth of function calls for user functions. This normally
5010 catches endless recursion. When using a recursive function with
5011 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5012 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005013 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005014 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005015 See also |:function|.
5016
5017 *'maxmapdepth'* *'mmd'* *E223*
5018'maxmapdepth' 'mmd' number (default 1000)
5019 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005020 Maximum number of times a mapping is done without resulting in a
5021 character to be used. This normally catches endless mappings, like
5022 ":map x y" with ":map y x". It still does not catch ":map g wg",
5023 because the 'w' is used before the next mapping is done. See also
5024 |key-mapping|.
5025
5026 *'maxmem'* *'mm'*
5027'maxmem' 'mm' number (default between 256 to 5120 (system
5028 dependent) or half the amount of memory
5029 available)
5030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005031 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5032 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005033 other memory to be freed.
5034 The maximum usable value is about 2000000. Use this to work without a
5035 limit.
5036 The value is ignored when 'swapfile' is off.
5037 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005038
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005039 *'maxmempattern'* *'mmp'*
5040'maxmempattern' 'mmp' number (default 1000)
5041 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005042 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005043 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005044 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005045 When Vim runs into the limit it gives an error message and mostly
5046 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005047 Running into the limit often means that the pattern is very
5048 inefficient or too complex. This may already happen with the pattern
5049 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005050 Might also happen on redraw, when syntax rules try to match a complex
5051 text structure.
5052 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5053 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005054
Bram Moolenaar071d4272004-06-13 20:20:40 +00005055 *'maxmemtot'* *'mmt'*
5056'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5057 dependent) or half the amount of memory
5058 available)
5059 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005060 Maximum amount of memory in Kbyte to use for all buffers together.
5061 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005062 without a limit.
5063 On 64 bit machines higher values might work. But hey, do you really
5064 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005065 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005066 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005067 Buffers with 'swapfile' off still count to the total amount of memory
5068 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005069 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005070
5071 *'menuitems'* *'mis'*
5072'menuitems' 'mis' number (default 25)
5073 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074 {not available when compiled without the |+menu|
5075 feature}
5076 Maximum number of items to use in a menu. Used for menus that are
5077 generated from a list of items, e.g., the Buffers menu. Changing this
5078 option has no direct effect, the menu must be refreshed first.
5079
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005080 *'mkspellmem'* *'msm'*
5081'mkspellmem' 'msm' string (default "460000,2000,500")
5082 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005083 {not available when compiled without the |+syntax|
5084 feature}
5085 Parameters for |:mkspell|. This tunes when to start compressing the
5086 word tree. Compression can be slow when there are many words, but
5087 it's needed to avoid running out of memory. The amount of memory used
5088 per word depends very much on how similar the words are, that's why
5089 this tuning is complicated.
5090
5091 There are three numbers, separated by commas:
5092 {start},{inc},{added}
5093
5094 For most languages the uncompressed word tree fits in memory. {start}
5095 gives the amount of memory in Kbyte that can be used before any
5096 compression is done. It should be a bit smaller than the amount of
5097 memory that is available to Vim.
5098
5099 When going over the {start} limit the {inc} number specifies the
5100 amount of memory in Kbyte that can be allocated before another
5101 compression is done. A low number means compression is done after
5102 less words are added, which is slow. A high number means more memory
5103 will be allocated.
5104
5105 After doing compression, {added} times 1024 words can be added before
5106 the {inc} limit is ignored and compression is done when any extra
5107 amount of memory is needed. A low number means there is a smaller
5108 chance of hitting the {inc} limit, less memory is used but it's
5109 slower.
5110
5111 The languages for which these numbers are important are Italian and
5112 Hungarian. The default works for when you have about 512 Mbyte. If
5113 you have 1 Gbyte you could use: >
5114 :set mkspellmem=900000,3000,800
5115< If you have less than 512 Mbyte |:mkspell| may fail for some
5116 languages, no matter what you set 'mkspellmem' to.
5117
Bram Moolenaar07607392019-05-26 19:20:43 +02005118 This option cannot be set from a |modeline| or in the |sandbox|.
5119
Bram Moolenaar071d4272004-06-13 20:20:40 +00005120 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005121'modeline' 'ml' boolean (Vim default: on (off for root),
5122 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005123 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005124 If 'modeline' is on 'modelines' gives the number of lines that is
5125 checked for set commands. If 'modeline' is off or 'modelines' is zero
5126 no lines are checked. See |modeline|.
5127
5128 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5129'modelineexpr' 'mle' boolean (default: off)
5130 global
5131 When on allow some options that are an expression to be set in the
5132 modeline. Check the option for whether it is affected by
5133 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005134 This option cannot be set from a |modeline| or in the |sandbox|, for
5135 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005136
Bram Moolenaar071d4272004-06-13 20:20:40 +00005137 *'modelines'* *'mls'*
5138'modelines' 'mls' number (default 5)
5139 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005140 If 'modeline' is on 'modelines' gives the number of lines that is
5141 checked for set commands. If 'modeline' is off or 'modelines' is zero
5142 no lines are checked. See |modeline|.
5143 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5144 set and to the Vim default value when 'compatible' is reset.
5145
5146 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005147 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005148'modifiable' 'ma' boolean (default on)
5149 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005150 When off the buffer contents cannot be changed. The 'fileformat' and
5151 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005152 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005153
5154 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5155'modified' 'mod' boolean (default off)
5156 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157 When on, the buffer is considered to be modified. This option is set
5158 when:
5159 1. A change was made to the text since it was last written. Using the
5160 |undo| command to go back to the original text will reset the
5161 option. But undoing changes that were made before writing the
5162 buffer will set the option again, since the text is different from
5163 when it was written.
5164 2. 'fileformat' or 'fileencoding' is different from its original
5165 value. The original value is set when the buffer is read or
5166 written. A ":set nomodified" command also resets the original
5167 values to the current values and the 'modified' option will be
5168 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005169 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005170 This option is not set when a change is made to the buffer as the
5171 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5172 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5173 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005174 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5175 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005176 Note that the text may actually be the same, e.g. 'modified' is set
5177 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178
5179 *'more'* *'nomore'*
5180'more' boolean (Vim default: on, Vi default: off)
5181 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182 When on, listings pause when the whole screen is filled. You will get
5183 the |more-prompt|. When this option is off there are no pauses, the
5184 listing continues until finished.
5185 NOTE: This option is set to the Vi default value when 'compatible' is
5186 set and to the Vim default value when 'compatible' is reset.
5187
5188 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005189'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5190 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005191 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005192 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005193 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5194 sysmouse and Linux console with gpm). For using the mouse in the
5195 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005197 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005198 v Visual mode
5199 i Insert mode
5200 c Command-line mode
5201 h all previous modes when editing a help file
5202 a all previous modes
5203 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005204 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005205 :set mouse=a
5206< When the mouse is not enabled, the GUI will still use the mouse for
5207 modeless selection. This doesn't move the text cursor.
5208
5209 See |mouse-using|. Also see |'clipboard'|.
5210
5211 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005212 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005213 the mouse buttons can still be used by keeping the shift key pressed.
5214 Also see the 'clipboard' option.
5215
5216 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5217'mousefocus' 'mousef' boolean (default off)
5218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005219 {only works in the GUI}
5220 The window that the mouse pointer is on is automatically activated.
5221 When changing the window layout or window focus in another way, the
5222 mouse pointer is moved to the window with keyboard focus. Off is the
5223 default because it makes using the pull down menus a little goofy, as
5224 a pointer transit may activate a window unintentionally.
5225
5226 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5227'mousehide' 'mh' boolean (default on)
5228 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005229 {only works in the GUI}
5230 When on, the mouse pointer is hidden when characters are typed.
5231 The mouse pointer is restored when the mouse is moved.
5232
5233 *'mousemodel'* *'mousem'*
5234'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5235 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005236 Sets the model to use for the mouse. The name mostly specifies what
5237 the right mouse button is used for:
5238 extend Right mouse button extends a selection. This works
5239 like in an xterm.
5240 popup Right mouse button pops up a menu. The shifted left
5241 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005242 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005243 popup_setpos Like "popup", but the cursor will be moved to the
5244 position where the mouse was clicked, and thus the
5245 selected operation will act upon the clicked object.
5246 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005247 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005248 course, that right clicking outside a selection will
5249 end Visual mode.
5250 Overview of what button does what for each model:
5251 mouse extend popup(_setpos) ~
5252 left click place cursor place cursor
5253 left drag start selection start selection
5254 shift-left search word extend selection
5255 right click extend selection popup menu (place cursor)
5256 right drag extend selection -
5257 middle click paste paste
5258
5259 In the "popup" model the right mouse button produces a pop-up menu.
5260 You need to define this first, see |popup-menu|.
5261
5262 Note that you can further refine the meaning of buttons with mappings.
5263 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5264 selection (because that's handled in the GUI code directly).
5265
5266 The 'mousemodel' option is set by the |:behave| command.
5267
5268 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005269'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5270 vs:leftright,vd:lrsizing,m:no,
5271 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005272 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005273 {only available when compiled with the |+mouseshape|
5274 feature}
5275 This option tells Vim what the mouse pointer should look like in
5276 different modes. The option is a comma separated list of parts, much
5277 like used for 'guicursor'. Each part consist of a mode/location-list
5278 and an argument-list:
5279 mode-list:shape,mode-list:shape,..
5280 The mode-list is a dash separated list of these modes/locations:
5281 In a normal window: ~
5282 n Normal mode
5283 v Visual mode
5284 ve Visual mode with 'selection' "exclusive" (same as 'v',
5285 if not specified)
5286 o Operator-pending mode
5287 i Insert mode
5288 r Replace mode
5289
5290 Others: ~
5291 c appending to the command-line
5292 ci inserting in the command-line
5293 cr replacing in the command-line
5294 m at the 'Hit ENTER' or 'More' prompts
5295 ml idem, but cursor in the last line
5296 e any mode, pointer below last window
5297 s any mode, pointer on a status line
5298 sd any mode, while dragging a status line
5299 vs any mode, pointer on a vertical separator line
5300 vd any mode, while dragging a vertical separator line
5301 a everywhere
5302
5303 The shape is one of the following:
5304 avail name looks like ~
5305 w x arrow Normal mouse pointer
5306 w x blank no pointer at all (use with care!)
5307 w x beam I-beam
5308 w x updown up-down sizing arrows
5309 w x leftright left-right sizing arrows
5310 w x busy The system's usual busy pointer
5311 w x no The system's usual 'no input' pointer
5312 x udsizing indicates up-down resizing
5313 x lrsizing indicates left-right resizing
5314 x crosshair like a big thin +
5315 x hand1 black hand
5316 x hand2 white hand
5317 x pencil what you write with
5318 x question big ?
5319 x rightup-arrow arrow pointing right-up
5320 w x up-arrow arrow pointing up
5321 x <number> any X11 pointer number (see X11/cursorfont.h)
5322
5323 The "avail" column contains a 'w' if the shape is available for Win32,
5324 x for X11.
5325 Any modes not specified or shapes not available use the normal mouse
5326 pointer.
5327
5328 Example: >
5329 :set mouseshape=s:udsizing,m:no
5330< will make the mouse turn to a sizing arrow over the status lines and
5331 indicate no input when the hit-enter prompt is displayed (since
5332 clicking the mouse has no effect in this state.)
5333
5334 *'mousetime'* *'mouset'*
5335'mousetime' 'mouset' number (default 500)
5336 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005337 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5338 time in msec between two mouse clicks for the second click to be
5339 recognized as a multi click.
5340
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005341 *'mzschemedll'*
5342'mzschemedll' string (default depends on the build)
5343 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005344 {only available when compiled with the |+mzscheme/dyn|
5345 feature}
5346 Specifies the name of the MzScheme shared library. The default is
5347 DYNAMIC_MZSCH_DLL which was specified at compile time.
5348 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005349 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005350 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005351 This option cannot be set from a |modeline| or in the |sandbox|, for
5352 security reasons.
5353
5354 *'mzschemegcdll'*
5355'mzschemegcdll' string (default depends on the build)
5356 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005357 {only available when compiled with the |+mzscheme/dyn|
5358 feature}
5359 Specifies the name of the MzScheme GC shared library. The default is
5360 DYNAMIC_MZGC_DLL which was specified at compile time.
5361 The value can be equal to 'mzschemedll' if it includes the GC code.
5362 Environment variables are expanded |:set_env|.
5363 This option cannot be set from a |modeline| or in the |sandbox|, for
5364 security reasons.
5365
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005366 *'mzquantum'* *'mzq'*
5367'mzquantum' 'mzq' number (default 100)
5368 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005369 {not available when compiled without the |+mzscheme|
5370 feature}
5371 The number of milliseconds between polls for MzScheme threads.
5372 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005373 NOTE: This option is set to the Vim default value when 'compatible'
5374 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005375
Bram Moolenaar071d4272004-06-13 20:20:40 +00005376 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005377'nrformats' 'nf' string (default "bin,octal,hex",
5378 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005379 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 This defines what bases Vim will consider for numbers when using the
5381 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5382 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005383 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005385 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005386 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005387 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005388 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005389 considered to be hexadecimal. Example: Using CTRL-X on
5390 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005391 bin If included, numbers starting with "0b" or "0B" will be
5392 considered to be binary. Example: Using CTRL-X on
5393 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005394 Numbers which simply begin with a digit in the range 1-9 are always
5395 considered decimal. This also happens for numbers that are not
5396 recognized as octal or hex.
5397
5398 *'number'* *'nu'* *'nonumber'* *'nonu'*
5399'number' 'nu' boolean (default off)
5400 local to window
5401 Print the line number in front of each line. When the 'n' option is
5402 excluded from 'cpoptions' a wrapped line will not use the column of
5403 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005404 The 'numberwidth' option can be used to set the room used for the line
5405 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005406 When a long, wrapped line doesn't start with the first character, '-'
5407 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005408 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5409 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005410 *number_relativenumber*
5411 The 'relativenumber' option changes the displayed number to be
5412 relative to the cursor. Together with 'number' there are these
5413 four combinations (cursor in line 3):
5414
Bram Moolenaar3848e002016-03-19 18:42:29 +01005415 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005416 'nornu' 'nornu' 'rnu' 'rnu'
5417
5418 |apple | 1 apple | 2 apple | 2 apple
5419 |pear | 2 pear | 1 pear | 1 pear
5420 |nobody | 3 nobody | 0 nobody |3 nobody
5421 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005422
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005423 *'numberwidth'* *'nuw'*
5424'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5425 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005426 {only available when compiled with the |+linebreak|
5427 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005428 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005429 when the 'number' or 'relativenumber' option is set or printing lines
5430 with a line number. Since one space is always between the number and
5431 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005432 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005433 fit the highest line number in the buffer respectively the number of
5434 rows in the window, depending on whether 'number' or 'relativenumber'
5435 is set. Thus with the Vim default of 4 there is room for a line number
5436 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005437 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005438 NOTE: This option is set to the Vi default value when 'compatible' is
5439 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005440
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005441 *'omnifunc'* *'ofu'*
5442'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005443 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005444 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005445 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005446 This option specifies a function to be used for Insert mode omni
5447 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005448 See |complete-functions| for an explanation of how the function is
5449 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005450 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005451 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005452 This option cannot be set from a |modeline| or in the |sandbox|, for
5453 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005454
5455
Bram Moolenaar02467872007-05-06 13:22:01 +00005456 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005457'opendevice' 'odev' boolean (default off)
5458 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005459 {only for MS-DOS, MS-Windows and OS/2}
5460 Enable reading and writing from devices. This may get Vim stuck on a
5461 device that can be opened but doesn't actually do the I/O. Therefore
5462 it is off by default.
5463 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5464 result in editing a device.
5465
5466
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005467 *'operatorfunc'* *'opfunc'*
5468'operatorfunc' 'opfunc' string (default: empty)
5469 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005470 This option specifies a function to be called by the |g@| operator.
5471 See |:map-operator| for more info and an example.
5472
5473 This option cannot be set from a |modeline| or in the |sandbox|, for
5474 security reasons.
5475
5476
Bram Moolenaar251e1912011-06-19 05:09:16 +02005477 *'osfiletype'* *'oft'*
5478'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005479 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005480 This option was supported on RISC OS, which has been removed.
5481
Bram Moolenaar071d4272004-06-13 20:20:40 +00005482
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005483 *'packpath'* *'pp'*
5484'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005485 Directories used to find packages. See |packages|.
5486
5487
Bram Moolenaar071d4272004-06-13 20:20:40 +00005488 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005489'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005490 global
5491 Specifies the nroff macros that separate paragraphs. These are pairs
5492 of two letters (see |object-motions|).
5493
5494 *'paste'* *'nopaste'*
5495'paste' boolean (default off)
5496 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005497 Put Vim in Paste mode. This is useful if you want to cut or copy
5498 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005499 unexpected effects.
5500 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005501 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005502 knows about pasting and will mostly do the right thing without 'paste'
5503 being set. The same is true for a terminal where Vim handles the
5504 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005505 This option is reset when starting the GUI. Thus if you set it in
5506 your .vimrc it will work in a terminal, but not in the GUI. Setting
5507 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5508 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005509 When the 'paste' option is switched on (also when it was already on):
5510 - mapping in Insert mode and Command-line mode is disabled
5511 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005512 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005513 - 'expandtab' is reset
5514 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005515 - 'revins' is reset
5516 - 'ruler' is reset
5517 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005518 - 'smartindent' is reset
5519 - 'smarttab' is reset
5520 - 'softtabstop' is set to 0
5521 - 'textwidth' is set to 0
5522 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005523 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005524 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005525 - 'indentexpr'
5526 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 NOTE: When you start editing another file while the 'paste' option is
5528 on, settings from the modelines or autocommands may change the
5529 settings again, causing trouble when pasting text. You might want to
5530 set the 'paste' option again.
5531 When the 'paste' option is reset the mentioned options are restored to
5532 the value before the moment 'paste' was switched from off to on.
5533 Resetting 'paste' before ever setting it does not have any effect.
5534 Since mapping doesn't work while 'paste' is active, you need to use
5535 the 'pastetoggle' option to toggle the 'paste' option with some key.
5536
5537 *'pastetoggle'* *'pt'*
5538'pastetoggle' 'pt' string (default "")
5539 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005540 When non-empty, specifies the key sequence that toggles the 'paste'
5541 option. This is like specifying a mapping: >
5542 :map {keys} :set invpaste<CR>
5543< Where {keys} is the value of 'pastetoggle'.
5544 The difference is that it will work even when 'paste' is set.
5545 'pastetoggle' works in Insert mode and Normal mode, but not in
5546 Command-line mode.
5547 Mappings are checked first, thus overrule 'pastetoggle'. However,
5548 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5549 this: >
5550 :map <F10> :set paste<CR>
5551 :map <F11> :set nopaste<CR>
5552 :imap <F10> <C-O>:set paste<CR>
5553 :imap <F11> <nop>
5554 :set pastetoggle=<F11>
5555< This will make <F10> start paste mode and <F11> stop paste mode.
5556 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5557 mode everything is inserted literally, except the 'pastetoggle' key
5558 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005559 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005560
5561 *'pex'* *'patchexpr'*
5562'patchexpr' 'pex' string (default "")
5563 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564 {not available when compiled without the |+diff|
5565 feature}
5566 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005567 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568
Bram Moolenaardbc28022014-07-26 13:40:44 +02005569 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005570'patchmode' 'pm' string (default "")
5571 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572 When non-empty the oldest version of a file is kept. This can be used
5573 to keep the original version of a file if you are changing files in a
5574 source distribution. Only the first time that a file is written a
5575 copy of the original file will be kept. The name of the copy is the
5576 name of the original file with the string in the 'patchmode' option
5577 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005578 ".orig" or ".org". 'backupdir' must not be empty for this to work
5579 (Detail: The backup file is renamed to the patchmode file after the
5580 new file has been successfully written, that's why it must be possible
5581 to write a backup file). If there was no file to be backed up, an
5582 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005583 When the 'backupskip' pattern matches, a patchmode file is not made.
5584 Using 'patchmode' for compressed files appends the extension at the
5585 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5586 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005587 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005588
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005589 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005590'path' 'pa' string (default on Unix: ".,/usr/include,,"
5591 on OS/2: ".,/emx/include,,"
5592 other systems: ".,,")
5593 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005595 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5596 provided that the file being searched for has a relative path (not
5597 starting with "/", "./" or "../"). The directories in the 'path'
5598 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005599 - Use commas to separate directory names: >
5600 :set path=.,/usr/local/include,/usr/include
5601< - Spaces can also be used to separate directory names (for backwards
5602 compatibility with version 3.0). To have a space in a directory
5603 name, precede it with an extra backslash, and escape the space: >
5604 :set path=.,/dir/with\\\ space
5605< - To include a comma in a directory name precede it with an extra
5606 backslash: >
5607 :set path=.,/dir/with\\,comma
5608< - To search relative to the directory of the current file, use: >
5609 :set path=.
5610< - To search in the current directory use an empty string between two
5611 commas: >
5612 :set path=,,
5613< - A directory name may end in a ':' or '/'.
5614 - Environment variables are expanded |:set_env|.
5615 - When using |netrw.vim| URLs can be used. For example, adding
5616 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005617 - Search upwards and downwards in a directory tree using "*", "**" and
5618 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005619 {not available when compiled without the |+path_extra| feature}
5620 - Careful with '\' characters, type two to get one in the option: >
5621 :set path=.,c:\\include
5622< Or just use '/' instead: >
5623 :set path=.,c:/include
5624< Don't forget "." or files won't even be found in the same directory as
5625 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005626 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005627 it is something like 256 or 1024 characters.
5628 You can check if all the include files are found, using the value of
5629 'path', see |:checkpath|.
5630 The use of |:set+=| and |:set-=| is preferred when adding or removing
5631 directories from the list. This avoids problems when a future version
5632 uses another default. To remove the current directory use: >
5633 :set path-=
5634< To add the current directory use: >
5635 :set path+=
5636< To use an environment variable, you probably need to replace the
5637 separator. Here is an example to append $INCL, in which directory
5638 names are separated with a semi-colon: >
5639 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5640< Replace the ';' with a ':' or whatever separator is used. Note that
5641 this doesn't work when $INCL contains a comma or white space.
5642
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005643 *'perldll'*
5644'perldll' string (default depends on the build)
5645 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005646 {only available when compiled with the |+perl/dyn|
5647 feature}
5648 Specifies the name of the Perl shared library. The default is
5649 DYNAMIC_PERL_DLL, which was specified at compile time.
5650 Environment variables are expanded |:set_env|.
5651 This option cannot be set from a |modeline| or in the |sandbox|, for
5652 security reasons.
5653
Bram Moolenaar071d4272004-06-13 20:20:40 +00005654 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5655'preserveindent' 'pi' boolean (default off)
5656 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005657 When changing the indent of the current line, preserve as much of the
5658 indent structure as possible. Normally the indent is replaced by a
5659 series of tabs followed by spaces as required (unless |'expandtab'| is
5660 enabled, in which case only spaces are used). Enabling this option
5661 means the indent will preserve as many existing characters as possible
5662 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005663 'expandtab' does not apply to the preserved white space, a Tab remains
5664 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005665 NOTE: When using ">>" multiple times the resulting indent is a mix of
5666 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005667 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005668 Also see 'copyindent'.
5669 Use |:retab| to clean up white space.
5670
5671 *'previewheight'* *'pvh'*
5672'previewheight' 'pvh' number (default 12)
5673 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005674 {not available when compiled without the |+quickfix|
5675 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005676 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005677 commands. Used for |CTRL-W_}| when no count is given. Not used when
5678 'previewpopup' is set.
5679
5680 *'previewpopup'* *'pvp'*
5681'previewpopup' 'pvp' string (default empty)
5682 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005683 {not available when compiled without the |+textprop|
5684 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005685 When not empty a popup window is used for commands that would open a
5686 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005687 Not used for the insert completion info, add "popup" to
5688 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005689
5690 *'previewwindow'* *'nopreviewwindow'*
5691 *'pvw'* *'nopvw'* *E590*
5692'previewwindow' 'pvw' boolean (default off)
5693 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005694 {not available when compiled without the |+quickfix|
5695 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005696 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005697 set. It's normally not set directly, but by using one of the commands
5698 |:ptag|, |:pedit|, etc.
5699
5700 *'printdevice'* *'pdev'*
5701'printdevice' 'pdev' string (default empty)
5702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005703 {only available when compiled with the |+printer|
5704 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005705 The name of the printer to be used for |:hardcopy|.
5706 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005707 This option cannot be set from a |modeline| or in the |sandbox|, for
5708 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005709
Bram Moolenaar8299df92004-07-10 09:47:34 +00005710 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005711'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005712 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713 {only available when compiled with the |+printer|
5714 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005715 Sets the character encoding used when printing.
5716 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717
5718 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005719'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005720 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721 {only available when compiled with the |+printer|
5722 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005723 Expression used to print the PostScript produced with |:hardcopy|.
5724 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005725 This option cannot be set from a |modeline| or in the |sandbox|, for
5726 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005727
Bram Moolenaar8299df92004-07-10 09:47:34 +00005728 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005729'printfont' 'pfn' string (default "courier")
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 font that will be used for |:hardcopy|.
5734 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735
5736 *'printheader'* *'pheader'*
5737'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5738 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739 {only available when compiled with the |+printer|
5740 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005741 The format of the header produced in |:hardcopy| output.
5742 See |pheader-option|.
5743
5744 *'printmbcharset'* *'pmbcs'*
5745'printmbcharset' 'pmbcs' string (default "")
5746 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005747 {only available when compiled with the |+printer|
5748 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005749 The CJK character set to be used for CJK output from |:hardcopy|.
5750 See |pmbcs-option|.
5751
5752 *'printmbfont'* *'pmbfn'*
5753'printmbfont' 'pmbfn' string (default "")
5754 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005755 {only available when compiled with the |+printer|
5756 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005757 List of font names to be used for CJK output from |:hardcopy|.
5758 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005759
5760 *'printoptions'* *'popt'*
5761'printoptions' 'popt' string (default "")
5762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005764 List of items that control the format of the output of |:hardcopy|.
5765 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005766
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005767 *'prompt'* *'noprompt'*
5768'prompt' boolean (default on)
5769 global
5770 When on a ":" prompt is used in Ex mode.
5771
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005772 *'pumheight'* *'ph'*
5773'pumheight' 'ph' number (default 0)
5774 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005775 Determines the maximum number of items to show in the popup menu for
5776 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005777 |ins-completion-menu|.
5778
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005779 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005780'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005781 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005782 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005783 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005784
Bram Moolenaard94464e2015-11-02 15:28:18 +01005785 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005786'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005787 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005788 {only available when compiled with the |+python/dyn|
5789 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005790 Specifies the name of the Python 2.x shared library. The default is
5791 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005792 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005793 This option cannot be set from a |modeline| or in the |sandbox|, for
5794 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005795
Bram Moolenaar94073162018-01-31 21:49:05 +01005796 *'pythonhome'*
5797'pythonhome' string (default "")
5798 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005799 {only available when compiled with the |+python/dyn|
5800 feature}
5801 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5802 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5803 which was specified at compile time, will be used for the Python 2.x
5804 home directory.
5805 Environment variables are expanded |:set_env|.
5806 This option cannot be set from a |modeline| or in the |sandbox|, for
5807 security reasons.
5808
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005809 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005810'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005811 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005812 {only available when compiled with the |+python3/dyn|
5813 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005814 Specifies the name of the Python 3 shared library. The default is
5815 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005816 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005817 This option cannot be set from a |modeline| or in the |sandbox|, for
5818 security reasons.
5819
Bram Moolenaar94073162018-01-31 21:49:05 +01005820 *'pythonthreehome'*
5821'pythonthreehome' string (default "")
5822 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005823 {only available when compiled with the |+python3/dyn|
5824 feature}
5825 Specifies the name of the Python 3 home directory. When
5826 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5827 PYTHON3_HOME, which was specified at compile time, will be used for
5828 the Python 3 home directory.
5829 Environment variables are expanded |:set_env|.
5830 This option cannot be set from a |modeline| or in the |sandbox|, for
5831 security reasons.
5832
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005833 *'pyxversion'* *'pyx'*
5834'pyxversion' 'pyx' number (default depends on the build)
5835 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005836 {only available when compiled with the |+python| or
5837 the |+python3| feature}
5838 Specifies the python version used for pyx* functions and commands
5839 |python_x|. The default value is as follows:
5840
5841 Compiled with Default ~
5842 |+python| and |+python3| 0
5843 only |+python| 2
5844 only |+python3| 3
5845
5846 Available values are 0, 2 and 3.
5847 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5848 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5849 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5850 to 2 if Python 2 is available.
5851 See also: |has-pythonx|
5852
5853 If Vim is compiled with only |+python| or |+python3| setting
5854 'pyxversion' has no effect. The pyx* functions and commands are
5855 always the same as the compiled version.
5856
5857 This option cannot be set from a |modeline| or in the |sandbox|, for
5858 security reasons.
5859
Bram Moolenaar677ee682005-01-27 14:41:15 +00005860 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005861'quoteescape' 'qe' string (default "\")
5862 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005863 The characters that are used to escape quotes in a string. Used for
5864 objects like a', a" and a` |a'|.
5865 When one of the characters in this option is found inside a string,
5866 the following character will be skipped. The default value makes the
5867 text "foo\"bar\\" considered to be one string.
5868
Bram Moolenaar071d4272004-06-13 20:20:40 +00005869 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5870'readonly' 'ro' boolean (default off)
5871 local to buffer
5872 If on, writes fail unless you use a '!'. Protects you from
5873 accidentally overwriting a file. Default on when Vim is started
5874 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005875 When using ":w!" the 'readonly' option is reset for the current
5876 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005877 When using the ":view" command the 'readonly' option is set for the
5878 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005879 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005880
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005881 *'redrawtime'* *'rdt'*
5882'redrawtime' 'rdt' number (default 2000)
5883 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005884 {only available when compiled with the |+reltime|
5885 feature}
5886 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005887 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005888 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005889 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005890 matches will be highlighted.
5891 For syntax highlighting the time applies per window. When over the
5892 limit syntax highlighting is disabled until |CTRL-L| is used.
5893 This is used to avoid that Vim hangs when using a very complicated
5894 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005895
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005896 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005897'regexpengine' 're' number (default 0)
5898 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005899 This selects the default regexp engine. |two-engines|
5900 The possible values are:
5901 0 automatic selection
5902 1 old engine
5903 2 NFA engine
5904 Note that when using the NFA engine and the pattern contains something
5905 that is not supported the pattern will not match. This is only useful
5906 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005907 Using automatic selection enables Vim to switch the engine, if the
5908 default engine becomes too costly. E.g., when the NFA engine uses too
5909 many states. This should prevent Vim from hanging on a combination of
5910 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005911
Bram Moolenaar64486672010-05-16 15:46:46 +02005912 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5913'relativenumber' 'rnu' boolean (default off)
5914 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005915 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005916 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005917 precede some vertical motion commands (e.g. j k + -) with, without
5918 having to calculate it yourself. Especially useful in combination with
5919 other commands (e.g. y d c < > gq gw =).
5920 When the 'n' option is excluded from 'cpoptions' a wrapped
5921 line will not use the column of line numbers (this is the default when
5922 'compatible' isn't set).
5923 The 'numberwidth' option can be used to set the room used for the line
5924 number.
5925 When a long, wrapped line doesn't start with the first character, '-'
5926 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005927 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5928 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005929
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005930 The number in front of the cursor line also depends on the value of
5931 'number', see |number_relativenumber| for all combinations of the two
5932 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005933
Bram Moolenaar071d4272004-06-13 20:20:40 +00005934 *'remap'* *'noremap'*
5935'remap' boolean (default on)
5936 global
5937 Allows for mappings to work recursively. If you do not want this for
5938 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005939 NOTE: To avoid portability problems with Vim scripts, always keep
5940 this option at the default "on". Only switch it off when working with
5941 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005942
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005943 *'renderoptions'* *'rop'*
5944'renderoptions' 'rop' string (default: empty)
5945 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005946 {only available when compiled with GUI and DIRECTX on
5947 MS-Windows}
5948 Select a text renderer and set its options. The options depend on the
5949 renderer.
5950
5951 Syntax: >
5952 set rop=type:{renderer}(,{name}:{value})*
5953<
5954 Currently, only one optional renderer is available.
5955
5956 render behavior ~
5957 directx Vim will draw text using DirectX (DirectWrite). It makes
5958 drawn glyphs more beautiful than default GDI.
5959 It requires 'encoding' is "utf-8", and only works on
5960 MS-Windows Vista or newer version.
5961
5962 Options:
5963 name meaning type value ~
5964 gamma gamma float 1.0 - 2.2 (maybe)
5965 contrast enhancedContrast float (unknown)
5966 level clearTypeLevel float (unknown)
5967 geom pixelGeometry int 0 - 2 (see below)
5968 renmode renderingMode int 0 - 6 (see below)
5969 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005970 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005971
Bram Moolenaar92467d32017-12-05 13:22:16 +01005972 See this URL for detail (except for scrlines):
5973 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005974
5975 For geom: structure of a device pixel.
5976 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5977 1 - DWRITE_PIXEL_GEOMETRY_RGB
5978 2 - DWRITE_PIXEL_GEOMETRY_BGR
5979
5980 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005981 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005982
5983 For renmode: method of rendering glyphs.
5984 0 - DWRITE_RENDERING_MODE_DEFAULT
5985 1 - DWRITE_RENDERING_MODE_ALIASED
5986 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5987 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5988 4 - DWRITE_RENDERING_MODE_NATURAL
5989 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5990 6 - DWRITE_RENDERING_MODE_OUTLINE
5991
5992 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005993 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005994
5995 For taamode: antialiasing mode used for drawing text.
5996 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
5997 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
5998 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
5999 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6000
6001 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006002 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6003
Bram Moolenaara338adc2018-01-31 20:51:47 +01006004 For scrlines:
6005 This was used for optimizing scrolling behavior, however this
6006 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006007
6008 Example: >
6009 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006010 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006011 set rop=type:directx
6012<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006013 If select a raster font (Courier, Terminal or FixedSys which
6014 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006015 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006016
6017 NOTE: It is known that some fonts and options combination
6018 causes trouble on drawing glyphs.
6019
Bram Moolenaar92467d32017-12-05 13:22:16 +01006020 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006021 special made fonts (True-Type fonts which includes only
6022 bitmap glyphs).
6023 - 'taamode:3' will not work with some vector fonts.
6024
6025 NOTE: With this option, you can display colored emoji
6026 (emoticon) in Windows 8.1 or later. To display colored emoji,
6027 there are some conditions which you should notice.
6028
6029 - If your font includes non-colored emoji already, it will
6030 be used.
6031 - If your font doesn't have emoji, the system chooses an
6032 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6033 will be used.
6034 - When this alternative font didn't have fixed width glyph,
6035 emoji might be rendered beyond the bounding box of drawing
6036 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006037
6038 Other render types are currently not supported.
6039
Bram Moolenaar071d4272004-06-13 20:20:40 +00006040 *'report'*
6041'report' number (default 2)
6042 global
6043 Threshold for reporting number of lines changed. When the number of
6044 changed lines is more than 'report' a message will be given for most
6045 ":" commands. If you want it always, set 'report' to 0.
6046 For the ":substitute" command the number of substitutions is used
6047 instead of the number of lines.
6048
6049 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6050'restorescreen' 'rs' boolean (default on)
6051 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006052 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006053 When set, the screen contents is restored when exiting Vim. This also
6054 happens when executing external commands.
6055
6056 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6057 options in your .vimrc. To disable restoring:
6058 set t_ti= t_te=
6059 To enable restoring (for an xterm):
6060 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6061 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6062
6063 *'revins'* *'ri'* *'norevins'* *'nori'*
6064'revins' 'ri' boolean (default off)
6065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006066 {only available when compiled with the |+rightleft|
6067 feature}
6068 Inserting characters in Insert mode will work backwards. See "typing
6069 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6070 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006071 NOTE: This option is reset when 'compatible' is set.
6072 This option is reset when 'paste' is set and restored when 'paste' is
6073 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006074
6075 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6076'rightleft' 'rl' boolean (default off)
6077 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078 {only available when compiled with the |+rightleft|
6079 feature}
6080 When on, display orientation becomes right-to-left, i.e., characters
6081 that are stored in the file appear from the right to the left.
6082 Using this option, it is possible to edit files for languages that
6083 are written from the right to the left such as Hebrew and Arabic.
6084 This option is per window, so it is possible to edit mixed files
6085 simultaneously, or to view the same file in both ways (this is
6086 useful whenever you have a mixed text file with both right-to-left
6087 and left-to-right strings so that both sets are displayed properly
6088 in different windows). Also see |rileft.txt|.
6089
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006090 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006091'rightleftcmd' 'rlc' string (default "search")
6092 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006093 {only available when compiled with the |+rightleft|
6094 feature}
6095 Each word in this option enables the command line editing to work in
6096 right-to-left mode for a group of commands:
6097
6098 search "/" and "?" commands
6099
6100 This is useful for languages such as Hebrew, Arabic and Farsi.
6101 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6102
Bram Moolenaard94464e2015-11-02 15:28:18 +01006103 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006104'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006105 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006106 {only available when compiled with the |+ruby/dyn|
6107 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006108 Specifies the name of the Ruby shared library. The default is
6109 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006110 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006111 This option cannot be set from a |modeline| or in the |sandbox|, for
6112 security reasons.
6113
Bram Moolenaar071d4272004-06-13 20:20:40 +00006114 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006115'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006117 {not available when compiled without the
6118 |+cmdline_info| feature}
6119 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006120 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 text in the file is shown on the far right:
6122 Top first line is visible
6123 Bot last line is visible
6124 All first and last line are visible
6125 45% relative position in the file
6126 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006127 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006128 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006129 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006130 this option takes precedence over 'ruler' and 'rulerformat'
6131 If the number of characters displayed is different from the number of
6132 bytes in the text (e.g., for a TAB or a multi-byte character), both
6133 the text column (byte number) and the screen column are shown,
6134 separated with a dash.
6135 For an empty line "0-1" is shown.
6136 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006137 This option is reset when 'paste' is set and restored when 'paste' is
6138 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006139 If you don't want to see the ruler all the time but want to know where
6140 you are, use "g CTRL-G" |g_CTRL-G|.
6141 NOTE: This option is reset when 'compatible' is set.
6142
6143 *'rulerformat'* *'ruf'*
6144'rulerformat' 'ruf' string (default empty)
6145 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006146 {not available when compiled without the |+statusline|
6147 feature}
6148 When this option is not empty, it determines the content of the ruler
6149 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006150 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006151 This option cannot be set in a modeline when 'modelineexpr' is off.
6152
Bram Moolenaar071d4272004-06-13 20:20:40 +00006153 The default ruler width is 17 characters. To make the ruler 15
6154 characters wide, put "%15(" at the start and "%)" at the end.
6155 Example: >
6156 :set rulerformat=%15(%c%V\ %p%%%)
6157<
6158 *'runtimepath'* *'rtp'* *vimfiles*
6159'runtimepath' 'rtp' string (default:
6160 Unix: "$HOME/.vim,
6161 $VIM/vimfiles,
6162 $VIMRUNTIME,
6163 $VIM/vimfiles/after,
6164 $HOME/.vim/after"
6165 Amiga: "home:vimfiles,
6166 $VIM/vimfiles,
6167 $VIMRUNTIME,
6168 $VIM/vimfiles/after,
6169 home:vimfiles/after"
6170 PC, OS/2: "$HOME/vimfiles,
6171 $VIM/vimfiles,
6172 $VIMRUNTIME,
6173 $VIM/vimfiles/after,
6174 $HOME/vimfiles/after"
6175 Macintosh: "$VIM:vimfiles,
6176 $VIMRUNTIME,
6177 $VIM:vimfiles:after"
6178 RISC-OS: "Choices:vimfiles,
6179 $VIMRUNTIME,
6180 Choices:vimfiles/after"
6181 VMS: "sys$login:vimfiles,
6182 $VIM/vimfiles,
6183 $VIMRUNTIME,
6184 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006185 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006186 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006187 This is a list of directories which will be searched for runtime
6188 files:
6189 filetype.vim filetypes by file name |new-filetype|
6190 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006191 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006192 colors/ color scheme files |:colorscheme|
6193 compiler/ compiler files |:compiler|
6194 doc/ documentation |write-local-help|
6195 ftplugin/ filetype plugins |write-filetype-plugin|
6196 indent/ indent scripts |indent-expression|
6197 keymap/ key mapping files |mbyte-keymap|
6198 lang/ menu translations |:menutrans|
6199 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006200 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006201 plugin/ plugin scripts |write-plugin|
6202 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006203 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006204 syntax/ syntax files |mysyntaxfile|
6205 tutor/ files for vimtutor |tutor|
6206
6207 And any other file searched for with the |:runtime| command.
6208
6209 The defaults for most systems are setup to search five locations:
6210 1. In your home directory, for your personal preferences.
6211 2. In a system-wide Vim directory, for preferences from the system
6212 administrator.
6213 3. In $VIMRUNTIME, for files distributed with Vim.
6214 *after-directory*
6215 4. In the "after" directory in the system-wide Vim directory. This is
6216 for the system administrator to overrule or add to the distributed
6217 defaults (rarely needed)
6218 5. In the "after" directory in your home directory. This is for
6219 personal preferences to overrule or add to the distributed defaults
6220 or system-wide settings (rarely needed).
6221
Bram Moolenaard0796902016-09-16 20:02:31 +02006222 More entries are added when using |packages|. If it gets very long
6223 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6224 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006225
Bram Moolenaar071d4272004-06-13 20:20:40 +00006226 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6227 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006228 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006229 wildcards.
6230 See |:runtime|.
6231 Example: >
6232 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6233< This will use the directory "~/vimruntime" first (containing your
6234 personal Vim runtime files), then "/mygroup/vim" (shared between a
6235 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6236 files).
6237 You probably should always include $VIMRUNTIME somewhere, to use the
6238 distributed runtime files. You can put a directory before $VIMRUNTIME
6239 to find files which replace a distributed runtime files. You can put
6240 a directory after $VIMRUNTIME to find files which add to distributed
6241 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006242 When Vim is started with |--clean| the home directory entries are not
6243 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006244 This option cannot be set from a |modeline| or in the |sandbox|, for
6245 security reasons.
6246
6247 *'scroll'* *'scr'*
6248'scroll' 'scr' number (default: half the window height)
6249 local to window
6250 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6251 set to half the number of lines in the window when the window size
6252 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006253 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006254 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006255
6256 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6257'scrollbind' 'scb' boolean (default off)
6258 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259 See also |scroll-binding|. When this option is set, the current
6260 window scrolls as other scrollbind windows (windows that also have
6261 this option set) scroll. This option is useful for viewing the
6262 differences between two versions of a file, see 'diff'.
6263 See |'scrollopt'| for options that determine how this option should be
6264 interpreted.
6265 This option is mostly reset when splitting a window to edit another
6266 file. This means that ":split | edit file" results in two windows
6267 with scroll-binding, but ":split file" does not.
6268
6269 *'scrolljump'* *'sj'*
6270'scrolljump' 'sj' number (default 1)
6271 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006272 Minimal number of lines to scroll when the cursor gets off the
6273 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6274 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006275 When set to a negative number from -1 to -100 this is used as the
6276 percentage of the window height. Thus -50 scrolls half the window
6277 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006278 NOTE: This option is set to 1 when 'compatible' is set.
6279
6280 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006281'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006282 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006283 Minimal number of screen lines to keep above and below the cursor.
6284 This will make some context visible around where you are working. If
6285 you set it to a very large value (999) the cursor line will always be
6286 in the middle of the window (except at the start or end of the file or
6287 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006288 After using the local value, go back the global value with one of
6289 these two: >
6290 setlocal scrolloff<
6291 setlocal scrolloff=-1
6292< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006293 NOTE: This option is set to 0 when 'compatible' is set.
6294
6295 *'scrollopt'* *'sbo'*
6296'scrollopt' 'sbo' string (default "ver,jump")
6297 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006298 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006299 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6300 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006301 The following words are available:
6302 ver Bind vertical scrolling for 'scrollbind' windows
6303 hor Bind horizontal scrolling for 'scrollbind' windows
6304 jump Applies to the offset between two windows for vertical
6305 scrolling. This offset is the difference in the first
6306 displayed line of the bound windows. When moving
6307 around in a window, another 'scrollbind' window may
6308 reach a position before the start or after the end of
6309 the buffer. The offset is not changed though, when
6310 moving back the 'scrollbind' window will try to scroll
6311 to the desired position when possible.
6312 When now making that window the current one, two
6313 things can be done with the relative offset:
6314 1. When "jump" is not included, the relative offset is
6315 adjusted for the scroll position in the new current
6316 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006317 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006318 2. When "jump" is included, the other windows are
6319 scrolled to keep the same relative offset. When
6320 going back to the other window, it still uses the
6321 same relative offset.
6322 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006323 When 'diff' mode is active there always is vertical scroll binding,
6324 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006325
6326 *'sections'* *'sect'*
6327'sections' 'sect' string (default "SHNHH HUnhsh")
6328 global
6329 Specifies the nroff macros that separate sections. These are pairs of
6330 two letters (See |object-motions|). The default makes a section start
6331 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6332
6333 *'secure'* *'nosecure'* *E523*
6334'secure' boolean (default off)
6335 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006336 When on, ":autocmd", shell and write commands are not allowed in
6337 ".vimrc" and ".exrc" in the current directory and map commands are
6338 displayed. Switch it off only if you know that you will not run into
6339 problems, or when the 'exrc' option is off. On Unix this option is
6340 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006341 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006342 'secure' at the end of your ~/.vimrc then.
6343 This option cannot be set from a |modeline| or in the |sandbox|, for
6344 security reasons.
6345
6346 *'selection'* *'sel'*
6347'selection' 'sel' string (default "inclusive")
6348 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006349 This option defines the behavior of the selection. It is only used
6350 in Visual and Select mode.
6351 Possible values:
6352 value past line inclusive ~
6353 old no yes
6354 inclusive yes yes
6355 exclusive yes no
6356 "past line" means that the cursor is allowed to be positioned one
6357 character past the line.
6358 "inclusive" means that the last character of the selection is included
6359 in an operation. For example, when "x" is used to delete the
6360 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006361 When "old" is used and 'virtualedit' allows the cursor to move past
6362 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006363 Note that when "exclusive" is used and selecting from the end
6364 backwards, you cannot include the last character of a line, when
6365 starting in Normal mode and 'virtualedit' empty.
6366
6367 The 'selection' option is set by the |:behave| command.
6368
6369 *'selectmode'* *'slm'*
6370'selectmode' 'slm' string (default "")
6371 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006372 This is a comma separated list of words, which specifies when to start
6373 Select mode instead of Visual mode, when a selection is started.
6374 Possible values:
6375 mouse when using the mouse
6376 key when using shifted special keys
6377 cmd when using "v", "V" or CTRL-V
6378 See |Select-mode|.
6379 The 'selectmode' option is set by the |:behave| command.
6380
6381 *'sessionoptions'* *'ssop'*
6382'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006383 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006384 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006385 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006386 feature}
6387 Changes the effect of the |:mksession| command. It is a comma
6388 separated list of words. Each word enables saving and restoring
6389 something:
6390 word save and restore ~
6391 blank empty windows
6392 buffers hidden and unloaded buffers, not just those in windows
6393 curdir the current directory
6394 folds manually created folds, opened/closed folds and local
6395 fold options
6396 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006397 and contain at least one lowercase letter. Only
6398 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006399 help the help window
6400 localoptions options and mappings local to a window or buffer (not
6401 global values for local options)
6402 options all options and mappings (also global values for local
6403 options)
6404 resize size of the Vim window: 'lines' and 'columns'
6405 sesdir the directory in which the session file is located
6406 will become the current directory (useful with
6407 projects accessed over a network from different
6408 systems)
6409 slash backslashes in file names replaced with forward
6410 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006411 tabpages all tab pages; without this only the current tab page
6412 is restored, so that you can make a session for each
6413 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006414 terminal include terminal windows where the command can be
6415 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006416 unix with Unix end-of-line format (single <NL>), even when
6417 on Windows or DOS
6418 winpos position of the whole Vim window
6419 winsize window sizes
6420
6421 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006422 When neither "curdir" nor "sesdir" is included, file names are stored
6423 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006424 "slash" and "unix" are useful on Windows when sharing session files
6425 with Unix. The Unix version of Vim cannot source dos format scripts,
6426 but the Windows version of Vim can source unix format scripts.
6427
6428 *'shell'* *'sh'* *E91*
6429'shell' 'sh' string (default $SHELL or "sh",
6430 MS-DOS and Win32: "command.com" or
6431 "cmd.exe", OS/2: "cmd")
6432 global
6433 Name of the shell to use for ! and :! commands. When changing the
6434 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6435 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006436 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006437 See |option-backslash| about including spaces and backslashes.
6438 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006439
Bram Moolenaar071d4272004-06-13 20:20:40 +00006440 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006441 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006442 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6443< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006444 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006445 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006446 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006447 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006448 Example with escaped space (Vim will do this when initializing the
6449 option from $SHELL): >
6450 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006451< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006452 backslashes are consumed by `:set`.
6453
Bram Moolenaar071d4272004-06-13 20:20:40 +00006454 Under MS-Windows, when the executable ends in ".com" it must be
6455 included. Thus setting the shell to "command.com" or "4dos.com"
6456 works, but "command" and "4dos" do not work for all commands (e.g.,
6457 filtering).
6458 For unknown reasons, when using "4dos.com" the current directory is
6459 changed to "C:\". To avoid this set 'shell' like this: >
6460 :set shell=command.com\ /c\ 4dos
6461< This option cannot be set from a |modeline| or in the |sandbox|, for
6462 security reasons.
6463
6464 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006465'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006466 MS-DOS and Win32, when 'shell' does not
6467 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006468 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006469 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6470 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6471 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006472 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006473 On Unix it can have more than one flag. Each white space separated
6474 part is passed as an argument to the shell command.
6475 See |option-backslash| about including spaces and backslashes.
6476 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006477 This option cannot be set from a |modeline| or in the |sandbox|, for
6478 security reasons.
6479
6480 *'shellpipe'* *'sp'*
6481'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6482 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006483 {not available when compiled without the |+quickfix|
6484 feature}
6485 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006486 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 including spaces and backslashes.
6488 The name of the temporary file can be represented by "%s" if necessary
6489 (the file name is appended automatically if no %s appears in the value
6490 of this option).
6491 For the Amiga and MS-DOS the default is ">". The output is directly
6492 saved in a file and not echoed to the screen.
6493 For Unix the default it "| tee". The stdout of the compiler is saved
6494 in a file and echoed to the screen. If the 'shell' option is "csh" or
6495 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006496 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6497 default becomes "2>&1| tee". This means that stderr is also included.
6498 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6499 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006500 The initialization of this option is done after reading the ".vimrc"
6501 and the other initializations, so that when the 'shell' option is set
6502 there, the 'shellpipe' option changes automatically, unless it was
6503 explicitly set before.
6504 When 'shellpipe' is set to an empty string, no redirection of the
6505 ":make" output will be done. This is useful if you use a 'makeprg'
6506 that writes to 'makeef' by itself. If you want no piping, but do
6507 want to include the 'makeef', set 'shellpipe' to a single space.
6508 Don't forget to precede the space with a backslash: ":set sp=\ ".
6509 In the future pipes may be used for filtering and this option will
6510 become obsolete (at least for Unix).
6511 This option cannot be set from a |modeline| or in the |sandbox|, for
6512 security reasons.
6513
6514 *'shellquote'* *'shq'*
6515'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6516 contains "sh" somewhere: "\"")
6517 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006518 Quoting character(s), put around the command passed to the shell, for
6519 the "!" and ":!" commands. The redirection is kept outside of the
6520 quoting. See 'shellxquote' to include the redirection. It's
6521 probably not useful to set both options.
6522 This is an empty string by default. Only known to be useful for
6523 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6524 or bash, where it should be "\"". The default is adjusted according
6525 the value of 'shell', to reduce the need to set this option by the
6526 user. See |dos-shell|.
6527 This option cannot be set from a |modeline| or in the |sandbox|, for
6528 security reasons.
6529
6530 *'shellredir'* *'srr'*
6531'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6532 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006533 String to be used to put the output of a filter command in a temporary
6534 file. See also |:!|. See |option-backslash| about including spaces
6535 and backslashes.
6536 The name of the temporary file can be represented by "%s" if necessary
6537 (the file name is appended automatically if no %s appears in the value
6538 of this option).
6539 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6540 or "zsh" during initializations, the default becomes ">&". If the
6541 'shell' option is "sh", "ksh" or "bash" the default becomes
6542 ">%s 2>&1". This means that stderr is also included.
6543 For Win32, the Unix checks are done and additionally "cmd" is checked
6544 for, which makes the default ">%s 2>&1". Also, the same names with
6545 ".exe" appended are checked for.
6546 The initialization of this option is done after reading the ".vimrc"
6547 and the other initializations, so that when the 'shell' option is set
6548 there, the 'shellredir' option changes automatically unless it was
6549 explicitly set before.
6550 In the future pipes may be used for filtering and this option will
6551 become obsolete (at least for Unix).
6552 This option cannot be set from a |modeline| or in the |sandbox|, for
6553 security reasons.
6554
6555 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6556'shellslash' 'ssl' boolean (default off)
6557 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006558 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006559 When set, a forward slash is used when expanding file names. This is
6560 useful when a Unix-like shell is used instead of command.com or
6561 cmd.exe. Backward slashes can still be typed, but they are changed to
6562 forward slashes by Vim.
6563 Note that setting or resetting this option has no effect for some
6564 existing file names, thus this option needs to be set before opening
6565 any file for best results. This might change in the future.
6566 'shellslash' only works when a backslash can be used as a path
6567 separator. To test if this is so use: >
6568 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006569< Also see 'completeslash'.
6570
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006571 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6572'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6573 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006574 When on, use temp files for shell commands. When off use a pipe.
6575 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006576 Currently a pipe is only supported on Unix and MS-Windows 2K and
6577 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006578 :if has("filterpipe")
6579< The advantage of using a pipe is that nobody can read the temp file
6580 and the 'shell' command does not need to support redirection.
6581 The advantage of using a temp file is that the file type and encoding
6582 can be detected.
6583 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6584 |FilterWritePost| autocommands event are not triggered when
6585 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006586 The `system()` function does not respect this option and always uses
6587 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006588 NOTE: This option is set to the Vim default value when 'compatible'
6589 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006590
Bram Moolenaar071d4272004-06-13 20:20:40 +00006591 *'shelltype'* *'st'*
6592'shelltype' 'st' number (default 0)
6593 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006594 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 On the Amiga this option influences the way how the commands work
6596 which use a shell.
6597 0 and 1: always use the shell
6598 2 and 3: use the shell only to filter lines
6599 4 and 5: use shell only for ':sh' command
6600 When not using the shell, the command is executed directly.
6601
6602 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6603 1 and 3: use "shell cmd" to start external commands
6604
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006605 *'shellxescape'* *'sxe'*
6606'shellxescape' 'sxe' string (default: "";
6607 for MS-DOS and MS-Windows: "\"&|<>()@^")
6608 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006609 When 'shellxquote' is set to "(" then the characters listed in this
6610 option will be escaped with a '^' character. This makes it possible
6611 to execute most external commands with cmd.exe.
6612
Bram Moolenaar071d4272004-06-13 20:20:40 +00006613 *'shellxquote'* *'sxq'*
6614'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006615 for Win32, when 'shell' is cmd.exe: "("
6616 for Win32, when 'shell' contains "sh"
6617 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006618 for Unix, when using system(): "\"")
6619 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006620 Quoting character(s), put around the command passed to the shell, for
6621 the "!" and ":!" commands. Includes the redirection. See
6622 'shellquote' to exclude the redirection. It's probably not useful
6623 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006624 When the value is '(' then ')' is appended. When the value is '"('
6625 then ')"' is appended.
6626 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006627 This is an empty string by default on most systems, but is known to be
6628 useful for on Win32 version, either for cmd.exe which automatically
6629 strips off the first and last quote on a command, or 3rd-party shells
6630 such as the MKS Korn Shell or bash, where it should be "\"". The
6631 default is adjusted according the value of 'shell', to reduce the need
6632 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006633 This option cannot be set from a |modeline| or in the |sandbox|, for
6634 security reasons.
6635
6636 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6637'shiftround' 'sr' boolean (default off)
6638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006639 Round indent to multiple of 'shiftwidth'. Applies to > and <
6640 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6641 a multiple of 'shiftwidth' (this is Vi compatible).
6642 NOTE: This option is reset when 'compatible' is set.
6643
6644 *'shiftwidth'* *'sw'*
6645'shiftwidth' 'sw' number (default 8)
6646 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006647 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006648 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006649 When zero the 'ts' value will be used. Use the |shiftwidth()|
6650 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006651
6652 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006653'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6654 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006656 This option helps to avoid all the |hit-enter| prompts caused by file
6657 messages, for example with CTRL-G, and to avoid some other messages.
6658 It is a list of flags:
6659 flag meaning when present ~
6660 f use "(3 of 5)" instead of "(file 3 of 5)"
6661 i use "[noeol]" instead of "[Incomplete last line]"
6662 l use "999L, 888C" instead of "999 lines, 888 characters"
6663 m use "[+]" instead of "[Modified]"
6664 n use "[New]" instead of "[New File]"
6665 r use "[RO]" instead of "[readonly]"
6666 w use "[w]" instead of "written" for file write message
6667 and "[a]" instead of "appended" for ':w >> file' command
6668 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6669 "[unix format]" and "[mac]" instead of "[mac format]".
6670 a all of the above abbreviations
6671
6672 o overwrite message for writing a file with subsequent message
6673 for reading a file (useful for ":wn" or when 'autowrite' on)
6674 O message for reading a file overwrites any previous message.
6675 Also for quickfix message (e.g., ":cn").
6676 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006677 hit TOP, continuing at BOTTOM" messages; when using the search
6678 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006679 t truncate file message at the start if it is too long to fit
6680 on the command-line, "<" will appear in the left most column.
6681 Ignored in Ex mode.
6682 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006683 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006684 Ignored in Ex mode.
6685 W don't give "written" or "[w]" when writing a file
6686 A don't give the "ATTENTION" message when an existing swap file
6687 is found.
6688 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006689 c don't give |ins-completion-menu| messages. For example,
6690 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6691 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006692 q use "recording" instead of "recording @a"
6693 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006694 was used for the command; note that this also affects messages
6695 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006696 S do not show search count message when searching, e.g.
6697 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006698
6699 This gives you the opportunity to avoid that a change between buffers
6700 requires you to hit <Enter>, but still gives as useful a message as
6701 possible for the space available. To get the whole message that you
6702 would have got with 'shm' empty, use ":file!"
6703 Useful values:
6704 shm= No abbreviation of message.
6705 shm=a Abbreviation, but no loss of information.
6706 shm=at Abbreviation, and truncate message when necessary.
6707
6708 NOTE: This option is set to the Vi default value when 'compatible' is
6709 set and to the Vim default value when 'compatible' is reset.
6710
6711 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6712'shortname' 'sn' boolean (default off)
6713 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006714 Filenames are assumed to be 8 characters plus one extension of 3
6715 characters. Multiple dots in file names are not allowed. When this
6716 option is on, dots in file names are replaced with underscores when
6717 adding an extension (".~" or ".swp"). This option is not available
6718 for MS-DOS, because then it would always be on. This option is useful
6719 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6720 or crossdos. When running the Win32 GUI version under Win32s, this
6721 option is always on by default.
6722
6723 *'showbreak'* *'sbr'* *E595*
6724'showbreak' 'sbr' string (default "")
6725 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006726 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006727 feature}
6728 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006729 values are "> " or "+++ ": >
6730 :set showbreak=>\
6731< Note the backslash to escape the trailing space. It's easier like
6732 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006733 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006734< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006735 comma (in a future version the comma might be used to separate the
6736 part that is shown at the end and at the start of a line).
6737 The characters are highlighted according to the '@' flag in
6738 'highlight'.
6739 Note that tabs after the showbreak will be displayed differently.
6740 If you want the 'showbreak' to appear in between line numbers, add the
6741 "n" flag to 'cpoptions'.
6742
6743 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006744'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6745 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006747 {not available when compiled without the
6748 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006749 Show (partial) command in the last line of the screen. Set this
6750 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 In Visual mode the size of the selected area is shown:
6752 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006753 If the number of bytes is different it is also displayed: "2-6"
6754 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006756 - When selecting a block, the size in screen characters:
6757 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006758 NOTE: This option is set to the Vi default value when 'compatible' is
6759 set and to the Vim default value when 'compatible' is reset.
6760
6761 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6762'showfulltag' 'sft' boolean (default off)
6763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006764 When completing a word in insert mode (see |ins-completion|) from the
6765 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006766 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006767 matched a C function, you can see a template for what arguments are
6768 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006769 Note that this doesn't work well together with having "longest" in
6770 'completeopt', because the completion from the search pattern may not
6771 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006772
6773 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6774'showmatch' 'sm' boolean (default off)
6775 global
6776 When a bracket is inserted, briefly jump to the matching one. The
6777 jump is only done if the match can be seen on the screen. The time to
6778 show the match can be set with 'matchtime'.
6779 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006780 seen or not).
6781 This option is reset when 'paste' is set and restored when 'paste' is
6782 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006783 When the 'm' flag is not included in 'cpoptions', typing a character
6784 will immediately move the cursor back to where it belongs.
6785 See the "sm" field in 'guicursor' for setting the cursor shape and
6786 blinking when showing the match.
6787 The 'matchpairs' option can be used to specify the characters to show
6788 matches for. 'rightleft' and 'revins' are used to look for opposite
6789 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006790 Also see the matchparen plugin for highlighting the match when moving
6791 around |pi_paren.txt|.
6792 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006793
6794 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6795'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6796 global
6797 If in Insert, Replace or Visual mode put a message on the last line.
6798 Use the 'M' flag in 'highlight' to set the type of highlighting for
6799 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006800 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006801 doesn't mean XIM is really active, especially when 'imactivatekey' is
6802 not set.
6803 NOTE: This option is set to the Vi default value when 'compatible' is
6804 set and to the Vim default value when 'compatible' is reset.
6805
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006806 *'showtabline'* *'stal'*
6807'showtabline' 'stal' number (default 1)
6808 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006809 The value of this option specifies when the line with tab page labels
6810 will be displayed:
6811 0: never
6812 1: only if there are at least two tab pages
6813 2: always
6814 This is both for the GUI and non-GUI implementation of the tab pages
6815 line.
6816 See |tab-page| for more information about tab pages.
6817
Bram Moolenaar071d4272004-06-13 20:20:40 +00006818 *'sidescroll'* *'ss'*
6819'sidescroll' 'ss' number (default 0)
6820 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006821 The minimal number of columns to scroll horizontally. Used only when
6822 the 'wrap' option is off and the cursor is moved off of the screen.
6823 When it is zero the cursor will be put in the middle of the screen.
6824 When using a slow terminal set it to a large number or 0. When using
6825 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6826 commands.
6827
6828 *'sidescrolloff'* *'siso'*
6829'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006830 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006831 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006832 right of the cursor if 'nowrap' is set. Setting this option to a
6833 value greater than 0 while having |'sidescroll'| also at a non-zero
6834 value makes some context visible in the line you are scrolling in
6835 horizontally (except at beginning of the line). Setting this option
6836 to a large value (like 999) has the effect of keeping the cursor
6837 horizontally centered in the window, as long as one does not come too
6838 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006839 After using the local value, go back the global value with one of
6840 these two: >
6841 setlocal sidescrolloff<
6842 setlocal sidescrolloff=-1
6843< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006844
6845 Example: Try this together with 'sidescroll' and 'listchars' as
6846 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006847 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848
6849 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6850 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006851<
6852 *'signcolumn'* *'scl'*
6853'signcolumn' 'scl' string (default "auto")
6854 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006855 {not available when compiled without the |+signs|
6856 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006857 Whether or not to draw the signcolumn. Valid values are:
6858 "auto" only when there is a sign to display
6859 "no" never
6860 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006861 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006862 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006863
6864
6865 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6866'smartcase' 'scs' boolean (default off)
6867 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006868 Override the 'ignorecase' option if the search pattern contains upper
6869 case characters. Only used when the search pattern is typed and
6870 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006871 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6873 recalling the search pattern from history and hitting <Enter>.
6874 NOTE: This option is reset when 'compatible' is set.
6875
6876 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6877'smartindent' 'si' boolean (default off)
6878 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006879 {not available when compiled without the
6880 |+smartindent| feature}
6881 Do smart autoindenting when starting a new line. Works for C-like
6882 programs, but can also be used for other languages. 'cindent' does
6883 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006884 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006885 setting 'si' has no effect. 'indentexpr' is a more advanced
6886 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006887 Normally 'autoindent' should also be on when using 'smartindent'.
6888 An indent is automatically inserted:
6889 - After a line ending in '{'.
6890 - After a line starting with a keyword from 'cinwords'.
6891 - Before a line starting with '}' (only with the "O" command).
6892 When typing '}' as the first character in a new line, that line is
6893 given the same indent as the matching '{'.
6894 When typing '#' as the first character in a new line, the indent for
6895 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006896 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006897 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6898 When using the ">>" command, lines starting with '#' are not shifted
6899 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006900 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006901 This option is reset when 'paste' is set and restored when 'paste' is
6902 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006903
6904 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6905'smarttab' 'sta' boolean (default off)
6906 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006908 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6909 <BS> will delete a 'shiftwidth' worth of space at the start of the
6910 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006911 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006912 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6913 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006914 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006915 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006916 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006917 This option is reset when 'paste' is set and restored when 'paste' is
6918 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 NOTE: This option is reset when 'compatible' is set.
6920
6921 *'softtabstop'* *'sts'*
6922'softtabstop' 'sts' number (default 0)
6923 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006924 Number of spaces that a <Tab> counts for while performing editing
6925 operations, like inserting a <Tab> or using <BS>. It "feels" like
6926 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6927 used. This is useful to keep the 'ts' setting at its standard value
6928 of 8, while being able to edit like it is set to 'sts'. However,
6929 commands like "x" still work on the actual characters.
6930 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006931 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006932 'softtabstop' is set to 0 when the 'paste' option is set and restored
6933 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006934 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6935 spaces is minimized by using <Tab>s.
6936 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6937 set.
6938 NOTE: This option is set to 0 when 'compatible' is set.
6939
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006940 If Vim is compiled with the |+vartabs| feature then the value of
6941 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6942 anything other than an empty string.
6943
Bram Moolenaar217ad922005-03-20 22:37:15 +00006944 *'spell'* *'nospell'*
6945'spell' boolean (default off)
6946 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006947 {not available when compiled without the |+syntax|
6948 feature}
6949 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006950 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006951
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006952 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006953'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006954 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006955 {not available when compiled without the |+syntax|
6956 feature}
6957 Pattern to locate the end of a sentence. The following word will be
6958 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006959 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006960 When this check is not wanted make this option empty.
6961 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006962 Be careful with special characters, see |option-backslash| about
6963 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006964 To set this option automatically depending on the language, see
6965 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006966
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006967 *'spellfile'* *'spf'*
6968'spellfile' 'spf' string (default empty)
6969 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006970 {not available when compiled without the |+syntax|
6971 feature}
6972 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006973 commands. It must end in ".{encoding}.add". You need to include the
6974 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006975 *E765*
6976 It may also be a comma separated list of names. A count before the
6977 |zg| and |zw| commands can be used to access each. This allows using
6978 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006979 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006980 you: Using the first directory in 'runtimepath' that is writable. If
6981 there is no "spell" directory yet it will be created. For the file
6982 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006983 ignoring the region.
6984 The resulting ".spl" file will be used for spell checking, it does not
6985 have to appear in 'spelllang'.
6986 Normally one file is used for all regions, but you can add the region
6987 name if you want to. However, it will then only be used when
6988 'spellfile' is set to it, for entries in 'spelllang' only files
6989 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006990 This option cannot be set from a |modeline| or in the |sandbox|, for
6991 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006992
Bram Moolenaar217ad922005-03-20 22:37:15 +00006993 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006994'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006995 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00006996 {not available when compiled without the |+syntax|
6997 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00006998 A comma separated list of word list names. When the 'spell' option is
6999 on spellchecking will be done for these languages. Example: >
7000 set spelllang=en_us,nl,medical
7001< This means US English, Dutch and medical words are recognized. Words
7002 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007003 The word list name must consist of alphanumeric characters, a dash or
7004 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007005 recommended to separate the two letter language name from a
7006 specification. Thus "en-rare" is used for rare English words.
7007 A region name must come last and have the form "_xx", where "xx" is
7008 the two-letter, lower case region name. You can use more than one
7009 region by listing them: "en_us,en_ca" supports both US and Canadian
7010 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007011 Britain. (Note: currently en_au and en_nz dictionaries are older than
7012 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007013 If the name "cjk" is included East Asian characters are excluded from
7014 spell checking. This is useful when editing text that also has Asian
7015 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007016 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007017 As a special case the name of a .spl file can be given as-is. The
7018 first "_xx" in the name is removed and used as the region name
7019 (_xx is an underscore, two letters and followed by a non-letter).
7020 This is mainly for testing purposes. You must make sure the correct
7021 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007022 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007023 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7024 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007025 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007026
Bram Moolenaar98692072006-02-04 00:57:42 +00007027 If the |spellfile.vim| plugin is active and you use a language name
7028 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7029 will ask you if you want to download the file.
7030
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007031 After this option has been set successfully, Vim will source the files
7032 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007033 up to the first character that is not an ASCII letter or number and
7034 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007035
7036
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007037 *'spellsuggest'* *'sps'*
7038'spellsuggest' 'sps' string (default "best")
7039 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007040 {not available when compiled without the |+syntax|
7041 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007042 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007043 the |spellsuggest()| function. This is a comma-separated list of
7044 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007045
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007046 best Internal method that works best for English. Finds
7047 changes like "fast" and uses a bit of sound-a-like
7048 scoring to improve the ordering.
7049
7050 double Internal method that uses two methods and mixes the
7051 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007052 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007053 word. That only works when the language specifies
7054 sound folding. Can be slow and doesn't always give
7055 better results.
7056
7057 fast Internal method that only checks for simple changes:
7058 character inserts/deletes/swaps. Works well for
7059 simple typing mistakes.
7060
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007061 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007062 Not used for |spellsuggest()|. The number of
7063 suggestions is never more than the value of 'lines'
7064 minus two.
7065
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007066 file:{filename} Read file {filename}, which must have two columns,
7067 separated by a slash. The first column contains the
7068 bad word, the second column the suggested good word.
7069 Example:
7070 theribal/terrible ~
7071 Use this for common mistakes that do not appear at the
7072 top of the suggestion list with the internal methods.
7073 Lines without a slash are ignored, use this for
7074 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007075 The word in the second column must be correct,
7076 otherwise it will not be used. Add the word to an
7077 ".add" file if it is currently flagged as a spelling
7078 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007079 The file is used for all languages.
7080
7081 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7082 trouble with spaces. |v:val| holds the badly spelled
7083 word. The expression must evaluate to a List of
7084 Lists, each with a suggestion and a score.
7085 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007086 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007087 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007088 internal methods use. A lower score is better.
7089 This may invoke |spellsuggest()| if you temporarily
7090 set 'spellsuggest' to exclude the "expr:" part.
7091 Errors are silently ignored, unless you set the
7092 'verbose' option to a non-zero value.
7093
7094 Only one of "best", "double" or "fast" may be used. The others may
7095 appear several times in any order. Example: >
7096 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7097<
7098 This option cannot be set from a |modeline| or in the |sandbox|, for
7099 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007100
7101
Bram Moolenaar071d4272004-06-13 20:20:40 +00007102 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7103'splitbelow' 'sb' boolean (default off)
7104 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007105 When on, splitting a window will put the new window below the current
7106 one. |:split|
7107
7108 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7109'splitright' 'spr' boolean (default off)
7110 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007111 When on, splitting a window will put the new window right of the
7112 current one. |:vsplit|
7113
7114 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7115'startofline' 'sol' boolean (default on)
7116 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007117 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007118 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007119 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007120 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 with a linewise operator, with "%" with a count and to buffer changing
7122 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7123 only has a line number, e.g., ":25" or ":+".
7124 In case of buffer changing commands the cursor is placed at the column
7125 where it was the last time the buffer was edited.
7126 NOTE: This option is set when 'compatible' is set.
7127
Bram Moolenaar00654022011-02-25 14:42:19 +01007128 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007129'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007130 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007131 {not available when compiled without the |+statusline|
7132 feature}
7133 When nonempty, this option determines the content of the status line.
7134 Also see |status-line|.
7135
7136 The option consists of printf style '%' items interspersed with
7137 normal text. Each status line item is of the form:
7138 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007139 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007140 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007141
Bram Moolenaar238a5642006-02-21 22:12:05 +00007142 When the option starts with "%!" then it is used as an expression,
7143 evaluated and the result is used as the option value. Example: >
7144 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007145< The *g:statusline_winid* variable will be set to the |window-ID| of the
7146 window that the status line belongs to.
7147 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007148 Note that the "%!" expression is evaluated in the context of the
7149 current window and buffer, while %{} items are evaluated in the
7150 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007151
7152 When there is error while evaluating the option then it will be made
7153 empty to avoid further errors. Otherwise screen updating would loop.
7154
Bram Moolenaar071d4272004-06-13 20:20:40 +00007155 Note that the only effect of 'ruler' when this option is set (and
7156 'laststatus' is 2) is controlling the output of |CTRL-G|.
7157
7158 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007159 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007160 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007161 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007162 minwid Minimum width of the item, padding as set by '-' & '0'.
7163 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007164 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007165 on the left for text items. Numeric items will be
7166 shifted down to maxwid-2 digits followed by '>'number
7167 where number is the amount of missing digits, much like
7168 an exponential notation.
7169 item A one letter code as described below.
7170
7171 Following is a description of the possible statusline items. The
7172 second character in "item" is the type:
7173 N for number
7174 S for string
7175 F for flags as described below
7176 - not applicable
7177
7178 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007179 f S Path to the file in the buffer, as typed or relative to current
7180 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007181 F S Full path to the file in the buffer.
7182 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007183 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007184 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007185 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007186 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007187 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007189 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007191 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007193 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7195 being used: "<keymap>"
7196 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007197 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 B N As above, in hexadecimal.
7199 o N Byte number in file of byte under cursor, first byte is 1.
7200 Mnemonic: Offset from start of file (with one added)
7201 {not available when compiled without |+byte_offset| feature}
7202 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007203 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007204 l N Line number.
7205 L N Number of lines in buffer.
7206 c N Column number.
7207 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007208 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007209 p N Percentage through file in lines as in |CTRL-G|.
7210 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007211 percentage described for 'ruler'. Always 3 in length, unless
7212 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007213 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007214 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007215 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007216 Note that there is no '%' before the closing '}'. The
7217 expression cannot contain a '}' character, call a function to
7218 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007219 ( - Start of item group. Can be used for setting the width and
7220 alignment of a section. Must be followed by %) somewhere.
7221 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007222 T N For 'tabline': start of tab page N label. Use %T after the last
7223 label. This information is used for mouse clicks.
7224 X N For 'tabline': start of close tab N label. Use %X after the
7225 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7226 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007227 < - Where to truncate line if too long. Default is at the start.
7228 No width fields allowed.
7229 = - Separation point between left and right aligned items.
7230 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007231 # - Set highlight group. The name must follow and then a # again.
7232 Thus use %#HLname# for highlight group HLname. The same
7233 highlighting is used, also for the statusline of non-current
7234 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007235 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007236 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007237 The difference between User{N} and StatusLine will be applied
7238 to StatusLineNC for the statusline of non-current windows.
7239 The number N must be between 1 and 9. See |hl-User1..9|
7240
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007241 When displaying a flag, Vim removes the leading comma, if any, when
7242 that flag comes right after plaintext. This will make a nice display
7243 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007244
Bram Moolenaar582fd852005-03-28 20:58:01 +00007245 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007246 not set) and a minwid is not set for the group, the whole group will
7247 become empty. This will make a group like the following disappear
7248 completely from the statusline when none of the flags are set. >
7249 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007250< Beware that an expression is evaluated each and every time the status
7251 line is displayed.
7252 *g:actual_curbuf* *g:actual_curwin*
7253 The current buffer and current window will be set temporarily to that
7254 of the window (and buffer) whose statusline is currently being drawn.
7255 The expression will evaluate in this context. The variable
7256 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7257 buffer and "g:actual_curwin" to the |window-ID| of the real current
7258 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007259
Bram Moolenaar30b65812012-07-12 22:01:11 +02007260 The 'statusline' option will be evaluated in the |sandbox| if set from
7261 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007262 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007263
7264 It is not allowed to change text or jump to another window while
7265 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007266
7267 If the statusline is not updated when you want it (e.g., after setting
7268 a variable that's used in an expression), you can force an update by
7269 setting an option without changing its value. Example: >
7270 :let &ro = &ro
7271
7272< A result of all digits is regarded a number for display purposes.
7273 Otherwise the result is taken as flag text and applied to the rules
7274 described above.
7275
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007276 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007277 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007278 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007279
7280 Examples:
7281 Emulate standard status line with 'ruler' set >
7282 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7283< Similar, but add ASCII value of char under the cursor (like "ga") >
7284 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7285< Display byte count and byte value, modified flag in red. >
7286 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7287 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7288< Display a ,GZ flag if a compressed file is loaded >
7289 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7290< In the |:autocmd|'s: >
7291 :let b:gzflag = 1
7292< And: >
7293 :unlet b:gzflag
7294< And define this function: >
7295 :function VarExists(var, val)
7296 : if exists(a:var) | return a:val | else | return '' | endif
7297 :endfunction
7298<
7299 *'suffixes'* *'su'*
7300'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007302 Files with these suffixes get a lower priority when multiple files
7303 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007304 suffixes. Spaces after the comma are ignored. A dot is also seen as
7305 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 separator, precede it with a backslash (see |option-backslash| about
7307 including spaces and backslashes).
7308 See 'wildignore' for completely ignoring files.
7309 The use of |:set+=| and |:set-=| is preferred when adding or removing
7310 suffixes from the list. This avoids problems when a future version
7311 uses another default.
7312
7313 *'suffixesadd'* *'sua'*
7314'suffixesadd' 'sua' string (default "")
7315 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007316 {not available when compiled without the
7317 |+file_in_path| feature}
7318 Comma separated list of suffixes, which are used when searching for a
7319 file for the "gf", "[I", etc. commands. Example: >
7320 :set suffixesadd=.java
7321<
7322 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7323'swapfile' 'swf' boolean (default on)
7324 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007325 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007326 swapfile is not wanted for a specific buffer. For example, with
7327 confidential information that even root must not be able to access.
7328 Careful: All text will be in memory:
7329 - Don't use this for big files.
7330 - Recovery will be impossible!
7331 A swapfile will only be present when |'updatecount'| is non-zero and
7332 'swapfile' is set.
7333 When 'swapfile' is reset, the swap file for the current buffer is
7334 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7335 non-zero, a swap file is immediately created.
7336 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007337 If you want to open a new buffer without creating a swap file for it,
7338 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007339 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007340
7341 This option is used together with 'bufhidden' and 'buftype' to
7342 specify special kinds of buffers. See |special-buffers|.
7343
7344 *'swapsync'* *'sws'*
7345'swapsync' 'sws' string (default "fsync")
7346 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007347 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007348 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007349 When this option is empty parts of the swap file may be in memory and
7350 not written to disk. When the system crashes you may lose more work.
7351 On Unix the system does a sync now and then without Vim asking for it,
7352 so the disadvantage of setting this option off is small. On some
7353 systems the swap file will not be written at all. For a unix system
7354 setting it to "sync" will use the sync() call instead of the default
7355 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007356 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007357
7358 *'switchbuf'* *'swb'*
7359'switchbuf' 'swb' string (default "")
7360 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361 This option controls the behavior when switching between buffers.
7362 Possible values (comma separated list):
7363 useopen If included, jump to the first open window that
7364 contains the specified buffer (if there is one).
7365 Otherwise: Do not examine other windows.
7366 This setting is checked with |quickfix| commands, when
7367 jumping to errors (":cc", ":cn", "cp", etc.). It is
7368 also used in all buffer related split commands, for
7369 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007370 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007371 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007372 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007373 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007374 Otherwise: do not split, use current window (when used
7375 in the quickfix window: the previously used window or
7376 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007377 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007378 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007379 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007380
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007381 *'synmaxcol'* *'smc'*
7382'synmaxcol' 'smc' number (default 3000)
7383 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007384 {not available when compiled without the |+syntax|
7385 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007386 Maximum column in which to search for syntax items. In long lines the
7387 text after this column is not highlighted and following lines may not
7388 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007389 This helps to avoid very slow redrawing for an XML file that is one
7390 long line.
7391 Set to zero to remove the limit.
7392
Bram Moolenaar071d4272004-06-13 20:20:40 +00007393 *'syntax'* *'syn'*
7394'syntax' 'syn' string (default empty)
7395 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007396 {not available when compiled without the |+syntax|
7397 feature}
7398 When this option is set, the syntax with this name is loaded, unless
7399 syntax highlighting has been switched off with ":syntax off".
7400 Otherwise this option does not always reflect the current syntax (the
7401 b:current_syntax variable does).
7402 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007403 not automatically recognized. Example, in an IDL file:
7404 /* vim: set syntax=idl : */ ~
7405 When a dot appears in the value then this separates two filetype
7406 names. Example:
7407 /* vim: set syntax=c.doxygen : */ ~
7408 This will use the "c" syntax first, then the "doxygen" syntax.
7409 Note that the second one must be prepared to be loaded as an addition,
7410 otherwise it will be skipped. More than one dot may appear.
7411 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007412 :set syntax=OFF
7413< To switch syntax highlighting on according to the current value of the
7414 'filetype' option: >
7415 :set syntax=ON
7416< What actually happens when setting the 'syntax' option is that the
7417 Syntax autocommand event is triggered with the value as argument.
7418 This option is not copied to another buffer, independent of the 's' or
7419 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007420 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007421
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007422 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007423'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007424 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007425 When nonempty, this option determines the content of the tab pages
7426 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007427 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007428
7429 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007430 option and only when there is no GUI tab line. When 'e' is in
7431 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007432 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007433
7434 The value is evaluated like with 'statusline'. You can use
7435 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007436 the text to be displayed. Use "%1T" for the first label, "%2T" for
7437 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007438
Bram Moolenaare12bab32019-01-08 22:02:56 +01007439 When changing something that is used in 'tabline' that does not
7440 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007441 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007442
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007443 Keep in mind that only one of the tab pages is the current one, others
7444 are invisible and you can't jump to their windows.
7445
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007446
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007447 *'tabpagemax'* *'tpm'*
7448'tabpagemax' 'tpm' number (default 10)
7449 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007450 Maximum number of tab pages to be opened by the |-p| command line
7451 argument or the ":tab all" command. |tabpage|
7452
7453
7454 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007455'tabstop' 'ts' number (default 8)
7456 local to buffer
7457 Number of spaces that a <Tab> in the file counts for. Also see
7458 |:retab| command, and 'softtabstop' option.
7459
7460 Note: Setting 'tabstop' to any other value than 8 can make your file
7461 appear wrong in many places (e.g., when printing it).
7462
7463 There are four main ways to use tabs in Vim:
7464 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7465 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007466 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007467 behave like a tab appears every 4 (or 3) characters.
7468 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7469 'expandtab'. This way you will always insert spaces. The
7470 formatting will never be messed up when 'tabstop' is changed.
7471 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007472 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007473 works when using Vim to edit the file.
7474 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7475 'noexpandtab'. This should then work (for initial indents only)
7476 for any tabstop setting that people use. It might be nice to have
7477 tabs after the first non-blank inserted as spaces if you do this
7478 though. Otherwise aligned comments will be wrong when 'tabstop' is
7479 changed.
7480
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007481 If Vim is compiled with the |+vartabs| feature then the value of
7482 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7483 than an empty string.
7484
Bram Moolenaar071d4272004-06-13 20:20:40 +00007485 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7486'tagbsearch' 'tbs' boolean (default on)
7487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007488 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007489 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007490 searching makes searching for a tag a LOT faster, but a linear search
7491 will find more tags if the tags file wasn't properly sorted.
7492 Vim normally assumes that your tags files are sorted, or indicate that
7493 they are not sorted. Only when this is not the case does the
7494 'tagbsearch' option need to be switched off.
7495
7496 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007497 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007498 certain files, or retry all files with a linear search. When
7499 'tagbsearch' is off, only a linear search is done.
7500
7501 Linear searching is done anyway, for one file, when Vim finds a line
7502 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007503 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007504< [The whitespace before and after the '0' must be a single <Tab>]
7505
7506 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007507 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508 instead of a normal tag name, a retry is done with a linear search.
7509 Tags in unsorted tags files, and matches with different case will only
7510 be found in the retry.
7511
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007512 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007513 linear search can be avoided when case is ignored. Use a value of '2'
7514 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7515 sorted with the -f switch to "sort" in most unices, as in the command:
7516 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7517 (at least 5.5) the --sort=foldcase switch can be used for this as
7518 well. Note that case must be folded to uppercase for this to work.
7519
7520 By default, tag searches are case-sensitive. Case is ignored when
7521 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7522 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007523 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7524 'tagcase' is "smart", and the pattern contains only lowercase
7525 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007526
7527 When 'tagbsearch' is off, tags searching is slower when a full match
7528 exists, but faster when no full match exists. Tags in unsorted tags
7529 files may only be found with 'tagbsearch' off.
7530 When the tags file is not sorted, or sorted in a wrong way (not on
7531 ASCII byte value), 'tagbsearch' should be off, or the line given above
7532 must be included in the tags file.
7533 This option doesn't affect commands that find all matching tags (e.g.,
7534 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007535
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007536 *'tagcase'* *'tc'*
7537'tagcase' 'tc' string (default "followic")
7538 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007539 This option specifies how case is handled when searching the tags
7540 file:
7541 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007542 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007543 ignore Ignore case
7544 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007545 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007546 NOTE: This option is set to the Vi default value when 'compatible' is
7547 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007548
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007549 *'tagfunc'* *'tfu'*
7550'tagfunc' 'tfu' string (default: empty)
7551 local to buffer
7552 {not available when compiled without the |+eval|
7553 feature}
7554 This option specifies a function to be used to perform tag searches.
7555 The function gets the tag pattern and should return a List of matching
7556 tags. See |tag-function| for an explanation of how to write the
7557 function and an example.
7558
Bram Moolenaar071d4272004-06-13 20:20:40 +00007559 *'taglength'* *'tl'*
7560'taglength' 'tl' number (default 0)
7561 global
7562 If non-zero, tags are significant up to this number of characters.
7563
7564 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7565'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7566 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007567 If on and using a tags file in another directory, file names in that
7568 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007569 NOTE: This option is set to the Vi default value when 'compatible' is
7570 set and to the Vim default value when 'compatible' is reset.
7571
7572 *'tags'* *'tag'* *E433*
7573'tags' 'tag' string (default "./tags,tags", when compiled with
7574 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7575 global or local to buffer |global-local|
7576 Filenames for the tag command, separated by spaces or commas. To
7577 include a space or comma in a file name, precede it with a backslash
7578 (see |option-backslash| about including spaces and backslashes).
7579 When a file name starts with "./", the '.' is replaced with the path
7580 of the current file. But only when the 'd' flag is not included in
7581 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7582 |tags-option|.
7583 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007584 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7585 find all files named "tags" below "/lib". The filename itself cannot
7586 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7587 files called "tags?". {not available when compiled without the
7588 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007589 The |tagfiles()| function can be used to get a list of the file names
7590 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007591 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7592 files are also supported. They are automatically recognized. The
7593 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7594 differences are ignored (MS-Windows). |emacs-tags|
7595 The use of |:set+=| and |:set-=| is preferred when adding or removing
7596 file names from the list. This avoids problems when a future version
7597 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007598
7599 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7600'tagstack' 'tgst' boolean (default on)
7601 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602 When on, the |tagstack| is used normally. When off, a ":tag" or
7603 ":tselect" command with an argument will not push the tag onto the
7604 tagstack. A following ":tag" without an argument, a ":pop" command or
7605 any other command that uses the tagstack will use the unmodified
7606 tagstack, but does change the pointer to the active entry.
7607 Resetting this option is useful when using a ":tag" command in a
7608 mapping which should not change the tagstack.
7609
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007610 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007611'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007612 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007613 {only available when compiled with the |+tcl/dyn|
7614 feature}
7615 Specifies the name of the Tcl shared library. The default is
7616 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007617 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007618 This option cannot be set from a |modeline| or in the |sandbox|, for
7619 security reasons.
7620
Bram Moolenaar071d4272004-06-13 20:20:40 +00007621 *'term'* *E529* *E530* *E531*
7622'term' string (default is $TERM, if that fails:
7623 in the GUI: "builtin_gui"
7624 on Amiga: "amiga"
7625 on BeOS: "beos-ansi"
7626 on Mac: "mac-ansi"
7627 on MiNT: "vt52"
7628 on MS-DOS: "pcterm"
7629 on OS/2: "os2ansi"
7630 on Unix: "ansi"
7631 on VMS: "ansi"
7632 on Win 32: "win32")
7633 global
7634 Name of the terminal. Used for choosing the terminal control
7635 characters. Environment variables are expanded |:set_env|.
7636 For example: >
7637 :set term=$TERM
7638< See |termcap|.
7639
7640 *'termbidi'* *'tbidi'*
7641 *'notermbidi'* *'notbidi'*
7642'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7643 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007644 {only available when compiled with the |+arabic|
7645 feature}
7646 The terminal is in charge of Bi-directionality of text (as specified
7647 by Unicode). The terminal is also expected to do the required shaping
7648 that some languages (such as Arabic) require.
7649 Setting this option implies that 'rightleft' will not be set when
7650 'arabic' is set and the value of 'arabicshape' will be ignored.
7651 Note that setting 'termbidi' has the immediate effect that
7652 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7653 This option is reset when the GUI is started.
7654 For further details see |arabic.txt|.
7655
7656 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007657'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007658 Macintosh GUI: "macroman")
7659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007660 Encoding used for the terminal. This specifies what character
7661 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007662 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007663 display). Except for the Mac when 'macatsui' is off, then
7664 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007665 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007666 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007667 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7668 Any attempts to set a different value will be rejected, and an error
7669 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007670 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 because the Win32 system always passes Unicode characters.
7672 When empty, the same encoding is used as for the 'encoding' option.
7673 This is the normal value.
7674 Not all combinations for 'termencoding' and 'encoding' are valid. See
7675 |encoding-table|.
7676 The value for this option must be supported by internal conversions or
7677 iconv(). When this is not possible no conversion will be done and you
7678 will probably experience problems with non-ASCII characters.
7679 Example: You are working with the locale set to euc-jp (Japanese) and
7680 want to edit a UTF-8 file: >
7681 :let &termencoding = &encoding
7682 :set encoding=utf-8
7683< You need to do this when your system has no locale support for UTF-8.
7684
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007685 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007686'termguicolors' 'tgc' boolean (default off)
7687 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007688 {not available when compiled without the
7689 |+termguicolors| feature}
7690 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007691 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007692
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007693 Requires a ISO-8613-3 compatible terminal. If setting this option
7694 does not work (produces a colorless UI) reading |xterm-true-color|
7695 might help.
7696
7697 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7698 is required. Use this check to find out: >
7699 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007700< This requires Vim to be built with the |+vtp| feature.
7701
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007702 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007703 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007704
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007705 *'termwinkey'* *'twk'*
7706'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007707 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007708 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007709 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007710 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007711 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007712< The string must be one key stroke but can be multiple bytes.
7713 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007714 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007715 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007716
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007717 *'termwinscroll'* *'twsl'*
7718'termwinscroll' 'twsl' number (default 10000)
7719 local to buffer
7720 {not available when compiled without the
7721 |+terminal| feature}
7722 Number of scrollback lines to keep. When going over this limit the
7723 first 10% of the scrollback lines are deleted. This is just to reduce
7724 the memory usage. See |Terminal-Normal|.
7725
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007726 *'termwinsize'* *'tws'*
7727'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007728 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007729 Size of the |terminal| window. Format: {rows}x{columns} or
7730 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007731 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007732 - When set with a "x" (e.g., "24x80") the terminal size is not
7733 adjusted to the window size. If the window is smaller only the
7734 top-left part is displayed.
7735 - When set with a "*" (e.g., "10*50") the terminal size follows the
7736 window size, but will not be smaller than the specified rows and/or
7737 columns.
7738 - When rows is zero then use the height of the window.
7739 - When columns is zero then use the width of the window.
7740 - Using "0x0" or "0*0" is the same as empty.
7741
7742 Examples:
7743 "30x0" uses 30 rows and the current window width.
7744 "20*0" uses at least 20 rows and the current window width.
7745 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007746 Note that the command running in the terminal window may still change
7747 the size of the terminal. In that case the Vim window will be
7748 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007749
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007750 *'termwintype'* *'twt'*
7751'termwintype' 'twt' string (default "")
7752 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007753 {only available when compiled with the |terminal|
7754 feature on MS-Windows}
7755 Specify the virtual console (pty) used when opening the terminal
7756 window.
7757
7758 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007759 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007760 "winpty" use winpty, fail if not supported
7761 "conpty" use |ConPTY|, fail if not supported
7762
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007763 |ConPTY| support depends on the platform. Windows 10 October 2018
7764 Update is the first version that supports ConPTY, however it is still
7765 considered unstable. ConPTY might become stable in the next release
7766 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007767 supported then you cannot open a terminal window.
7768
Bram Moolenaar071d4272004-06-13 20:20:40 +00007769 *'terse'* *'noterse'*
7770'terse' boolean (default off)
7771 global
7772 When set: Add 's' flag to 'shortmess' option (this makes the message
7773 for a search that hits the start or end of the file not being
7774 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7775 shortens a lot of messages}
7776
7777 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7778'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7779 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007780 This option is obsolete. Use 'fileformats'.
7781 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7782 set to the default value for the current system. When 'textauto' is
7783 reset, 'fileformats' is made empty.
7784 NOTE: This option is set to the Vi default value when 'compatible' is
7785 set and to the Vim default value when 'compatible' is reset.
7786
7787 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7788'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7789 others: default off)
7790 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007791 This option is obsolete. Use 'fileformat'.
7792 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7793 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7794 "unix".
7795
7796 *'textwidth'* *'tw'*
7797'textwidth' 'tw' number (default 0)
7798 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007799 Maximum width of text that is being inserted. A longer line will be
7800 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007801 this.
7802 'textwidth' is set to 0 when the 'paste' option is set and restored
7803 when 'paste' is reset.
7804 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007805 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007806 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007807 NOTE: This option is set to 0 when 'compatible' is set.
7808
7809 *'thesaurus'* *'tsr'*
7810'thesaurus' 'tsr' string (default "")
7811 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007812 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007813 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7814
7815 Each line in the file should contain words with similar meaning,
7816 separated by non-keyword characters (white space is preferred).
7817 Maximum line length is 510 bytes.
7818
Bram Moolenaard47d5222018-12-09 20:43:55 +01007819 An English word list was added to this github issue:
7820 https://github.com/vim/vim/issues/629#issuecomment-443293282
7821 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7822 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7823 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007824
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007825 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007826 after a comma are ignored, otherwise spaces are included in the file
7827 name. See |option-backslash| about using backslashes.
7828 The use of |:set+=| and |:set-=| is preferred when adding or removing
7829 directories from the list. This avoids problems when a future version
7830 uses another default.
7831 Backticks cannot be used in this option for security reasons.
7832
7833 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7834'tildeop' 'top' boolean (default off)
7835 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007836 When on: The tilde command "~" behaves like an operator.
7837 NOTE: This option is reset when 'compatible' is set.
7838
7839 *'timeout'* *'to'* *'notimeout'* *'noto'*
7840'timeout' 'to' boolean (default on)
7841 global
7842 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007843'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007844 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007845 These two options together determine the behavior when part of a
7846 mapped key sequence or keyboard code has been received:
7847
7848 'timeout' 'ttimeout' action ~
7849 off off do not time out
7850 on on or off time out on :mappings and key codes
7851 off on time out on key codes
7852
7853 If both options are off, Vim will wait until either the complete
7854 mapping or key sequence has been received, or it is clear that there
7855 is no mapping or key sequence for the received characters. For
7856 example: if you have mapped "vl" and Vim has received 'v', the next
7857 character is needed to see if the 'v' is followed by an 'l'.
7858 When one of the options is on, Vim will wait for about 1 second for
7859 the next character to arrive. After that the already received
7860 characters are interpreted as single characters. The waiting time can
7861 be changed with the 'timeoutlen' option.
7862 On slow terminals or very busy systems timing out may cause
7863 malfunctioning cursor keys. If both options are off, Vim waits
7864 forever after an entered <Esc> if there are key codes that start
7865 with <Esc>. You will have to type <Esc> twice. If you do not have
7866 problems with key codes, but would like to have :mapped key
7867 sequences not timing out in 1 second, set the 'ttimeout' option and
7868 reset the 'timeout' option.
7869
7870 NOTE: 'ttimeout' is reset when 'compatible' is set.
7871
7872 *'timeoutlen'* *'tm'*
7873'timeoutlen' 'tm' number (default 1000)
7874 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007875
Bram Moolenaar071d4272004-06-13 20:20:40 +00007876 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007877'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007878 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007879 The time in milliseconds that is waited for a key code or mapped key
7880 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7881 when part of a command has been typed.
7882 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7883 different timeout value for key codes is desired set 'ttimeoutlen' to
7884 a non-negative number.
7885
7886 ttimeoutlen mapping delay key code delay ~
7887 < 0 'timeoutlen' 'timeoutlen'
7888 >= 0 'timeoutlen' 'ttimeoutlen'
7889
7890 The timeout only happens when the 'timeout' and 'ttimeout' options
7891 tell so. A useful setting would be >
7892 :set timeout timeoutlen=3000 ttimeoutlen=100
7893< (time out on mapping after three seconds, time out on key codes after
7894 a tenth of a second).
7895
7896 *'title'* *'notitle'*
7897'title' boolean (default off, on when title can be restored)
7898 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007899 {not available when compiled without the |+title|
7900 feature}
7901 When on, the title of the window will be set to the value of
7902 'titlestring' (if it is not empty), or to:
7903 filename [+=-] (path) - VIM
7904 Where:
7905 filename the name of the file being edited
7906 - indicates the file cannot be modified, 'ma' off
7907 + indicates the file was modified
7908 = indicates the file is read-only
7909 =+ indicates the file is read-only and modified
7910 (path) is the path of the file being edited
7911 - VIM the server name |v:servername| or "VIM"
7912 Only works if the terminal supports setting window titles
7913 (currently Amiga console, Win32 console, all GUI versions and
7914 terminals with a non- empty 't_ts' option - these are Unix xterm and
7915 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7916 *X11*
7917 When Vim was compiled with HAVE_X11 defined, the original title will
7918 be restored if possible. The output of ":version" will include "+X11"
7919 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7920 works for the icon name |'icon'|.
7921 But: When Vim was started with the |-X| argument, restoring the title
7922 will not work (except in the GUI).
7923 If the title cannot be restored, it is set to the value of 'titleold'.
7924 You might want to restore the title outside of Vim then.
7925 When using an xterm from a remote machine you can use this command:
7926 rsh machine_name xterm -display $DISPLAY &
7927 then the WINDOWID environment variable should be inherited and the
7928 title of the window should change back to what it should be after
7929 exiting Vim.
7930
7931 *'titlelen'*
7932'titlelen' number (default 85)
7933 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007934 {not available when compiled without the |+title|
7935 feature}
7936 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007937 title. When the title is longer, only the end of the path name is
7938 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007939 Using a percentage makes this adapt to the width of the window. But
7940 it won't work perfectly, because the actual number of characters
7941 available also depends on the font used and other things in the title
7942 bar. When 'titlelen' is zero the full path is used. Otherwise,
7943 values from 1 to 30000 percent can be used.
7944 'titlelen' is also used for the 'titlestring' option.
7945
7946 *'titleold'*
7947'titleold' string (default "Thanks for flying Vim")
7948 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007949 {only available when compiled with the |+title|
7950 feature}
7951 This option will be used for the window title when exiting Vim if the
7952 original title cannot be restored. Only happens if 'title' is on or
7953 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007954 This option cannot be set from a |modeline| or in the |sandbox|, for
7955 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007956 *'titlestring'*
7957'titlestring' string (default "")
7958 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007959 {not available when compiled without the |+title|
7960 feature}
7961 When this option is not empty, it will be used for the title of the
7962 window. This happens only when the 'title' option is on.
7963 Only works if the terminal supports setting window titles (currently
7964 Amiga console, Win32 console, all GUI versions and terminals with a
7965 non-empty 't_ts' option).
7966 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007967 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007968
Bram Moolenaar071d4272004-06-13 20:20:40 +00007969 When this option contains printf-style '%' items, they will be
7970 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007971 This option cannot be set in a modeline when 'modelineexpr' is off.
7972
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 Example: >
7974 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7975 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7976< The value of 'titlelen' is used to align items in the middle or right
7977 of the available space.
7978 Some people prefer to have the file name first: >
7979 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7980< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007981 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007982 separating space only when needed.
7983 NOTE: Use of special characters in 'titlestring' may cause the display
7984 to be garbled (e.g., when it contains a CR or NL character).
7985 {not available when compiled without the |+statusline| feature}
7986
7987 *'toolbar'* *'tb'*
7988'toolbar' 'tb' string (default "icons,tooltips")
7989 global
7990 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7991 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007992 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007993 possible values are:
7994 icons Toolbar buttons are shown with icons.
7995 text Toolbar buttons shown with text.
7996 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007997 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00007998 tooltips Tooltips are active for toolbar buttons.
7999 Tooltips refer to the popup help text which appears after the mouse
8000 cursor is placed over a toolbar button for a brief moment.
8001
8002 If you want the toolbar to be shown with icons as well as text, do the
8003 following: >
8004 :set tb=icons,text
8005< Motif and Athena cannot display icons and text at the same time. They
8006 will show icons if both are requested.
8007
8008 If none of the strings specified in 'toolbar' are valid or if
8009 'toolbar' is empty, this option is ignored. If you want to disable
8010 the toolbar, you need to set the 'guioptions' option. For example: >
8011 :set guioptions-=T
8012< Also see |gui-toolbar|.
8013
8014 *'toolbariconsize'* *'tbis'*
8015'toolbariconsize' 'tbis' string (default "small")
8016 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008017 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008018 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008019 tiny Use tiny icons.
8020 small Use small icons (default).
8021 medium Use medium-sized icons.
8022 large Use large icons.
8023 huge Use even larger icons.
8024 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008025 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008026 the current theme. Common dimensions are giant=48x48, huge=32x32,
8027 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008028
8029 If 'toolbariconsize' is empty, the global default size as determined
8030 by user preferences or the current theme is used.
8031
8032 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8033'ttybuiltin' 'tbi' boolean (default on)
8034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008035 When on, the builtin termcaps are searched before the external ones.
8036 When off the builtin termcaps are searched after the external ones.
8037 When this option is changed, you should set the 'term' option next for
8038 the change to take effect, for example: >
8039 :set notbi term=$TERM
8040< See also |termcap|.
8041 Rationale: The default for this option is "on", because the builtin
8042 termcap entries are generally better (many systems contain faulty
8043 xterm entries...).
8044
8045 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8046'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8047 sun-cmd, screen, rxvt, dtterm or
8048 iris-ansi; also on when running Vim in
8049 a DOS console)
8050 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008051 Indicates a fast terminal connection. More characters will be sent to
8052 the screen for redrawing, instead of using insert/delete line
8053 commands. Improves smoothness of redrawing when there are multiple
8054 windows and the terminal does not support a scrolling region.
8055 Also enables the extra writing of characters at the end of each screen
8056 line for lines that wrap. This helps when using copy/paste with the
8057 mouse in an xterm and other terminals.
8058
8059 *'ttymouse'* *'ttym'*
8060'ttymouse' 'ttym' string (default depends on 'term')
8061 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008062 {only in Unix and VMS, doesn't work in the GUI; not
8063 available when compiled without |+mouse|}
8064 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008065 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 *xterm-mouse*
8067 xterm xterm-like mouse handling. The mouse generates
8068 "<Esc>[Mscr", where "scr" is three bytes:
8069 "s" = button state
8070 "c" = column plus 33
8071 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008072 This only works up to 223 columns! See "dec",
8073 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008074 xterm2 Works like "xterm", but with the xterm reporting the
8075 mouse position while the mouse is dragged. This works
8076 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008077 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 work. See below for how Vim detects this
8079 automatically.
8080 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008081 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008083 for the row and column. No other mouse events are
8084 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008085 *dec-mouse*
8086 dec DEC terminal mouse handling. The mouse generates a
8087 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008088 This is also available for an Xterm, if it was
8089 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008090 *jsbterm-mouse*
8091 jsbterm JSB term mouse handling.
8092 *pterm-mouse*
8093 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008094 *urxvt-mouse*
8095 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008096 The mouse works only if the terminal supports this
8097 encoding style, but it does not have 223 columns limit
8098 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008099 *sgr-mouse*
8100 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008101 mouse reporting. The mouse works even in columns
8102 beyond 223. This option is backward compatible with
8103 "xterm2" because it can also decode "xterm2" style
8104 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008105
8106 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008107 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8108 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8110 recognized, if enabled at compile time. DEC terminal mouse codes
8111 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008112 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8113 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008114 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008115 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8116 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8117 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008118 Additionally, if vim is compiled with the |+termresponse| feature and
8119 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008120 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008121 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008122 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8123 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8124 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008125 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8126 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008127 :set t_RV=
8128<
8129 *'ttyscroll'* *'tsl'*
8130'ttyscroll' 'tsl' number (default 999)
8131 global
8132 Maximum number of lines to scroll the screen. If there are more lines
8133 to scroll the window is redrawn. For terminals where scrolling is
8134 very slow and redrawing is not slow this can be set to a small number,
8135 e.g., 3, to speed up displaying.
8136
8137 *'ttytype'* *'tty'*
8138'ttytype' 'tty' string (default from $TERM)
8139 global
8140 Alias for 'term', see above.
8141
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008142 *'undodir'* *'udir'*
8143'undodir' 'udir' string (default ".")
8144 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008145 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008146 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008147 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008148 "." means using the directory of the file. The undo file name for
8149 "file.txt" is ".file.txt.un~".
8150 For other directories the file name is the full path of the edited
8151 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008152 When writing: The first directory that exists is used. "." always
8153 works, no directories after "." will be used for writing.
8154 When reading all entries are tried to find an undo file. The first
8155 undo file that exists is used. When it cannot be read an error is
8156 given, no further entry is used.
8157 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008158 This option cannot be set from a |modeline| or in the |sandbox|, for
8159 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008160
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008161 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008162'undofile' 'udf' boolean (default off)
8163 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008164 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008165 When on, Vim automatically saves undo history to an undo file when
8166 writing a buffer to a file, and restores undo history from the same
8167 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008168 The directory where the undo file is stored is specified by 'undodir'.
8169 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008170 The undo file is not read when 'undoreload' causes the buffer from
8171 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008172 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008173 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008174
Bram Moolenaar071d4272004-06-13 20:20:40 +00008175 *'undolevels'* *'ul'*
8176'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8177 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008178 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 Maximum number of changes that can be undone. Since undo information
8180 is kept in memory, higher numbers will cause more memory to be used
8181 (nevertheless, a single change can use an unlimited amount of memory).
8182 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8183 itself: >
8184 set ul=0
8185< But you can also get Vi compatibility by including the 'u' flag in
8186 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008187 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008188 Set to -1 for no undo at all. You might want to do this only for the
8189 current buffer: >
8190 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008191< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008192
8193 The local value is set to -123456 when the global value is to be used.
8194
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008195 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008196
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008197 *'undoreload'* *'ur'*
8198'undoreload' 'ur' number (default 10000)
8199 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008200 Save the whole buffer for undo when reloading it. This applies to the
8201 ":e!" command and reloading for when the buffer changed outside of
8202 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008203 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008204 of lines is smaller than the value of this option.
8205 Set this option to zero to disable undo for a reload.
8206
8207 When saving undo for a reload, any undo file is not read.
8208
8209 Note that this causes the whole buffer to be stored in memory. Set
8210 this option to a lower value if you run out of memory.
8211
Bram Moolenaar071d4272004-06-13 20:20:40 +00008212 *'updatecount'* *'uc'*
8213'updatecount' 'uc' number (default: 200)
8214 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008215 After typing this many characters the swap file will be written to
8216 disk. When zero, no swap file will be created at all (see chapter on
8217 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8218 Vim with the "-n" option, see |startup|. When editing in readonly
8219 mode this option will be initialized to 10000.
8220 The swapfile can be disabled per buffer with |'swapfile'|.
8221 When 'updatecount' is set from zero to non-zero, swap files are
8222 created for all buffers that have 'swapfile' set. When 'updatecount'
8223 is set to zero, existing swap files are not deleted.
8224 Also see |'swapsync'|.
8225 This option has no meaning in buffers where |'buftype'| is "nofile"
8226 or "nowrite".
8227
8228 *'updatetime'* *'ut'*
8229'updatetime' 'ut' number (default 4000)
8230 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008231 If this many milliseconds nothing is typed the swap file will be
8232 written to disk (see |crash-recovery|). Also used for the
8233 |CursorHold| autocommand event.
8234
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008235 *'varsofttabstop'* *'vsts'*
8236'varsofttabstop' 'vsts' string (default "")
8237 local to buffer
8238 {only available when compiled with the |+vartabs|
8239 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008240 A list of the number of spaces that a <Tab> counts for while editing,
8241 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8242 width <Tab>s are being inserted, while in fact a mixture of spaces
8243 and <Tab>s is used. Tab widths are separated with commas, with the
8244 final value applying to all subsequent tabs.
8245
8246 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008247 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008248 to use the following: >
8249 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008250< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8251 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008252
8253 Note that the value of |'softtabstop'| will be ignored while
8254 'varsofttabstop' is set.
8255
8256 *'vartabstop'* *'vts'*
8257'vartabstop' 'vts' string (default "")
8258 local to buffer
8259 {only available when compiled with the |+vartabs|
8260 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008261 A list of the number of spaces that a <Tab> in the file counts for,
8262 separated by commas. Each value corresponds to one tab, with the
8263 final value applying to all subsequent tabs. For example: >
8264 :set vartabstop=4,20,10,8
8265< This will make the first tab 4 spaces wide, the second 20 spaces,
8266 the third 10 spaces, and all following tabs 8 spaces.
8267
8268 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8269 is set.
8270
Bram Moolenaar071d4272004-06-13 20:20:40 +00008271 *'verbose'* *'vbs'*
8272'verbose' 'vbs' number (default 0)
8273 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008274 When bigger than zero, Vim will give messages about what it is doing.
8275 Currently, these messages are given:
8276 >= 1 When the viminfo file is read or written.
8277 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008278 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008279 >= 8 Files for which a group of autocommands is executed.
8280 >= 9 Every executed autocommand.
8281 >= 12 Every executed function.
8282 >= 13 When an exception is thrown, caught, finished, or discarded.
8283 >= 14 Anything pending in a ":finally" clause.
8284 >= 15 Every executed Ex command (truncated at 200 characters).
8285
8286 This option can also be set with the "-V" argument. See |-V|.
8287 This option is also set by the |:verbose| command.
8288
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008289 When the 'verbosefile' option is set then the verbose messages are not
8290 displayed.
8291
8292 *'verbosefile'* *'vfile'*
8293'verbosefile' 'vfile' string (default empty)
8294 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008295 When not empty all messages are written in a file with this name.
8296 When the file exists messages are appended.
8297 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008298 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008299 Setting 'verbosefile' to a new value is like making it empty first.
8300 The difference with |:redir| is that verbose messages are not
8301 displayed when 'verbosefile' is set.
8302
Bram Moolenaar071d4272004-06-13 20:20:40 +00008303 *'viewdir'* *'vdir'*
8304'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8305 "$VIM/vimfiles/view",
8306 for Unix: "~/.vim/view",
8307 for Macintosh: "$VIM:vimfiles:view"
8308 for VMS: "sys$login:vimfiles/view"
8309 for RiscOS: "Choices:vimfiles/view")
8310 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008311 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008312 feature}
8313 Name of the directory where to store files for |:mkview|.
8314 This option cannot be set from a |modeline| or in the |sandbox|, for
8315 security reasons.
8316
8317 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008318'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008319 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008320 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008321 feature}
8322 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008323 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008324 word save and restore ~
8325 cursor cursor position in file and in window
8326 folds manually created folds, opened/closed folds and local
8327 fold options
8328 options options and mappings local to a window or buffer (not
8329 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008330 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008331 slash backslashes in file names replaced with forward
8332 slashes
8333 unix with Unix end-of-line format (single <NL>), even when
8334 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008335 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008336
8337 "slash" and "unix" are useful on Windows when sharing view files
8338 with Unix. The Unix version of Vim cannot source dos format scripts,
8339 but the Windows version of Vim can source unix format scripts.
8340
8341 *'viminfo'* *'vi'* *E526* *E527* *E528*
8342'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008343 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8344 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8345 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008346 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008347 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008348 feature}
8349 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008350 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8351 "NONE".
8352 The string should be a comma separated list of parameters, each
8353 consisting of a single character identifying the particular parameter,
8354 followed by a number or string which specifies the value of that
8355 parameter. If a particular character is left out, then the default
8356 value is used for that parameter. The following is a list of the
8357 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008358 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008359 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008360 ! When included, save and restore global variables that start
8361 with an uppercase letter, and don't contain a lowercase
8362 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008363 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008364 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008365 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008366 " Maximum number of lines saved for each register. Old name of
8367 the '<' item, with the disadvantage that you need to put a
8368 backslash before the ", otherwise it will be recognized as the
8369 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008370 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008371 % When included, save and restore the buffer list. If Vim is
8372 started with a file name argument, the buffer list is not
8373 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008374 buffer list is restored from the viminfo file. Quickfix
8375 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8376 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008377 When followed by a number, the number specifies the maximum
8378 number of buffers that are stored. Without a number all
8379 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008380 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008381 ' Maximum number of previously edited files for which the marks
8382 are remembered. This parameter must always be included when
8383 'viminfo' is non-empty.
8384 Including this item also means that the |jumplist| and the
8385 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008386 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008387 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008388 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008389 patterns are also saved. When not included, the value of
8390 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008391 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008392 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008393 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008394 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008395 < Maximum number of lines saved for each register. If zero then
8396 registers are not saved. When not included, all lines are
8397 saved. '"' is the old name for this item.
8398 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008399 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008400 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008401 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008402 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008403 c When included, convert the text in the viminfo file from the
8404 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008405 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008406 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 f Whether file marks need to be stored. If zero, file marks ('0
8408 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008409 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008410 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008411 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008412 h Disable the effect of 'hlsearch' when loading the viminfo
8413 file. When not included, it depends on whether ":nohlsearch"
8414 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008415 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008417 the 'n'. Must be at the end of the option! If the
8418 'viminfofile' option is set, that file name overrides the one
8419 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008420 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008421 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008422 r Removable media. The argument is a string (up to the next
8423 ','). This parameter can be given several times. Each
8424 specifies the start of a path for which no marks will be
8425 stored. This is to avoid removable media. For MS-DOS you
8426 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8427 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8428 ignored. Maximum length of each 'r' argument is 50
8429 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008430 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008431 s Maximum size of an item in Kbyte. If zero then registers are
8432 not saved. Currently only applies to registers. The default
8433 "s10" will exclude registers with more than 10 Kbyte of text.
8434 Also see the '<' item above: line count limit.
8435
8436 Example: >
8437 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8438<
8439 '50 Marks will be remembered for the last 50 files you
8440 edited.
8441 <1000 Contents of registers (up to 1000 lines each) will be
8442 remembered.
8443 s100 Registers with more than 100 Kbyte text are skipped.
8444 :0 Command-line history will not be saved.
8445 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8446 no / Since '/' is not specified, the default will be used,
8447 that is, save all of the search history, and also the
8448 previous search and substitute patterns.
8449 no % The buffer list will not be saved nor read back.
8450 no h 'hlsearch' highlighting will be restored.
8451
8452 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8453 load the contents of the file, this is not done automatically.
8454
8455 This option cannot be set from a |modeline| or in the |sandbox|, for
8456 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008457 NOTE: This option is set to the Vim default value when 'compatible'
8458 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008459
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008460 *'viminfofile'* *'vif'*
8461'viminfofile' 'vif' string (default: "")
8462 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008463 {not available when compiled without the |+viminfo|
8464 feature}
8465 When non-empty, overrides the file name used for viminfo.
8466 When equal to "NONE" no viminfo file will be read or written.
8467 This option can be set with the |-i| command line flag. The |--clean|
8468 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008469 This option cannot be set from a |modeline| or in the |sandbox|, for
8470 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008471
Bram Moolenaar071d4272004-06-13 20:20:40 +00008472 *'virtualedit'* *'ve'*
8473'virtualedit' 've' string (default "")
8474 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008475 {not available when compiled without the
8476 |+virtualedit| feature}
8477 A comma separated list of these words:
8478 block Allow virtual editing in Visual block mode.
8479 insert Allow virtual editing in Insert mode.
8480 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008481 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008482
Bram Moolenaar071d4272004-06-13 20:20:40 +00008483 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008484 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008485 of the line. Useful for selecting a rectangle in Visual mode and
8486 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008487 "onemore" is not the same, it will only allow moving the cursor just
8488 after the last character of the line. This makes some commands more
8489 consistent. Previously the cursor was always past the end of the line
8490 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008491 break some plugins or Vim scripts. For example because |l| can move
8492 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008493 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008494 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008495 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008496 It doesn't make sense to combine "all" with "onemore", but you will
8497 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008498 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008499
8500 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8501'visualbell' 'vb' boolean (default off)
8502 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008503 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008504 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008505 use: >
8506 :set vb t_vb=
8507< If you want a short flash, you can use this on many terminals: >
8508 :set vb t_vb=[?5h$<100>[?5l
8509< Here $<100> specifies the time, you can use a smaller or bigger value
8510 to get a shorter or longer flash.
8511
8512 Note: Vim will limit the bell to once per half a second. This avoids
8513 having to wait for the flashing to finish when there are lots of
8514 bells, e.g. on key repeat. This also happens without 'visualbell'
8515 set.
8516
Bram Moolenaar071d4272004-06-13 20:20:40 +00008517 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8518 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8519 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008520
8521 Note: When the GUI starts, 't_vb' is reset to its default value. You
8522 might want to set it again in your |gvimrc|.
8523
Bram Moolenaar071d4272004-06-13 20:20:40 +00008524 Does not work on the Amiga, you always get a screen flash.
8525 Also see 'errorbells'.
8526
8527 *'warn'* *'nowarn'*
8528'warn' boolean (default on)
8529 global
8530 Give a warning message when a shell command is used while the buffer
8531 has been changed.
8532
8533 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8534'weirdinvert' 'wiv' boolean (default off)
8535 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008536 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008537 It is provided for backwards compatibility with version 4.x.
8538 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8539 vice versa. Has no effect when the GUI is running.
8540
8541 *'whichwrap'* *'ww'*
8542'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008544 Allow specified keys that move the cursor left/right to move to the
8545 previous/next line when the cursor is on the first/last character in
8546 the line. Concatenate characters to allow this for these keys:
8547 char key mode ~
8548 b <BS> Normal and Visual
8549 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008550 h "h" Normal and Visual (not recommended)
8551 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008552 < <Left> Normal and Visual
8553 > <Right> Normal and Visual
8554 ~ "~" Normal
8555 [ <Left> Insert and Replace
8556 ] <Right> Insert and Replace
8557 For example: >
8558 :set ww=<,>,[,]
8559< allows wrap only when cursor keys are used.
8560 When the movement keys are used in combination with a delete or change
8561 operator, the <EOL> also counts for a character. This makes "3h"
8562 different from "3dh" when the cursor crosses the end of a line. This
8563 is also true for "x" and "X", because they do the same as "dl" and
8564 "dh". If you use this, you may also want to use the mapping
8565 ":map <BS> X" to make backspace delete the character in front of the
8566 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008567 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008568 line (not an empty line) then it will not move to the next line. This
8569 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008570 NOTE: This option is set to the Vi default value when 'compatible' is
8571 set and to the Vim default value when 'compatible' is reset.
8572
8573 *'wildchar'* *'wc'*
8574'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008576 Character you have to type to start wildcard expansion in the
8577 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008578 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008579 The character is not recognized when used inside a macro. See
8580 'wildcharm' for that.
8581 Although 'wc' is a number option, you can set it to a special key: >
8582 :set wc=<Esc>
8583< NOTE: This option is set to the Vi default value when 'compatible' is
8584 set and to the Vim default value when 'compatible' is reset.
8585
8586 *'wildcharm'* *'wcm'*
8587'wildcharm' 'wcm' number (default: none (0))
8588 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008589 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008590 recognized when used inside a macro. You can find "spare" command-line
8591 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008592 you'll never actually type 'wildcharm', just use it in mappings that
8593 automatically invoke completion mode, e.g.: >
8594 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008595 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596< Then after typing :ss you can use CTRL-P & CTRL-N.
8597
8598 *'wildignore'* *'wig'*
8599'wildignore' 'wig' string (default "")
8600 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008601 {not available when compiled without the |+wildignore|
8602 feature}
8603 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008604 patterns is ignored when expanding |wildcards|, completing file or
8605 directory names, and influences the result of |expand()|, |glob()| and
8606 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008607 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8608 Also see 'suffixes'.
8609 Example: >
8610 :set wildignore=*.o,*.obj
8611< The use of |:set+=| and |:set-=| is preferred when adding or removing
8612 a pattern from the list. This avoids problems when a future version
8613 uses another default.
8614
Bram Moolenaar94950a92010-12-02 16:01:29 +01008615
Bram Moolenaar81af9252010-12-10 20:35:50 +01008616 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008617'wildignorecase' 'wic' boolean (default off)
8618 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008619 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008620 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008621 Does not apply when the shell is used to expand wildcards, which
8622 happens when there are special characters.
8623
8624
Bram Moolenaar071d4272004-06-13 20:20:40 +00008625 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008626'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008627 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008628 {not available if compiled without the |+wildmenu|
8629 feature}
8630 When 'wildmenu' is on, command-line completion operates in an enhanced
8631 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8632 the possible matches are shown just above the command line, with the
8633 first match highlighted (overwriting the status line, if there is
8634 one). Keys that show the previous/next match, such as <Tab> or
8635 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8636 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8637 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008638 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008639 If there are more matches than can fit in the line, a ">" is shown on
8640 the right and/or a "<" is shown on the left. The status line scrolls
8641 as needed.
8642 The "wildmenu" mode is abandoned when a key is hit that is not used
8643 for selecting a completion.
8644 While the "wildmenu" is active the following keys have special
8645 meanings:
8646
8647 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8648 <Down> - in filename/menu name completion: move into a
8649 subdirectory or submenu.
8650 <CR> - in menu completion, when the cursor is just after a
8651 dot: move into a submenu.
8652 <Up> - in filename/menu name completion: move up into
8653 parent directory or parent menu.
8654
8655 This makes the menus accessible from the console |console-menus|.
8656
8657 If you prefer the <Left> and <Right> keys to move the cursor instead
8658 of selecting a different match, use this: >
8659 :cnoremap <Left> <Space><BS><Left>
8660 :cnoremap <Right> <Space><BS><Right>
8661<
8662 The "WildMenu" highlighting is used for displaying the current match
8663 |hl-WildMenu|.
8664
8665 *'wildmode'* *'wim'*
8666'wildmode' 'wim' string (Vim default: "full")
8667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008668 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008669 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008670 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008671 first part specifies the behavior for the first use of 'wildchar',
8672 The second part for the second use, etc.
8673 These are the possible values for each part:
8674 "" Complete only the first match.
8675 "full" Complete the next full match. After the last match,
8676 the original string is used and then the first match
8677 again.
8678 "longest" Complete till longest common string. If this doesn't
8679 result in a longer string, use the next part.
8680 "longest:full" Like "longest", but also start 'wildmenu' if it is
8681 enabled.
8682 "list" When more than one match, list all matches.
8683 "list:full" When more than one match, list all matches and
8684 complete first match.
8685 "list:longest" When more than one match, list all matches and
8686 complete till longest common string.
8687 When there is only a single match, it is fully completed in all cases.
8688
8689 Examples: >
8690 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008691< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008692 :set wildmode=longest,full
8693< Complete longest common string, then each full match >
8694 :set wildmode=list:full
8695< List all matches and complete each full match >
8696 :set wildmode=list,full
8697< List all matches without completing, then each full match >
8698 :set wildmode=longest,list
8699< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008700 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008701
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008702 *'wildoptions'* *'wop'*
8703'wildoptions' 'wop' string (default "")
8704 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008705 {not available when compiled without the |+wildignore|
8706 feature}
8707 A list of words that change how command line completion is done.
8708 Currently only one word is allowed:
8709 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008710 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008711 is displayed per line. Often used tag kinds are:
8712 d #define
8713 f function
8714 Also see |cmdline-completion|.
8715
Bram Moolenaar071d4272004-06-13 20:20:40 +00008716 *'winaltkeys'* *'wak'*
8717'winaltkeys' 'wak' string (default "menu")
8718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008719 {only used in Win32, Motif, GTK and Photon GUI}
8720 Some GUI versions allow the access to menu entries by using the ALT
8721 key in combination with a character that appears underlined in the
8722 menu. This conflicts with the use of the ALT key for mappings and
8723 entering special characters. This option tells what to do:
8724 no Don't use ALT keys for menus. ALT key combinations can be
8725 mapped, but there is no automatic handling. This can then be
8726 done with the |:simalt| command.
8727 yes ALT key handling is done by the windowing system. ALT key
8728 combinations cannot be mapped.
8729 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008730 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008731 keys can be mapped.
8732 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8733 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008734 This option is not used for <F10>; on Win32 and with GTK <F10> will
8735 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008736
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008737 *'wincolor'* *'wcr'*
8738'wincolor' 'wcr' string (default empty)
8739 local to window
8740 Highlight group name to use for this window instead of the Normal
8741 color |hl-Normal|.
8742
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008743 *'window'* *'wi'*
8744'window' 'wi' number (default screen height - 1)
8745 global
8746 Window height. Do not confuse this with the height of the Vim window,
8747 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008748 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8749 value is smaller than 'lines' minus one. The screen will scroll
8750 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008751 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8752 in a much smarter way, taking care of wrapping lines.
8753 When resizing the Vim window, the value is smaller than 1 or more than
8754 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008755
Bram Moolenaar071d4272004-06-13 20:20:40 +00008756 *'winheight'* *'wh'* *E591*
8757'winheight' 'wh' number (default 1)
8758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008759 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008760 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008761 focus goes to a window that is smaller, its size is increased, at the
8762 cost of the height of other windows.
8763 Set 'winheight' to a small number for normal editing.
8764 Set it to 999 to make the current window fill most of the screen.
8765 Other windows will be only 'winminheight' high. This has the drawback
8766 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8767 to create only two windows, set the option after startup is done,
8768 using the |VimEnter| event: >
8769 au VimEnter * set winheight=999
8770< Minimum value is 1.
8771 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008772 height of the current window.
8773 'winheight' applies to the current window. Use 'winminheight' to set
8774 the minimal height for other windows.
8775
8776 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8777'winfixheight' 'wfh' boolean (default off)
8778 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008779 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008780 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8781 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008782 The height may be changed anyway when running out of room.
8783
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008784 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8785'winfixwidth' 'wfw' boolean (default off)
8786 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008787 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008788 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008789 The width may be changed anyway when running out of room.
8790
Bram Moolenaar071d4272004-06-13 20:20:40 +00008791 *'winminheight'* *'wmh'*
8792'winminheight' 'wmh' number (default 1)
8793 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008794 The minimal height of a window, when it's not the current window.
8795 This is a hard minimum, windows will never become smaller.
8796 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8797 status bar) if necessary. They will return to at least one line when
8798 they become active (since the cursor has to have somewhere to go.)
8799 Use 'winheight' to set the minimal height of the current window.
8800 This option is only checked when making a window smaller. Don't use a
8801 large number, it will cause errors when opening more than a few
8802 windows. A value of 0 to 3 is reasonable.
8803
8804 *'winminwidth'* *'wmw'*
8805'winminwidth' 'wmw' number (default 1)
8806 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008807 The minimal width of a window, when it's not the current window.
8808 This is a hard minimum, windows will never become smaller.
8809 When set to zero, windows may be "squashed" to zero columns (i.e. just
8810 a vertical separator) if necessary. They will return to at least one
8811 line when they become active (since the cursor has to have somewhere
8812 to go.)
8813 Use 'winwidth' to set the minimal width of the current window.
8814 This option is only checked when making a window smaller. Don't use a
8815 large number, it will cause errors when opening more than a few
8816 windows. A value of 0 to 12 is reasonable.
8817
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008818 *'winptydll'*
8819'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8820 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008821 {only available when compiled with the |terminal|
8822 feature on MS-Windows}
8823 Specifies the name of the winpty shared library, used for the
8824 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008825 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008826 a fallback.
8827 Environment variables are expanded |:set_env|.
8828 This option cannot be set from a |modeline| or in the |sandbox|, for
8829 security reasons.
8830
Bram Moolenaar071d4272004-06-13 20:20:40 +00008831 *'winwidth'* *'wiw'* *E592*
8832'winwidth' 'wiw' number (default 20)
8833 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008834 Minimal number of columns for the current window. This is not a hard
8835 minimum, Vim will use fewer columns if there is not enough room. If
8836 the current window is smaller, its size is increased, at the cost of
8837 the width of other windows. Set it to 999 to make the current window
8838 always fill the screen. Set it to a small number for normal editing.
8839 The width is not adjusted after one of the commands to change the
8840 width of the current window.
8841 'winwidth' applies to the current window. Use 'winminwidth' to set
8842 the minimal width for other windows.
8843
8844 *'wrap'* *'nowrap'*
8845'wrap' boolean (default on)
8846 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008847 This option changes how text is displayed. It doesn't change the text
8848 in the buffer, see 'textwidth' for that.
8849 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008850 displaying continues on the next line. When off lines will not wrap
8851 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008852 moved to a part that is not shown, the screen will scroll
8853 horizontally.
8854 The line will be broken in the middle of a word if necessary. See
8855 'linebreak' to get the break at a word boundary.
8856 To make scrolling horizontally a bit more useful, try this: >
8857 :set sidescroll=5
8858 :set listchars+=precedes:<,extends:>
8859< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008860 This option can't be set from a |modeline| when the 'diff' option is
8861 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008862
8863 *'wrapmargin'* *'wm'*
8864'wrapmargin' 'wm' number (default 0)
8865 local to buffer
8866 Number of characters from the right window border where wrapping
8867 starts. When typing text beyond this limit, an <EOL> will be inserted
8868 and inserting continues on the next line.
8869 Options that add a margin, such as 'number' and 'foldcolumn', cause
8870 the text width to be further reduced. This is Vi compatible.
8871 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008872 This option is set to 0 when 'paste' is set and restored when 'paste'
8873 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008874 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008875
8876 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8877'wrapscan' 'ws' boolean (default on) *E384* *E385*
8878 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008879 Searches wrap around the end of the file. Also applies to |]s| and
8880 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008881
8882 *'write'* *'nowrite'*
8883'write' boolean (default on)
8884 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885 Allows writing files. When not set, writing a file is not allowed.
8886 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008887 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008888 argument. Filtering text is still possible, even though this requires
8889 writing a temporary file.
8890
8891 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8892'writeany' 'wa' boolean (default off)
8893 global
8894 Allows writing to any file with no need for "!" override.
8895
8896 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8897'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8898 otherwise)
8899 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008900 Make a backup before overwriting a file. The backup is removed after
8901 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008902 also on.
8903 WARNING: Switching this option off means that when Vim fails to write
8904 your buffer correctly and then, for whatever reason, Vim exits, you
8905 lose both the original file and what you were writing. Only reset
8906 this option if your file system is almost full and it makes the write
8907 fail (and make sure not to exit Vim until the write was successful).
8908 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008909 When the 'backupskip' pattern matches, a backup is not made anyway.
8910 NOTE: This option is set to the default value when 'compatible' is
8911 set.
8912
8913 *'writedelay'* *'wd'*
8914'writedelay' 'wd' number (default 0)
8915 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008916 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008917 screen. When non-zero, characters are sent to the terminal one by
8918 one. For MS-DOS pcterm this does not work. For debugging purposes.
8919
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008920 vim:tw=78:ts=8:noet:ft=help:norl: