blob: e62ee8974ea19055a99f8728d66abd8a27ec83db [file] [log] [blame]
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001*options.txt* For Vim version 8.1. Last change: 2019 Oct 20
Bram Moolenaar071d4272004-06-13 20:20:40 +00002
3
4 VIM REFERENCE MANUAL by Bram Moolenaar
5
6
7Options *options*
8
91. Setting options |set-option|
102. Automatically setting options |auto-setting|
113. Options summary |option-summary|
12
Bram Moolenaar2ec618c2016-10-01 14:47:05 +020013For an overview of options see quickref.txt |option-list|.
Bram Moolenaar071d4272004-06-13 20:20:40 +000014
15Vim has a number of internal variables and switches which can be set to
16achieve special effects. These options come in three forms:
17 boolean can only be on or off *boolean* *toggle*
18 number has a numeric value
19 string has a string value
20
21==============================================================================
Bram Moolenaarf75a9632005-09-13 21:20:47 +0000221. Setting options *set-option* *E764*
Bram Moolenaar071d4272004-06-13 20:20:40 +000023
24 *:se* *:set*
25:se[t] Show all options that differ from their default value.
26
27:se[t] all Show all but terminal options.
28
29:se[t] termcap Show all terminal options. Note that in the GUI the
30 key codes are not shown, because they are generated
31 internally and can't be changed. Changing the terminal
32 codes in the GUI is not useful either...
33
34 *E518* *E519*
35:se[t] {option}? Show value of {option}.
36
37:se[t] {option} Toggle option: set, switch it on.
38 Number option: show value.
39 String option: show value.
40
41:se[t] no{option} Toggle option: Reset, switch it off.
42
Bram Moolenaar00a927d2010-05-14 23:24:24 +020043 *:set-!* *:set-inv*
Bram Moolenaar071d4272004-06-13 20:20:40 +000044:se[t] {option}! or
Bram Moolenaar6c60f472019-04-28 16:00:35 +020045:se[t] inv{option} Toggle option: Invert value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000046
47 *:set-default* *:set-&* *:set-&vi* *:set-&vim*
48:se[t] {option}& Reset option to its default value. May depend on the
Bram Moolenaar6c60f472019-04-28 16:00:35 +020049 current value of 'compatible'.
50:se[t] {option}&vi Reset option to its Vi default value.
51:se[t] {option}&vim Reset option to its Vim default value.
Bram Moolenaar071d4272004-06-13 20:20:40 +000052
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +010053:se[t] all& Set all options to their default value. The values of
Bram Moolenaar88774fd2015-08-25 19:52:04 +020054 these options are not changed:
55 all terminal options, starting with t_
56 'columns'
57 'cryptmethod'
58 'encoding'
59 'key'
60 'lines'
61 'term'
62 'ttymouse'
63 'ttytype'
64 Warning: This may have a lot of side effects.
Bram Moolenaar071d4272004-06-13 20:20:40 +000065
66 *:set-args* *E487* *E521*
67:se[t] {option}={value} or
68:se[t] {option}:{value}
69 Set string or number option to {value}.
70 For numeric options the value can be given in decimal,
Bram Moolenaar3848e002016-03-19 18:42:29 +010071 hex (preceded with 0x) or octal (preceded with '0').
Bram Moolenaar071d4272004-06-13 20:20:40 +000072 The old value can be inserted by typing 'wildchar' (by
73 default this is a <Tab> or CTRL-E if 'compatible' is
74 set). See |cmdline-completion|.
75 White space between {option} and '=' is allowed and
76 will be ignored. White space between '=' and {value}
77 is not allowed.
78 See |option-backslash| for using white space and
79 backslashes in {value}.
80
81:se[t] {option}+={value} *:set+=*
82 Add the {value} to a number option, or append the
83 {value} to a string option. When the option is a
84 comma separated list, a comma is added, unless the
85 value was empty.
86 If the option is a list of flags, superfluous flags
Bram Moolenaara5792f52005-11-23 21:25:05 +000087 are removed. When adding a flag that was already
88 present the option value doesn't change.
Bram Moolenaar899dddf2006-03-26 21:06:50 +000089 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000090
91:se[t] {option}^={value} *:set^=*
92 Multiply the {value} to a number option, or prepend
93 the {value} to a string option. When the option is a
94 comma separated list, a comma is added, unless the
95 value was empty.
96 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +000097
98:se[t] {option}-={value} *:set-=*
99 Subtract the {value} from a number option, or remove
100 the {value} from a string option, if it is there.
101 If the {value} is not found in a string option, there
102 is no error or warning. When the option is a comma
103 separated list, a comma is deleted, unless the option
104 becomes empty.
105 When the option is a list of flags, {value} must be
106 exactly as they appear in the option. Remove flags
107 one by one to avoid problems.
108 Also see |:set-args| above.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000109
110The {option} arguments to ":set" may be repeated. For example: >
111 :set ai nosi sw=3 ts=3
112If you make an error in one of the arguments, an error message will be given
113and the following arguments will be ignored.
114
115 *:set-verbose*
116When 'verbose' is non-zero, displaying an option value will also tell where it
117was last set. Example: >
118 :verbose set shiftwidth cindent?
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200119< shiftwidth=4 ~
120 Last set from modeline line 1 ~
121 cindent ~
122 Last set from /usr/local/share/vim/vim60/ftplugin/c.vim line 30 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000123This is only done when specific option values are requested, not for ":verbose
124set all" or ":verbose set" without an argument.
125When the option was set by hand there is no "Last set" message.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000126When the option was set while executing a function, user command or
127autocommand, the script in which it was defined is reported.
128Note that an option may also have been set as a side effect of setting
129'compatible'.
Bram Moolenaar446cb832008-06-24 21:56:24 +0000130A few special texts:
Bram Moolenaar95bafa22018-10-02 13:26:25 +0200131 Last set from modeline line 1 ~
Bram Moolenaar446cb832008-06-24 21:56:24 +0000132 Option was set in a |modeline|.
133 Last set from --cmd argument ~
134 Option was set with command line argument |--cmd| or +.
135 Last set from -c argument ~
136 Option was set with command line argument |-c|, +, |-S| or
137 |-q|.
138 Last set from environment variable ~
139 Option was set from an environment variable, $VIMINIT,
140 $GVIMINIT or $EXINIT.
141 Last set from error handler ~
142 Option was cleared when evaluating it resulted in an error.
143
Bram Moolenaardb84e452010-08-15 13:50:43 +0200144{not available when compiled without the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000145
146 *:set-termcap* *E522*
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +0000147For {option} the form "t_xx" may be used to set a terminal option. This will
Bram Moolenaar071d4272004-06-13 20:20:40 +0000148override the value from the termcap. You can then use it in a mapping. If
149the "xx" part contains special characters, use the <t_xx> form: >
150 :set <t_#4>=^[Ot
151This can also be used to translate a special code for a normal key. For
152example, if Alt-b produces <Esc>b, use this: >
153 :set <M-b>=^[b
154(the ^[ is a real <Esc> here, use CTRL-V <Esc> to enter it)
155The advantage over a mapping is that it works in all situations.
156
Bram Moolenaar0b2f94d2011-03-22 14:35:05 +0100157You can define any key codes, e.g.: >
158 :set t_xy=^[foo;
159There is no warning for using a name that isn't recognized. You can map these
160codes as you like: >
161 :map <t_xy> something
162< *E846*
163When a key code is not set, it's like it does not exist. Trying to get its
164value will result in an error: >
165 :set t_kb=
166 :set t_kb
167 E846: Key code not set: t_kb
168
Bram Moolenaar293ee4d2004-12-09 21:34:53 +0000169The t_xx options cannot be set from a |modeline| or in the |sandbox|, for
170security reasons.
171
Bram Moolenaar071d4272004-06-13 20:20:40 +0000172The listing from ":set" looks different from Vi. Long string options are put
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000173at the end of the list. The number of options is quite large. The output of
Bram Moolenaar071d4272004-06-13 20:20:40 +0000174"set all" probably does not fit on the screen, causing Vim to give the
175|more-prompt|.
176
177 *option-backslash*
178To include white space in a string option value it has to be preceded with a
179backslash. To include a backslash you have to use two. Effectively this
180means that the number of backslashes in an option value is halved (rounded
181down).
182A few examples: >
183 :set tags=tags\ /usr/tags results in "tags /usr/tags"
184 :set tags=tags\\,file results in "tags\,file"
185 :set tags=tags\\\ file results in "tags\ file"
186
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000187The "|" character separates a ":set" command from a following command. To
188include the "|" in the option value, use "\|" instead. This example sets the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000189'titlestring' option to "hi|there": >
190 :set titlestring=hi\|there
191This sets the 'titlestring' option to "hi" and 'iconstring' to "there": >
192 :set titlestring=hi|set iconstring=there
193
Bram Moolenaar7df351e2006-01-23 22:30:28 +0000194Similarly, the double quote character starts a comment. To include the '"' in
195the option value, use '\"' instead. This example sets the 'titlestring'
196option to 'hi "there"': >
197 :set titlestring=hi\ \"there\"
198
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000199For MS-DOS and WIN32 backslashes in file names are mostly not removed. More
Bram Moolenaar071d4272004-06-13 20:20:40 +0000200precise: For options that expect a file name (those where environment
201variables are expanded) a backslash before a normal file name character is not
202removed. But a backslash before a special character (space, backslash, comma,
203etc.) is used like explained above.
204There is one special situation, when the value starts with "\\": >
205 :set dir=\\machine\path results in "\\machine\path"
206 :set dir=\\\\machine\\path results in "\\machine\path"
207 :set dir=\\path\\file results in "\\path\file" (wrong!)
208For the first one the start is kept, but for the second one the backslashes
209are halved. This makes sure it works both when you expect backslashes to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000210halved and when you expect the backslashes to be kept. The third gives a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000211result which is probably not what you want. Avoid it.
212
213 *add-option-flags* *remove-option-flags*
214 *E539* *E550* *E551* *E552*
215Some options are a list of flags. When you want to add a flag to such an
216option, without changing the existing ones, you can do it like this: >
217 :set guioptions+=a
218Remove a flag from an option like this: >
219 :set guioptions-=a
220This removes the 'a' flag from 'guioptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000221Note that you should add or remove one flag at a time. If 'guioptions' has
Bram Moolenaar071d4272004-06-13 20:20:40 +0000222the value "ab", using "set guioptions-=ba" won't work, because the string "ba"
223doesn't appear.
224
225 *:set_env* *expand-env* *expand-environment-var*
Bram Moolenaard4755bb2004-09-02 19:12:26 +0000226Environment variables in specific string options will be expanded. If the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000227environment variable exists the '$' and the following environment variable
228name is replaced with its value. If it does not exist the '$' and the name
229are not modified. Any non-id character (not a letter, digit or '_') may
230follow the environment variable name. That character and what follows is
231appended to the value of the environment variable. Examples: >
232 :set term=$TERM.new
233 :set path=/usr/$INCLUDE,$HOME/include,.
234When adding or removing a string from an option with ":set opt-=val" or ":set
235opt+=val" the expansion is done before the adding or removing.
236
237
238Handling of local options *local-options*
239
240Some of the options only apply to a window or buffer. Each window or buffer
Bram Moolenaar51628222016-12-01 23:03:28 +0100241has its own copy of this option, thus each can have its own value. This
Bram Moolenaar071d4272004-06-13 20:20:40 +0000242allows you to set 'list' in one window but not in another. And set
243'shiftwidth' to 3 in one buffer and 4 in another.
244
245The following explains what happens to these local options in specific
246situations. You don't really need to know all of this, since Vim mostly uses
247the option values you would expect. Unfortunately, doing what the user
248expects is a bit complicated...
249
250When splitting a window, the local options are copied to the new window. Thus
251right after the split the contents of the two windows look the same.
252
253When editing a new buffer, its local option values must be initialized. Since
254the local options of the current buffer might be specifically for that buffer,
255these are not used. Instead, for each buffer-local option there also is a
256global value, which is used for new buffers. With ":set" both the local and
257global value is changed. With "setlocal" only the local value is changed,
258thus this value is not used when editing a new buffer.
259
Bram Moolenaar95ec9d62016-08-12 18:29:59 +0200260When editing a buffer that has been edited before, the options from the window
261that was last closed are used again. If this buffer has been edited in this
262window, the values from back then are used. Otherwise the values from the
263last closed window where the buffer was edited last are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000264
265It's possible to set a local window option specifically for a type of buffer.
266When you edit another buffer in the same window, you don't want to keep
267using these local window options. Therefore Vim keeps a global value of the
268local window options, which is used when editing another buffer. Each window
269has its own copy of these values. Thus these are local to the window, but
270global to all buffers in the window. With this you can do: >
271 :e one
272 :set list
273 :e two
274Now the 'list' option will also be set in "two", since with the ":set list"
275command you have also set the global value. >
276 :set nolist
277 :e one
278 :setlocal list
279 :e two
280Now the 'list' option is not set, because ":set nolist" resets the global
281value, ":setlocal list" only changes the local value and ":e two" gets the
282global value. Note that if you do this next: >
283 :e one
Bram Moolenaar531da592013-05-06 05:58:55 +0200284You will get back the 'list' value as it was the last time you edited "one".
285The options local to a window are remembered for each buffer. This also
286happens when the buffer is not loaded, but they are lost when the buffer is
287wiped out |:bwipe|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000288
289 *:setl* *:setlocal*
290:setl[ocal] ... Like ":set" but set only the value local to the
291 current buffer or window. Not all options have a
292 local value. If the option does not have a local
293 value the global value is set.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200294 With the "all" argument: display local values for all
295 local options.
296 Without argument: Display local values for all local
297 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000298 When displaying a specific local option, show the
Bram Moolenaar446cb832008-06-24 21:56:24 +0000299 local value. For a global/local boolean option, when
300 the global value is being used, "--" is displayed
301 before the option name.
302 For a global option the global value is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000303 shown (but that might change in the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +0000304
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000305:setl[ocal] {option}< Set the local value of {option} to its global value by
306 copying the value.
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000307
Bram Moolenaar6be7f872012-01-20 21:08:56 +0100308:se[t] {option}< For |global-local| options: Remove the local value of
309 {option}, so that the global value will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000310
311 *:setg* *:setglobal*
312:setg[lobal] ... Like ":set" but set only the global value for a local
313 option without changing the local value.
314 When displaying an option, the global value is shown.
Bram Moolenaarc3301872010-07-25 20:53:06 +0200315 With the "all" argument: display global values for all
316 local options.
317 Without argument: display global values for all local
318 options which are different from the default.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000319
320For buffer-local and window-local options:
321 Command global value local value ~
322 :set option=value set set
323 :setlocal option=value - set
324:setglobal option=value set -
325 :set option? - display
326 :setlocal option? - display
327:setglobal option? display -
328
329
330Global options with a local value *global-local*
331
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +0000332Options are global when you mostly use one value for all buffers and windows.
333For some global options it's useful to sometimes have a different local value.
334You can set the local value with ":setlocal". That buffer or window will then
335use the local value, while other buffers and windows continue using the global
336value.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000337
338For example, you have two windows, both on C source code. They use the global
339'makeprg' option. If you do this in one of the two windows: >
340 :set makeprg=gmake
341then the other window will switch to the same value. There is no need to set
342the 'makeprg' option in the other C source window too.
343However, if you start editing a Perl file in a new window, you want to use
Bram Moolenaar02467872007-05-06 13:22:01 +0000344another 'makeprg' for it, without changing the value used for the C source
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000345files. You use this command: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000346 :setlocal makeprg=perlmake
347You can switch back to using the global value by making the local value empty: >
348 :setlocal makeprg=
Bram Moolenaar314dd792019-02-03 15:27:20 +0100349This only works for a string option. For a number or boolean option you need
350to use the "<" flag, like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +0000351 :setlocal autoread<
Bram Moolenaar314dd792019-02-03 15:27:20 +0100352Note that for non-boolean and non-number options using "<" copies the global
353value to the local value, it doesn't switch back to using the global value
354(that matters when the global value changes later). You can also use: >
Bram Moolenaar899dddf2006-03-26 21:06:50 +0000355 :set path<
356This will make the local value of 'path' empty, so that the global value is
357used. Thus it does the same as: >
358 :setlocal path=
Bram Moolenaar071d4272004-06-13 20:20:40 +0000359Note: In the future more global options can be made global-local. Using
360":setlocal" on a global option might work differently then.
361
362
363Setting the filetype
364
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200365:setf[iletype] [FALLBACK] {filetype} *:setf* *:setfiletype*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000366 Set the 'filetype' option to {filetype}, but only if
367 not done yet in a sequence of (nested) autocommands.
368 This is short for: >
369 :if !did_filetype()
370 : setlocal filetype={filetype}
371 :endif
372< This command is used in a filetype.vim file to avoid
373 setting the 'filetype' option twice, causing different
374 settings and syntax files to be loaded.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200375
376 When the optional FALLBACK argument is present, a
377 later :setfiletype command will override the
Bram Moolenaar26967612019-03-17 17:13:16 +0100378 'filetype'. This is to be used for filetype
379 detections that are just a guess. |did_filetype()|
380 will return false after this command.
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +0200381
Bram Moolenaard58e9292011-02-09 17:07:58 +0100382 *option-window* *optwin*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000383:bro[wse] se[t] *:set-browse* *:browse-set* *:opt* *:options*
384:opt[ions] Open a window for viewing and setting all options.
385 Options are grouped by function.
386 Offers short help for each option. Hit <CR> on the
387 short help to open a help window with more help for
388 the option.
389 Modify the value of the option and hit <CR> on the
390 "set" line to set the new value. For window and
391 buffer specific options, the last accessed window is
392 used to set the option value in, unless this is a help
393 window, in which case the window below help window is
394 used (skipping the option-window).
Bram Moolenaarb5b75622018-03-09 22:22:21 +0100395 {not available when compiled without the |+eval|
396 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000397
398 *$HOME*
399Using "~" is like using "$HOME", but it is only recognized at the start of an
400option and after a space or comma.
401
402On Unix systems "~user" can be used too. It is replaced by the home directory
403of user "user". Example: >
404 :set path=~mool/include,/usr/include,.
405
406On Unix systems the form "${HOME}" can be used too. The name between {} can
407contain non-id characters then. Note that if you want to use this for the
408"gf" command, you need to add the '{' and '}' characters to 'isfname'.
409
410NOTE: expanding environment variables and "~/" is only done with the ":set"
411command, not when assigning a value to an option with ":let".
412
Bram Moolenaarc572da52017-08-27 16:52:01 +0200413 *$HOME-windows*
414On MS-Windows, if $HOME is not defined as an environment variable, then
415at runtime Vim will set it to the expansion of $HOMEDRIVE$HOMEPATH.
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200416If $HOMEDRIVE is not set then $USERPROFILE is used.
417
418This expanded value is not exported to the environment, this matters when
419running an external command: >
420 :echo system('set | findstr ^HOME=')
421and >
422 :echo luaeval('os.getenv("HOME")')
423should echo nothing (an empty string) despite exists('$HOME') being true.
424When setting $HOME to a non-empty string it will be exported to the
425subprocesses.
Bram Moolenaarc572da52017-08-27 16:52:01 +0200426
Bram Moolenaar071d4272004-06-13 20:20:40 +0000427
428Note the maximum length of an expanded option is limited. How much depends on
429the system, mostly it is something like 256 or 1024 characters.
430
431 *:fix* *:fixdel*
432:fix[del] Set the value of 't_kD':
433 't_kb' is 't_kD' becomes ~
434 CTRL-? CTRL-H
435 not CTRL-? CTRL-?
436
Bram Moolenaar6c60f472019-04-28 16:00:35 +0200437 (CTRL-? is 0177 octal, 0x7f hex)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000438
439 If your delete key terminal code is wrong, but the
440 code for backspace is alright, you can put this in
441 your .vimrc: >
442 :fixdel
443< This works no matter what the actual code for
444 backspace is.
445
446 If the backspace key terminal code is wrong you can
447 use this: >
448 :if &term == "termname"
449 : set t_kb=^V<BS>
450 : fixdel
451 :endif
452< Where "^V" is CTRL-V and "<BS>" is the backspace key
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000453 (don't type four characters!). Replace "termname"
Bram Moolenaar071d4272004-06-13 20:20:40 +0000454 with your terminal name.
455
456 If your <Delete> key sends a strange key sequence (not
457 CTRL-? or CTRL-H) you cannot use ":fixdel". Then use: >
458 :if &term == "termname"
459 : set t_kD=^V<Delete>
460 :endif
461< Where "^V" is CTRL-V and "<Delete>" is the delete key
462 (don't type eight characters!). Replace "termname"
463 with your terminal name.
464
465 *Linux-backspace*
466 Note about Linux: By default the backspace key
467 produces CTRL-?, which is wrong. You can fix it by
468 putting this line in your rc.local: >
469 echo "keycode 14 = BackSpace" | loadkeys
470<
471 *NetBSD-backspace*
472 Note about NetBSD: If your backspace doesn't produce
473 the right code, try this: >
474 xmodmap -e "keycode 22 = BackSpace"
475< If this works, add this in your .Xmodmap file: >
476 keysym 22 = BackSpace
477< You need to restart for this to take effect.
478
479==============================================================================
4802. Automatically setting options *auto-setting*
481
482Besides changing options with the ":set" command, there are three alternatives
483to set options automatically for one or more files:
484
4851. When starting Vim initializations are read from various places. See
486 |initialization|. Most of them are performed for all editing sessions,
487 and some of them depend on the directory where Vim is started.
488 You can create an initialization file with |:mkvimrc|, |:mkview| and
489 |:mksession|.
4902. If you start editing a new file, the automatic commands are executed.
491 This can be used to set options for files matching a particular pattern and
492 many other things. See |autocommand|.
4933. If you start editing a new file, and the 'modeline' option is on, a
494 number of lines at the beginning and end of the file are checked for
495 modelines. This is explained here.
496
497 *modeline* *vim:* *vi:* *ex:* *E520*
498There are two forms of modelines. The first form:
Bram Moolenaar14b69452013-06-29 23:05:20 +0200499 [text]{white}{vi:|vim:|ex:}[white]{options}
Bram Moolenaar071d4272004-06-13 20:20:40 +0000500
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200501[text] any text or empty
502{white} at least one blank character (<Space> or <Tab>)
Bram Moolenaar14b69452013-06-29 23:05:20 +0200503{vi:|vim:|ex:} the string "vi:", "vim:" or "ex:"
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200504[white] optional white space
505{options} a list of option settings, separated with white space
506 or ':', where each part between ':' is the argument
507 for a ":set" command (can be empty)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000508
Bram Moolenaar14b69452013-06-29 23:05:20 +0200509Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000510 vi:noai:sw=3 ts=6 ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200511 vim: tw=77 ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000512
513The second form (this is compatible with some versions of Vi):
514
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200515 [text]{white}{vi:|vim:|Vim:|ex:}[white]se[t] {options}:[text]
Bram Moolenaar071d4272004-06-13 20:20:40 +0000516
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200517[text] any text or empty
518{white} at least one blank character (<Space> or <Tab>)
519{vi:|vim:|Vim:|ex:} the string "vi:", "vim:", "Vim:" or "ex:"
520[white] optional white space
Bram Moolenaar14b69452013-06-29 23:05:20 +0200521se[t] the string "set " or "se " (note the space); When
522 "Vim" is used it must be "set".
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200523{options} a list of options, separated with white space, which
524 is the argument for a ":set" command
525: a colon
526[text] any text or empty
Bram Moolenaar071d4272004-06-13 20:20:40 +0000527
Bram Moolenaar14b69452013-06-29 23:05:20 +0200528Examples:
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000529 /* vim: set ai tw=75: */ ~
Bram Moolenaar14b69452013-06-29 23:05:20 +0200530 /* Vim: set ai tw=75: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000531
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200532The white space before {vi:|vim:|Vim:|ex:} is required. This minimizes the
533chance that a normal word like "lex:" is caught. There is one exception:
534"vi:" and "vim:" can also be at the start of the line (for compatibility with
535version 3.0). Using "ex:" at the start of the line will be ignored (this
536could be short for "example:").
Bram Moolenaar071d4272004-06-13 20:20:40 +0000537
538 *modeline-local*
539The options are set like with ":setlocal": The new value only applies to the
Bram Moolenaar843ee412004-06-30 16:16:41 +0000540buffer and window that contain the file. Although it's possible to set global
541options from a modeline, this is unusual. If you have two windows open and
542the files in it set the same global option to a different value, the result
543depends on which one was opened last.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000544
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +0000545When editing a file that was already loaded, only the window-local options
546from the modeline are used. Thus if you manually changed a buffer-local
547option after opening the file, it won't be changed if you edit the same buffer
548in another window. But window-local options will be set.
549
Bram Moolenaar071d4272004-06-13 20:20:40 +0000550 *modeline-version*
551If the modeline is only to be used for some versions of Vim, the version
Bram Moolenaar22dbc772013-06-28 18:44:48 +0200552number can be specified where "vim:" or "Vim:" is used:
Bram Moolenaar071d4272004-06-13 20:20:40 +0000553 vim{vers}: version {vers} or later
554 vim<{vers}: version before {vers}
555 vim={vers}: version {vers}
556 vim>{vers}: version after {vers}
Bram Moolenaar2b8388b2015-02-28 13:11:45 +0100557{vers} is 700 for Vim 7.0 (hundred times the major version plus minor).
558For example, to use a modeline only for Vim 7.0:
559 /* vim700: set foldmethod=marker */ ~
560To use a modeline for Vim after version 7.2:
561 /* vim>702: set cole=2: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000562There can be no blanks between "vim" and the ":".
563
564
565The number of lines that are checked can be set with the 'modelines' option.
566If 'modeline' is off or 'modelines' is 0 no lines are checked.
567
568Note that for the first form all of the rest of the line is used, thus a line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000569like:
570 /* vi:ts=4: */ ~
571will give an error message for the trailing "*/". This line is OK:
572 /* vi:set ts=4: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000573
574If an error is detected the rest of the line is skipped.
575
576If you want to include a ':' in a set command precede it with a '\'. The
Bram Moolenaar97b2ad32006-03-18 21:40:56 +0000577backslash in front of the ':' will be removed. Example:
578 /* vi:set dir=c\:\tmp: */ ~
Bram Moolenaar071d4272004-06-13 20:20:40 +0000579This sets the 'dir' option to "c:\tmp". Only a single backslash before the
580':' is removed. Thus to include "\:" you have to specify "\\:".
Bram Moolenaar110289e2019-05-23 15:38:06 +0200581 *E992*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000582No other commands than "set" are supported, for security reasons (somebody
Bram Moolenaar8243a792007-05-01 17:05:03 +0000583might create a Trojan horse text file with modelines). And not all options
Bram Moolenaar110289e2019-05-23 15:38:06 +0200584can be set. For some options a flag is set, so that when the value is used
585the |sandbox| is effective. Some options can only be set from the modeline
586when 'modelineexpr' is set (the default is off).
587
588Still, there is always a small risk that a modeline causes trouble. E.g.,
589when some joker sets 'textwidth' to 5 all your lines are wrapped unexpectedly.
590So disable modelines before editing untrusted text. The mail ftplugin does
591this, for example.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000592
593Hint: If you would like to do something else than setting an option, you could
594define an autocommand that checks the file for a specific string. For
595example: >
596 au BufReadPost * if getline(1) =~ "VAR" | call SetVar() | endif
597And define a function SetVar() that does something with the line containing
598"VAR".
599
600==============================================================================
6013. Options summary *option-summary*
602
603In the list below all the options are mentioned with their full name and with
604an abbreviation if there is one. Both forms may be used.
605
606In this document when a boolean option is "set" that means that ":set option"
607is entered. When an option is "reset", ":set nooption" is used.
608
609For some options there are two default values: The "Vim default", which is
610used when 'compatible' is not set, and the "Vi default", which is used when
611'compatible' is set.
612
613Most options are the same in all windows and buffers. There are a few that
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000614are specific to how the text is presented in a window. These can be set to a
Bram Moolenaar071d4272004-06-13 20:20:40 +0000615different value in each window. For example the 'list' option can be set in
616one window and reset in another for the same text, giving both types of view
617at the same time. There are a few options that are specific to a certain
618file. These can have a different value for each file or buffer. For example
619the 'textwidth' option can be 78 for a normal text file and 0 for a C
620program.
621
622 global one option for all buffers and windows
623 local to window each window has its own copy of this option
624 local to buffer each buffer has its own copy of this option
625
626When creating a new window the option values from the currently active window
627are used as a default value for the window-specific options. For the
628buffer-specific options this depends on the 's' and 'S' flags in the
629'cpoptions' option. If 's' is included (which is the default) the values for
630buffer options are copied from the currently active buffer when a buffer is
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000631first entered. If 'S' is present the options are copied each time the buffer
632is entered, this is almost like having global options. If 's' and 'S' are not
Bram Moolenaar071d4272004-06-13 20:20:40 +0000633present, the options are copied from the currently active buffer when the
634buffer is created.
635
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000636Hidden options *hidden-options*
Bram Moolenaar071d4272004-06-13 20:20:40 +0000637
Bram Moolenaar578b49e2005-09-10 19:22:57 +0000638Not all options are supported in all versions. This depends on the supported
639features and sometimes on the system. A remark about this is in curly braces
640below. When an option is not supported it may still be set without getting an
641error, this is called a hidden option. You can't get the value of a hidden
642option though, it is not stored.
643
644To test if option "foo" can be used with ":set" use something like this: >
645 if exists('&foo')
646This also returns true for a hidden option. To test if option "foo" is really
647supported use something like this: >
648 if exists('+foo')
649<
Bram Moolenaar071d4272004-06-13 20:20:40 +0000650 *E355*
651A jump table for the options with a short description can be found at |Q_op|.
652
653 *'aleph'* *'al'* *aleph* *Aleph*
654'aleph' 'al' number (default 128 for MS-DOS, 224 otherwise)
655 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000656 {only available when compiled with the |+rightleft|
657 feature}
658 The ASCII code for the first letter of the Hebrew alphabet. The
659 routine that maps the keyboard in Hebrew mode, both in Insert mode
660 (when hkmap is set) and on the command-line (when hitting CTRL-_)
661 outputs the Hebrew characters in the range [aleph..aleph+26].
662 aleph=128 applies to PC code, and aleph=224 applies to ISO 8859-8.
663 See |rileft.txt|.
664
665 *'allowrevins'* *'ari'* *'noallowrevins'* *'noari'*
666'allowrevins' 'ari' boolean (default off)
667 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000668 {only available when compiled with the |+rightleft|
669 feature}
670 Allow CTRL-_ in Insert and Command-line mode. This is default off, to
671 avoid that users that accidentally type CTRL-_ instead of SHIFT-_ get
672 into reverse Insert mode, and don't know how to get out. See
673 'revins'.
674 NOTE: This option is reset when 'compatible' is set.
675
676 *'altkeymap'* *'akm'* *'noaltkeymap'* *'noakm'*
677'altkeymap' 'akm' boolean (default off)
678 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000679 {only available when compiled with the |+farsi|
680 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +0100681 This option was for using Farsi, which has been removed. See
682 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000683
684 *'ambiwidth'* *'ambw'*
685'ambiwidth' 'ambw' string (default: "single")
686 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000687 Only effective when 'encoding' is "utf-8" or another Unicode encoding.
688 Tells Vim what to do with characters with East Asian Width Class
689 Ambiguous (such as Euro, Registered Sign, Copyright Sign, Greek
690 letters, Cyrillic letters).
691
692 There are currently two possible values:
Bram Moolenaar582fd852005-03-28 20:58:01 +0000693 "single": Use the same width as characters in US-ASCII. This is
Bram Moolenaar071d4272004-06-13 20:20:40 +0000694 expected by most users.
695 "double": Use twice the width of ASCII characters.
Bram Moolenaar5c3bd0a2010-08-04 20:55:44 +0200696 *E834* *E835*
697 The value "double" cannot be used if 'listchars' or 'fillchars'
698 contains a character that would be double width.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000699
700 There are a number of CJK fonts for which the width of glyphs for
701 those characters are solely based on how many octets they take in
702 legacy/traditional CJK encodings. In those encodings, Euro,
703 Registered sign, Greek/Cyrillic letters are represented by two octets,
Bram Moolenaar582fd852005-03-28 20:58:01 +0000704 therefore those fonts have "wide" glyphs for them. This is also
Bram Moolenaar071d4272004-06-13 20:20:40 +0000705 true of some line drawing characters used to make tables in text
Bram Moolenaar582fd852005-03-28 20:58:01 +0000706 file. Therefore, when a CJK font is used for GUI Vim or
Bram Moolenaar071d4272004-06-13 20:20:40 +0000707 Vim is running inside a terminal (emulators) that uses a CJK font
708 (or Vim is run inside an xterm invoked with "-cjkwidth" option.),
709 this option should be set to "double" to match the width perceived
710 by Vim with the width of glyphs in the font. Perhaps it also has
711 to be set to "double" under CJK Windows 9x/ME or Windows 2k/XP
712 when the system locale is set to one of CJK locales. See Unicode
713 Standard Annex #11 (http://www.unicode.org/reports/tr11).
714
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100715 Vim may set this option automatically at startup time when Vim is
716 compiled with the |+termresponse| feature and if |t_u7| is set to the
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200717 escape sequence to request cursor position report. The response can
718 be found in |v:termu7resp|.
Bram Moolenaarac7bd632013-03-19 11:35:58 +0100719
Bram Moolenaar071d4272004-06-13 20:20:40 +0000720 *'antialias'* *'anti'* *'noantialias'* *'noanti'*
721'antialias' 'anti' boolean (default: off)
722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000723 {only available when compiled with GUI enabled
724 on Mac OS X}
725 This option only has an effect in the GUI version of Vim on Mac OS X
726 v10.2 or later. When on, Vim will use smooth ("antialiased") fonts,
727 which can be easier to read at certain sizes on certain displays.
728 Setting this option can sometimes cause problems if 'guifont' is set
729 to its default (empty string).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100730 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000731
732 *'autochdir'* *'acd'* *'noautochdir'* *'noacd'*
733'autochdir' 'acd' boolean (default off)
734 global
Bram Moolenaar00a927d2010-05-14 23:24:24 +0200735 {only available when compiled with it, use
736 exists("+autochdir") to check}
Bram Moolenaard8c00872005-07-22 21:52:15 +0000737 When on, Vim will change the current working directory whenever you
738 open a file, switch buffers, delete a buffer or open/close a window.
739 It will change to the directory containing the file which was opened
740 or selected.
Bram Moolenaar910f66f2006-04-05 20:41:53 +0000741 Note: When this option is on some plugins may not work.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000742
743 *'arabic'* *'arab'* *'noarabic'* *'noarab'*
744'arabic' 'arab' boolean (default off)
745 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +0000746 {only available when compiled with the |+arabic|
747 feature}
748 This option can be set to start editing Arabic text.
749 Setting this option will:
750 - Set the 'rightleft' option, unless 'termbidi' is set.
751 - Set the 'arabicshape' option, unless 'termbidi' is set.
752 - Set the 'keymap' option to "arabic"; in Insert mode CTRL-^ toggles
753 between typing English and Arabic key mapping.
754 - Set the 'delcombine' option
755 Note that 'encoding' must be "utf-8" for working with Arabic text.
756
757 Resetting this option will:
758 - Reset the 'rightleft' option.
759 - Disable the use of 'keymap' (without changing its value).
760 Note that 'arabicshape' and 'delcombine' are not reset (it is a global
Bram Moolenaarc8734422012-06-01 22:38:45 +0200761 option).
Bram Moolenaar036986f2017-03-16 17:41:02 +0100762 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000763 Also see |arabic.txt|.
764
765 *'arabicshape'* *'arshape'*
766 *'noarabicshape'* *'noarshape'*
767'arabicshape' 'arshape' boolean (default on)
768 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000769 {only available when compiled with the |+arabic|
770 feature}
771 When on and 'termbidi' is off, the required visual character
772 corrections that need to take place for displaying the Arabic language
Bram Moolenaar3a0d8092012-10-21 03:02:54 +0200773 take effect. Shaping, in essence, gets enabled; the term is a broad
Bram Moolenaar071d4272004-06-13 20:20:40 +0000774 one which encompasses:
775 a) the changing/morphing of characters based on their location
776 within a word (initial, medial, final and stand-alone).
777 b) the enabling of the ability to compose characters
778 c) the enabling of the required combining of some characters
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100779 When disabled the display shows each character's true stand-alone
780 form.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000781 Arabic is a complex language which requires other settings, for
782 further details see |arabic.txt|.
Bram Moolenaar036986f2017-03-16 17:41:02 +0100783 NOTE: This option is set when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000784
785 *'autoindent'* *'ai'* *'noautoindent'* *'noai'*
786'autoindent' 'ai' boolean (default off)
787 local to buffer
788 Copy indent from current line when starting a new line (typing <CR>
789 in Insert mode or when using the "o" or "O" command). If you do not
790 type anything on the new line except <BS> or CTRL-D and then type
Bram Moolenaar02467872007-05-06 13:22:01 +0000791 <Esc>, CTRL-O or <CR>, the indent is deleted again. Moving the cursor
792 to another line has the same effect, unless the 'I' flag is included
793 in 'cpoptions'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000794 When autoindent is on, formatting (with the "gq" command or when you
795 reach 'textwidth' in Insert mode) uses the indentation of the first
796 line.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000797 When 'smartindent' or 'cindent' is on the indent is changed in
798 a different way.
Bram Moolenaarca635012015-09-25 20:34:21 +0200799 The 'autoindent' option is reset when the 'paste' option is set and
800 restored when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000801
802 *'autoread'* *'ar'* *'noautoread'* *'noar'*
803'autoread' 'ar' boolean (default off)
804 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000805 When a file has been detected to have been changed outside of Vim and
806 it has not been changed inside of Vim, automatically read it again.
Bram Moolenaarfd358112018-07-07 23:21:31 +0200807 When the file has been deleted this is not done, so you have the text
808 from before it was deleted. When it appears again then it is read.
809 |timestamp|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000810 If this option has a local value, use this command to switch back to
811 using the global value: >
812 :set autoread<
813<
814 *'autowrite'* *'aw'* *'noautowrite'* *'noaw'*
815'autowrite' 'aw' boolean (default off)
816 global
817 Write the contents of the file, if it has been modified, on each
818 :next, :rewind, :last, :first, :previous, :stop, :suspend, :tag, :!,
Bram Moolenaar14716812006-05-04 21:54:08 +0000819 :make, CTRL-] and CTRL-^ command; and when a :buffer, CTRL-O, CTRL-I,
Bram Moolenaar071d4272004-06-13 20:20:40 +0000820 '{A-Z0-9}, or `{A-Z0-9} command takes one to another file.
821 Note that for some commands the 'autowrite' option is not used, see
822 'autowriteall' for that.
Bram Moolenaar93a1df22018-09-10 11:51:50 +0200823 Some buffers will not be written, specifically when 'buftype' is
Bram Moolenaar20aac6c2018-09-02 21:07:30 +0200824 "nowrite", "nofile", "terminal" or "prompt".
Bram Moolenaar071d4272004-06-13 20:20:40 +0000825
826 *'autowriteall'* *'awa'* *'noautowriteall'* *'noawa'*
827'autowriteall' 'awa' boolean (default off)
828 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000829 Like 'autowrite', but also used for commands ":edit", ":enew", ":quit",
830 ":qall", ":exit", ":xit", ":recover" and closing the Vim window.
831 Setting this option also implies that Vim behaves like 'autowrite' has
832 been set.
833
834 *'background'* *'bg'*
Bram Moolenaar446beb42011-05-10 17:18:44 +0200835'background' 'bg' string (default "dark" or "light", see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000836 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000837 When set to "dark", Vim will try to use colors that look good on a
838 dark background. When set to "light", Vim will try to use colors that
839 look good on a light background. Any other value is illegal.
840 Vim tries to set the default value according to the terminal used.
841 This will not always be correct.
842 Setting this option does not change the background color, it tells Vim
843 what the background color looks like. For changing the background
844 color, see |:hi-normal|.
845
846 When 'background' is set Vim will adjust the default color groups for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000847 the new value. But the colors used for syntax highlighting will not
Bram Moolenaar446cb832008-06-24 21:56:24 +0000848 change. *g:colors_name*
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100849 When a color scheme is loaded (the "g:colors_name" variable is set)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000850 setting 'background' will cause the color scheme to be reloaded. If
851 the color scheme adjusts to the value of 'background' this will work.
852 However, if the color scheme sets 'background' itself the effect may
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +0100853 be undone. First delete the "g:colors_name" variable when needed.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000854
855 When setting 'background' to the default value with: >
856 :set background&
857< Vim will guess the value. In the GUI this should work correctly,
858 in other cases Vim might not be able to guess the right value.
Bram Moolenaar2e693a82019-10-16 22:35:02 +0200859 If the GUI supports a dark theme, you can use the "d" flag in
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +0200860 'guioptions', see 'go-d'.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000861
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200862 When the |t_RB| option is set, Vim will use it to request the background
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200863 color from the terminal. If the returned RGB value is dark/light and
864 'background' is not dark/light, 'background' will be set and the
865 screen is redrawn. This may have side effects, make t_BG empty in
Bram Moolenaar37c64c72017-09-19 22:06:03 +0200866 your .vimrc if you suspect this problem. The response to |t_RB| can
Bram Moolenaar01164a62017-11-02 22:58:42 +0100867 be found in |v:termrbgresp|.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +0200868
Bram Moolenaar071d4272004-06-13 20:20:40 +0000869 When starting the GUI, the default value for 'background' will be
870 "light". When the value is not set in the .gvimrc, and Vim detects
871 that the background is actually quite dark, 'background' is set to
872 "dark". But this happens only AFTER the .gvimrc file has been read
873 (because the window needs to be opened to find the actual background
874 color). To get around this, force the GUI window to be opened by
875 putting a ":gui" command in the .gvimrc file, before where the value
876 of 'background' is used (e.g., before ":syntax on").
Bram Moolenaar446beb42011-05-10 17:18:44 +0200877
878 For MS-DOS, Windows and OS/2 the default is "dark".
879 For other systems "dark" is used when 'term' is "linux",
880 "screen.linux", "cygwin" or "putty", or $COLORFGBG suggests a dark
881 background. Otherwise the default is "light".
882
Bram Moolenaarc572da52017-08-27 16:52:01 +0200883 The |:terminal| command and the |term_start()| function use the
884 'background' value to decide whether the terminal window will start
885 with a white or black background.
886
Bram Moolenaar071d4272004-06-13 20:20:40 +0000887 Normally this option would be set in the .vimrc file. Possibly
888 depending on the terminal name. Example: >
889 :if &term == "pcterm"
890 : set background=dark
891 :endif
892< When this option is set, the default settings for the highlight groups
893 will change. To use other settings, place ":highlight" commands AFTER
894 the setting of the 'background' option.
895 This option is also used in the "$VIMRUNTIME/syntax/syntax.vim" file
896 to select the colors for syntax highlighting. After changing this
897 option, you must load syntax.vim again to see the result. This can be
898 done with ":syntax on".
899
900 *'backspace'* *'bs'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +0200901'backspace' 'bs' string (default "", set to "indent,eol,start"
902 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +0000903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000904 Influences the working of <BS>, <Del>, CTRL-W and CTRL-U in Insert
905 mode. This is a list of items, separated by commas. Each item allows
906 a way to backspace over something:
907 value effect ~
908 indent allow backspacing over autoindent
909 eol allow backspacing over line breaks (join lines)
910 start allow backspacing over the start of insert; CTRL-W and CTRL-U
911 stop once at the start of insert.
912
913 When the value is empty, Vi compatible backspacing is used.
914
915 For backwards compatibility with version 5.4 and earlier:
916 value effect ~
917 0 same as ":set backspace=" (Vi compatible)
918 1 same as ":set backspace=indent,eol"
919 2 same as ":set backspace=indent,eol,start"
920
921 See |:fixdel| if your <BS> or <Del> key does not do what you want.
922 NOTE: This option is set to "" when 'compatible' is set.
923
924 *'backup'* *'bk'* *'nobackup'* *'nobk'*
925'backup' 'bk' boolean (default off)
926 global
Bram Moolenaar071d4272004-06-13 20:20:40 +0000927 Make a backup before overwriting a file. Leave it around after the
928 file has been successfully written. If you do not want to keep the
929 backup file, but you do want a backup while the file is being
930 written, reset this option and set the 'writebackup' option (this is
931 the default). If you do not want a backup file at all reset both
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000932 options (use this if your file system is almost full). See the
Bram Moolenaar071d4272004-06-13 20:20:40 +0000933 |backup-table| for more explanations.
934 When the 'backupskip' pattern matches, a backup is not made anyway.
935 When 'patchmode' is set, the backup may be renamed to become the
936 oldest version of a file.
937 NOTE: This option is reset when 'compatible' is set.
938
939 *'backupcopy'* *'bkc'*
940'backupcopy' 'bkc' string (Vi default for Unix: "yes", otherwise: "auto")
Bram Moolenaarb8ee25a2014-09-23 15:45:08 +0200941 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +0000942 When writing a file and a backup is made, this option tells how it's
943 done. This is a comma separated list of words.
944
945 The main values are:
946 "yes" make a copy of the file and overwrite the original one
947 "no" rename the file and write a new one
948 "auto" one of the previous, what works best
949
950 Extra values that can be combined with the ones above are:
951 "breaksymlink" always break symlinks when writing
952 "breakhardlink" always break hardlinks when writing
953
954 Making a copy and overwriting the original file:
955 - Takes extra time to copy the file.
956 + When the file has special attributes, is a (hard/symbolic) link or
957 has a resource fork, all this is preserved.
958 - When the file is a link the backup will have the name of the link,
959 not of the real file.
960
961 Renaming the file and writing a new one:
962 + It's fast.
963 - Sometimes not all attributes of the file can be copied to the new
964 file.
965 - When the file is a link the new file will not be a link.
966
967 The "auto" value is the middle way: When Vim sees that renaming file
968 is possible without side effects (the attributes can be passed on and
Bram Moolenaar02467872007-05-06 13:22:01 +0000969 the file is not a link) that is used. When problems are expected, a
970 copy will be made.
Bram Moolenaar071d4272004-06-13 20:20:40 +0000971
972 The "breaksymlink" and "breakhardlink" values can be used in
973 combination with any of "yes", "no" and "auto". When included, they
974 force Vim to always break either symbolic or hard links by doing
975 exactly what the "no" option does, renaming the original file to
976 become the backup and writing a new file in its place. This can be
977 useful for example in source trees where all the files are symbolic or
978 hard links and any changes should stay in the local source tree, not
979 be propagated back to the original source.
980 *crontab*
981 One situation where "no" and "auto" will cause problems: A program
982 that opens a file, invokes Vim to edit that file, and then tests if
983 the open file was changed (through the file descriptor) will check the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000984 backup file instead of the newly created file. "crontab -e" is an
Bram Moolenaar071d4272004-06-13 20:20:40 +0000985 example.
986
987 When a copy is made, the original file is truncated and then filled
988 with the new text. This means that protection bits, owner and
989 symbolic links of the original file are unmodified. The backup file
Bram Moolenaarf4b8e572004-06-24 15:53:16 +0000990 however, is a new file, owned by the user who edited the file. The
Bram Moolenaar071d4272004-06-13 20:20:40 +0000991 group of the backup is set to the group of the original file. If this
992 fails, the protection bits for the group are made the same as for
993 others.
994
995 When the file is renamed this is the other way around: The backup has
996 the same attributes of the original file, and the newly written file
997 is owned by the current user. When the file was a (hard/symbolic)
998 link, the new file will not! That's why the "auto" value doesn't
999 rename when the file is a link. The owner and group of the newly
1000 written file will be set to the same ones as the original file, but
1001 the system may refuse to do this. In that case the "auto" value will
1002 again not rename the file.
1003
Bram Moolenaar036986f2017-03-16 17:41:02 +01001004 NOTE: This option is set to the Vi default value when 'compatible' is
1005 set and to the Vim default value when 'compatible' is reset.
1006
Bram Moolenaar071d4272004-06-13 20:20:40 +00001007 *'backupdir'* *'bdir'*
1008'backupdir' 'bdir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01001009 for MS-DOS and Win32: ".,$TEMP,c:/tmp,c:/temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001010 for Unix: ".,~/tmp,~/")
1011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001012 List of directories for the backup file, separated with commas.
1013 - The backup file will be created in the first directory in the list
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001014 where this is possible. The directory must exist, Vim will not
1015 create it for you.
Bram Moolenaar3848e002016-03-19 18:42:29 +01001016 - Empty means that no backup file will be created ('patchmode' is
Bram Moolenaar071d4272004-06-13 20:20:40 +00001017 impossible!). Writing may fail because of this.
1018 - A directory "." means to put the backup file in the same directory
1019 as the edited file.
Bram Moolenaar009b2592004-10-24 19:18:58 +00001020 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00001021 put the backup file relative to where the edited file is. The
1022 leading "." is replaced with the path name of the edited file.
1023 ("." inside a directory name has no special meaning).
1024 - Spaces after the comma are ignored, other spaces are considered part
1025 of the directory name. To have a space at the start of a directory
1026 name, precede it with a backslash.
1027 - To include a comma in a directory name precede it with a backslash.
1028 - A directory name may end in an '/'.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001029 - For Unix and Win32, if a directory ends in two path separators "//",
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01001030 the backup file name will be built from the complete path to the
1031 file with all path separators changed to percent '%' signs. This
1032 will ensure file name uniqueness in the backup directory.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02001033 On Win32, it is also possible to end with "\\". However, When a
1034 separating comma is following, you must use "//", since "\\" will
1035 include the comma in the file name. Therefore it is recommended to
1036 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001037 - Environment variables are expanded |:set_env|.
1038 - Careful with '\' characters, type one before a space, type two to
1039 get one in the option (see |option-backslash|), for example: >
1040 :set bdir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
1041< - For backwards compatibility with Vim version 3.0 a '>' at the start
1042 of the option is removed.
1043 See also 'backup' and 'writebackup' options.
1044 If you want to hide your backup files on Unix, consider this value: >
1045 :set backupdir=./.backup,~/.backup,.,/tmp
1046< You must create a ".backup" directory in each directory and in your
1047 home directory for this to work properly.
1048 The use of |:set+=| and |:set-=| is preferred when adding or removing
1049 directories from the list. This avoids problems when a future version
1050 uses another default.
1051 This option cannot be set from a |modeline| or in the |sandbox|, for
1052 security reasons.
1053
1054 *'backupext'* *'bex'* *E589*
1055'backupext' 'bex' string (default "~", for VMS: "_")
1056 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001057 String which is appended to a file name to make the name of the
1058 backup file. The default is quite unusual, because this avoids
1059 accidentally overwriting existing files with a backup file. You might
1060 prefer using ".bak", but make sure that you don't have files with
1061 ".bak" that you want to keep.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00001062 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001063
Bram Moolenaar3fdfa4a2004-10-07 21:02:47 +00001064 If you like to keep a lot of backups, you could use a BufWritePre
1065 autocommand to change 'backupext' just before writing the file to
1066 include a timestamp. >
1067 :au BufWritePre * let &bex = '-' . strftime("%Y%b%d%X") . '~'
1068< Use 'backupdir' to put the backup in a different directory.
1069
Bram Moolenaar071d4272004-06-13 20:20:40 +00001070 *'backupskip'* *'bsk'*
Bram Moolenaarb8e22a02018-04-12 21:37:34 +02001071'backupskip' 'bsk' string (default: "$TMPDIR/*,$TMP/*,$TEMP/*"
1072 Unix: "/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*"
1073 Mac: "/private/tmp/*,$TMPDIR/*,$TMP/*,$TEMP/*")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001074 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001075 {not available when compiled without the |+wildignore|
1076 feature}
1077 A list of file patterns. When one of the patterns matches with the
1078 name of the file which is written, no backup file is created. Both
1079 the specified file name and the full path name of the file are used.
1080 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
1081 Watch out for special characters, see |option-backslash|.
1082 When $TMPDIR, $TMP or $TEMP is not defined, it is not used for the
Bram Moolenaar582fd852005-03-28 20:58:01 +00001083 default value. "/tmp/*" is only used for Unix.
Bram Moolenaar02467872007-05-06 13:22:01 +00001084
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02001085 WARNING: Not having a backup file means that when Vim fails to write
1086 your buffer correctly and then, for whatever reason, Vim exits, you
1087 lose both the original file and what you were writing. Only disable
1088 backups if you don't care about losing the file.
1089
Bram Moolenaar02467872007-05-06 13:22:01 +00001090 Note that environment variables are not expanded. If you want to use
1091 $HOME you must expand it explicitly, e.g.: >
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001092 :let &backupskip = escape(expand('$HOME'), '\') . '/tmp/*'
Bram Moolenaar02467872007-05-06 13:22:01 +00001093
1094< Note that the default also makes sure that "crontab -e" works (when a
Bram Moolenaara5792f52005-11-23 21:25:05 +00001095 backup would be made by renaming the original file crontab won't see
1096 the newly created file). Also see 'backupcopy' and |crontab|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001097
1098 *'balloondelay'* *'bdlay'*
1099'balloondelay' 'bdlay' number (default: 600)
1100 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001101 {only available when compiled with the |+balloon_eval|
1102 feature}
1103 Delay in milliseconds before a balloon may pop up. See |balloon-eval|.
1104
1105 *'ballooneval'* *'beval'* *'noballooneval'* *'nobeval'*
1106'ballooneval' 'beval' boolean (default off)
1107 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001108 {only available when compiled with the |+balloon_eval|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001109 feature}
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001110 Switch on the |balloon-eval| functionality for the GUI.
1111
1112 *'balloonevalterm'* *'bevalterm'* *'noballoonevalterm'*
1113 *'nobevalterm'*
1114'balloonevalterm' 'bevalterm' boolean (default off)
1115 global
Bram Moolenaar51b0f372017-11-18 18:52:04 +01001116 {only available when compiled with the
1117 |+balloon_eval_term| feature}
1118 Switch on the |balloon-eval| functionality for the terminal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001119
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001120 *'balloonexpr'* *'bexpr'*
1121'balloonexpr' 'bexpr' string (default "")
Bram Moolenaar9b2200a2006-03-20 21:55:45 +00001122 global or local to buffer |global-local|
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001123 {only available when compiled with the |+balloon_eval|
1124 feature}
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00001125 Expression for text to show in evaluation balloon. It is only used
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001126 when 'ballooneval' or 'balloonevalterm' is on. These variables can be
1127 used:
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001128
1129 v:beval_bufnr number of the buffer in which balloon is going to show
1130 v:beval_winnr number of the window
Bram Moolenaar82af8712016-06-04 20:20:29 +02001131 v:beval_winid ID of the window
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001132 v:beval_lnum line number
1133 v:beval_col column number (byte index)
1134 v:beval_text word under or after the mouse pointer
1135
Bram Moolenaar54775062019-07-31 21:07:14 +02001136 Instead of showing a balloon, which is limited to plain text, consider
1137 using a popup window, see |popup_beval_example|. A popup window can
1138 use highlighting and show a border.
1139
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001140 The evaluation of the expression must not have side effects!
1141 Example: >
Bram Moolenaara6c27c42019-05-09 19:16:22 +02001142 function MyBalloonExpr()
Bram Moolenaar45360022005-07-21 21:08:21 +00001143 return 'Cursor is at line ' . v:beval_lnum .
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001144 \', column ' . v:beval_col .
1145 \ ' of file ' . bufname(v:beval_bufnr) .
1146 \ ' on word "' . v:beval_text . '"'
1147 endfunction
1148 set bexpr=MyBalloonExpr()
1149 set ballooneval
1150<
Bram Moolenaar396e8292019-07-13 23:04:31 +02001151 Also see |balloon_show()|, it can be used if the content of the balloon
1152 is to be fetched asynchronously. In that case evaluating
1153 'balloonexpr' should result in an empty string. If you get a balloon
1154 with only "0" you probably didn't return anything from your function.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001155
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00001156 NOTE: The balloon is displayed only if the cursor is on a text
1157 character. If the result of evaluating 'balloonexpr' is not empty,
1158 Vim does not try to send a message to an external debugger (Netbeans
1159 or Sun Workshop).
1160
Bram Moolenaar30b65812012-07-12 22:01:11 +02001161 The expression will be evaluated in the |sandbox| when set from a
1162 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02001163 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001164
1165 It is not allowed to change text or jump to another window while
Bram Moolenaar396e8292019-07-13 23:04:31 +02001166 evaluating 'balloonexpr', see |textlock|.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00001167
Bram Moolenaar87e25fd2005-07-27 21:13:01 +00001168 To check whether line breaks in the balloon text work use this check: >
Bram Moolenaar45360022005-07-21 21:08:21 +00001169 if has("balloon_multiline")
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001170< When they are supported "\n" characters will start a new line. If the
1171 expression evaluates to a |List| this is equal to using each List item
1172 as a string and putting "\n" in between them.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001173 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00001174
Bram Moolenaar165bc692015-07-21 17:53:25 +02001175 *'belloff'* *'bo'*
1176'belloff' 'bo' string (default "")
1177 global
Bram Moolenaar165bc692015-07-21 17:53:25 +02001178 Specifies for which events the bell will not be rung. It is a comma
1179 separated list of items. For each item that is present, the bell
1180 will be silenced. This is most useful to specify specific events in
1181 insert mode to be silenced.
1182
1183 item meaning when present ~
1184 all All events.
1185 backspace When hitting <BS> or <Del> and deleting results in an
1186 error.
1187 cursor Fail to move around using the cursor keys or
1188 <PageUp>/<PageDown> in |Insert-mode|.
1189 complete Error occurred when using |i_CTRL-X_CTRL-K| or
1190 |i_CTRL-X_CTRL-T|.
1191 copy Cannot copy char from insert mode using |i_CTRL-Y| or
1192 |i_CTRL-E|.
1193 ctrlg Unknown Char after <C-G> in Insert mode.
1194 error Other Error occurred (e.g. try to join last line)
1195 (mostly used in |Normal-mode| or |Cmdline-mode|).
1196 esc hitting <Esc> in |Normal-mode|.
1197 ex In |Visual-mode|, hitting |Q| results in an error.
1198 hangul Error occurred when using hangul input.
1199 insertmode Pressing <Esc> in 'insertmode'.
1200 lang Calling the beep module for Lua/Mzscheme/TCL.
1201 mess No output available for |g<|.
1202 showmatch Error occurred for 'showmatch' function.
1203 operator Empty region error |cpo-E|.
1204 register Unknown register after <C-R> in |Insert-mode|.
1205 shell Bell from shell output |:!|.
1206 spell Error happened on spell suggest.
1207 wildmode More matches in |cmdline-completion| available
1208 (depends on the 'wildmode' setting).
1209
Bram Moolenaar036986f2017-03-16 17:41:02 +01001210 This is most useful to fine tune when in Insert mode the bell should
1211 be rung. For Normal mode and Ex commands, the bell is often rung to
Bram Moolenaar165bc692015-07-21 17:53:25 +02001212 indicate that an error occurred. It can be silenced by adding the
1213 "error" keyword.
1214
Bram Moolenaar071d4272004-06-13 20:20:40 +00001215 *'binary'* *'bin'* *'nobinary'* *'nobin'*
1216'binary' 'bin' boolean (default off)
1217 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001218 This option should be set before editing a binary file. You can also
1219 use the |-b| Vim argument. When this option is switched on a few
1220 options will be changed (also when it already was on):
1221 'textwidth' will be set to 0
1222 'wrapmargin' will be set to 0
1223 'modeline' will be off
1224 'expandtab' will be off
1225 Also, 'fileformat' and 'fileformats' options will not be used, the
1226 file is read and written like 'fileformat' was "unix" (a single <NL>
1227 separates lines).
1228 The 'fileencoding' and 'fileencodings' options will not be used, the
1229 file is read without conversion.
1230 NOTE: When you start editing a(nother) file while the 'bin' option is
1231 on, settings from autocommands may change the settings again (e.g.,
1232 'textwidth'), causing trouble when editing. You might want to set
1233 'bin' again when the file has been loaded.
1234 The previous values of these options are remembered and restored when
1235 'bin' is switched from on to off. Each buffer has its own set of
1236 saved option values.
1237 To edit a file with 'binary' set you can use the |++bin| argument.
1238 This avoids you have to do ":set bin", which would have effect for all
1239 files you edit.
1240 When writing a file the <EOL> for the last line is only written if
1241 there was one in the original file (normally Vim appends an <EOL> to
1242 the last line if there is none; this would make the file longer). See
1243 the 'endofline' option.
1244
1245 *'bioskey'* *'biosk'* *'nobioskey'* *'nobiosk'*
1246'bioskey' 'biosk' boolean (default on)
1247 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001248 {only for MS-DOS}
Bram Moolenaarf3913272016-02-25 00:00:01 +01001249 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001250
1251 *'bomb'* *'nobomb'*
1252'bomb' boolean (default off)
1253 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001254 When writing a file and the following conditions are met, a BOM (Byte
1255 Order Mark) is prepended to the file:
1256 - this option is on
1257 - the 'binary' option is off
1258 - 'fileencoding' is "utf-8", "ucs-2", "ucs-4" or one of the little/big
1259 endian variants.
1260 Some applications use the BOM to recognize the encoding of the file.
1261 Often used for UCS-2 files on MS-Windows. For other applications it
1262 causes trouble, for example: "cat file1 file2" makes the BOM of file2
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01001263 appear halfway the resulting file. Gcc doesn't accept a BOM.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001264 When Vim reads a file and 'fileencodings' starts with "ucs-bom", a
1265 check for the presence of the BOM is done and 'bomb' set accordingly.
1266 Unless 'binary' is set, it is removed from the first line, so that you
1267 don't see it when editing. When you don't change the options, the BOM
1268 will be restored when writing the file.
1269
1270 *'breakat'* *'brk'*
1271'breakat' 'brk' string (default " ^I!@*-+;:,./?")
1272 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02001273 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001274 feature}
1275 This option lets you choose which characters might cause a line
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00001276 break if 'linebreak' is on. Only works for ASCII and also for 8-bit
1277 characters when 'encoding' is an 8-bit encoding.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001278
Bram Moolenaar7c1c6db2016-04-03 22:08:05 +02001279 *'breakindent'* *'bri'* *'nobreakindent'* *'nobri'*
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001280'breakindent' 'bri' boolean (default off)
1281 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001282 {not available when compiled without the |+linebreak|
1283 feature}
1284 Every wrapped line will continue visually indented (same amount of
1285 space as the beginning of that line), thus preserving horizontal blocks
1286 of text.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001287 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001288
1289 *'breakindentopt'* *'briopt'*
1290'breakindentopt' 'briopt' string (default empty)
1291 local to window
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001292 {not available when compiled without the |+linebreak|
1293 feature}
1294 Settings for 'breakindent'. It can consist of the following optional
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001295 items and must be separated by a comma:
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001296 min:{n} Minimum text width that will be kept after
1297 applying 'breakindent', even if the resulting
1298 text should normally be narrower. This prevents
1299 text indented almost to the right window border
1300 occupying lot of vertical space when broken.
Bram Moolenaar86b17e92014-07-02 20:00:47 +02001301 shift:{n} After applying 'breakindent', the wrapped line's
1302 beginning will be shifted by the given number of
1303 characters. It permits dynamic French paragraph
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001304 indentation (negative) or emphasizing the line
1305 continuation (positive).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001306 sbr Display the 'showbreak' value before applying the
Bram Moolenaar946e27a2014-06-25 18:50:27 +02001307 additional indent.
1308 The default value for min is 20 and shift is 0.
1309
Bram Moolenaar071d4272004-06-13 20:20:40 +00001310 *'browsedir'* *'bsdir'*
Bram Moolenaar7b0294c2004-10-11 10:16:09 +00001311'browsedir' 'bsdir' string (default: "last")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001312 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02001313 {only for Motif, Athena, GTK, Mac and Win32 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001314 Which directory to use for the file browser:
Bram Moolenaar446cb832008-06-24 21:56:24 +00001315 last Use same directory as with last file browser, where a
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02001316 file was opened or saved.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001317 buffer Use the directory of the related buffer.
1318 current Use the current directory.
1319 {path} Use the specified directory
1320
1321 *'bufhidden'* *'bh'*
1322'bufhidden' 'bh' string (default: "")
1323 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001324 This option specifies what happens when a buffer is no longer
1325 displayed in a window:
1326 <empty> follow the global 'hidden' option
1327 hide hide the buffer (don't unload it), also when 'hidden'
1328 is not set
1329 unload unload the buffer, also when 'hidden' is set or using
1330 |:hide|
1331 delete delete the buffer from the buffer list, also when
1332 'hidden' is set or using |:hide|, like using
1333 |:bdelete|
1334 wipe wipe out the buffer from the buffer list, also when
1335 'hidden' is set or using |:hide|, like using
1336 |:bwipeout|
1337
Bram Moolenaara14de3d2005-01-07 21:48:26 +00001338 CAREFUL: when "unload", "delete" or "wipe" is used changes in a buffer
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01001339 are lost without a warning. Also, these values may break autocommands
1340 that switch between buffers temporarily.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001341 This option is used together with 'buftype' and 'swapfile' to specify
1342 special kinds of buffers. See |special-buffers|.
1343
1344 *'buflisted'* *'bl'* *'nobuflisted'* *'nobl'* *E85*
1345'buflisted' 'bl' boolean (default: on)
1346 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001347 When this option is set, the buffer shows up in the buffer list. If
1348 it is reset it is not used for ":bnext", "ls", the Buffers menu, etc.
1349 This option is reset by Vim for buffers that are only used to remember
1350 a file name or marks. Vim sets it when starting to edit a buffer.
1351 But not when moving to a buffer with ":buffer".
1352
1353 *'buftype'* *'bt'* *E382*
1354'buftype' 'bt' string (default: "")
1355 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001356 The value of this option specifies the type of a buffer:
1357 <empty> normal buffer
1358 nofile buffer which is not related to a file and will not be
1359 written
1360 nowrite buffer which will not be written
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001361 acwrite buffer which will always be written with BufWriteCmd
Bram Moolenaarb5b75622018-03-09 22:22:21 +01001362 autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001363 quickfix quickfix buffer, contains list of errors |:cwindow|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001364 or list of locations |:lwindow|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001365 help help buffer (you are not supposed to set this
1366 manually)
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02001367 terminal buffer for a |terminal| (you are not supposed to set
1368 this manually)
Bram Moolenaarf2732452018-06-03 14:47:35 +02001369 prompt buffer where only the last line can be edited, meant
1370 to be used by a plugin, see |prompt-buffer|
1371 {only when compiled with the |+channel| feature}
Bram Moolenaar4d784b22019-05-25 19:51:39 +02001372 popup buffer used in a popup window, see |popup|.
1373 {only when compiled with the |+textprop| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001374
1375 This option is used together with 'bufhidden' and 'swapfile' to
1376 specify special kinds of buffers. See |special-buffers|.
1377
1378 Be careful with changing this option, it can have many side effects!
1379
Bram Moolenaar280f1262006-01-30 00:14:18 +00001380 A "quickfix" buffer is only used for the error list and the location
1381 list. This value is set by the |:cwindow| and |:lwindow| commands and
1382 you are not supposed to change it.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001383
1384 "nofile" and "nowrite" buffers are similar:
1385 both: The buffer is not to be written to disk, ":w" doesn't
1386 work (":w filename" does work though).
1387 both: The buffer is never considered to be |'modified'|.
1388 There is no warning when the changes will be lost, for
1389 example when you quit Vim.
1390 both: A swap file is only created when using too much memory
1391 (when 'swapfile' has been reset there is never a swap
1392 file).
1393 nofile only: The buffer name is fixed, it is not handled like a
1394 file name. It is not modified in response to a |:cd|
1395 command.
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01001396 both: When using ":e bufname" and already editing "bufname"
1397 the buffer is made empty and autocommands are
1398 triggered as usual for |:edit|.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00001399 *E676*
1400 "acwrite" implies that the buffer name is not related to a file, like
1401 "nofile", but it will be written. Thus, in contrast to "nofile" and
1402 "nowrite", ":w" does work and a modified buffer can't be abandoned
1403 without saving. For writing there must be matching |BufWriteCmd|,
1404 |FileWriteCmd| or |FileAppendCmd| autocommands.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001405
1406 *'casemap'* *'cmp'*
1407'casemap' 'cmp' string (default: "internal,keepascii")
1408 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001409 Specifies details about changing the case of letters. It may contain
1410 these words, separated by a comma:
1411 internal Use internal case mapping functions, the current
1412 locale does not change the case mapping. This only
Bram Moolenaar6f16eb82005-08-23 21:02:42 +00001413 matters when 'encoding' is a Unicode encoding,
1414 "latin1" or "iso-8859-15". When "internal" is
1415 omitted, the towupper() and towlower() system library
1416 functions are used when available.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001417 keepascii For the ASCII characters (0x00 to 0x7f) use the US
1418 case mapping, the current locale is not effective.
1419 This probably only matters for Turkish.
1420
1421 *'cdpath'* *'cd'* *E344* *E346*
1422'cdpath' 'cd' string (default: equivalent to $CDPATH or ",,")
1423 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001424 {not available when compiled without the
1425 |+file_in_path| feature}
1426 This is a list of directories which will be searched when using the
Bram Moolenaar00aa0692019-04-27 20:37:57 +02001427 |:cd|, |:tcd| and |:lcd| commands, provided that the directory being
1428 searched for has a relative path, not an absolute part starting with
1429 "/", "./" or "../", the 'cdpath' option is not used then.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001430 The 'cdpath' option's value has the same form and semantics as
1431 |'path'|. Also see |file-searching|.
1432 The default value is taken from $CDPATH, with a "," prepended to look
1433 in the current directory first.
1434 If the default value taken from $CDPATH is not what you want, include
1435 a modified version of the following command in your vimrc file to
1436 override it: >
1437 :let &cdpath = ',' . substitute(substitute($CDPATH, '[, ]', '\\\0', 'g'), ':', ',', 'g')
1438< This option cannot be set from a |modeline| or in the |sandbox|, for
1439 security reasons.
1440 (parts of 'cdpath' can be passed to the shell to expand file names).
1441
1442 *'cedit'*
1443'cedit' string (Vi default: "", Vim default: CTRL-F)
1444 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001445 The key used in Command-line Mode to open the command-line window.
1446 The default is CTRL-F when 'compatible' is off.
1447 Only non-printable keys are allowed.
1448 The key can be specified as a single character, but it is difficult to
1449 type. The preferred way is to use the <> notation. Examples: >
Bram Moolenaare18dbe82016-07-02 21:42:23 +02001450 :exe "set cedit=\<C-Y>"
1451 :exe "set cedit=\<Esc>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00001452< |Nvi| also has this option, but it only uses the first character.
1453 See |cmdwin|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01001454 NOTE: This option is set to the Vim default value when 'compatible'
1455 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001456
1457 *'charconvert'* *'ccv'* *E202* *E214* *E513*
1458'charconvert' 'ccv' string (default "")
1459 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01001460 {only available when compiled with the |+eval| feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00001461 An expression that is used for character encoding conversion. It is
1462 evaluated when a file that is to be read or has been written has a
1463 different encoding from what is desired.
1464 'charconvert' is not used when the internal iconv() function is
1465 supported and is able to do the conversion. Using iconv() is
1466 preferred, because it is much faster.
1467 'charconvert' is not used when reading stdin |--|, because there is no
1468 file to convert from. You will have to save the text in a file first.
1469 The expression must return zero or an empty string for success,
1470 non-zero for failure.
1471 The possible encoding names encountered are in 'encoding'.
1472 Additionally, names given in 'fileencodings' and 'fileencoding' are
1473 used.
1474 Conversion between "latin1", "unicode", "ucs-2", "ucs-4" and "utf-8"
1475 is done internally by Vim, 'charconvert' is not used for this.
1476 'charconvert' is also used to convert the viminfo file, if the 'c'
1477 flag is present in 'viminfo'. Also used for Unicode conversion.
1478 Example: >
1479 set charconvert=CharConvert()
1480 fun CharConvert()
1481 system("recode "
1482 \ . v:charconvert_from . ".." . v:charconvert_to
1483 \ . " <" . v:fname_in . " >" v:fname_out)
1484 return v:shell_error
1485 endfun
1486< The related Vim variables are:
1487 v:charconvert_from name of the current encoding
1488 v:charconvert_to name of the desired encoding
1489 v:fname_in name of the input file
1490 v:fname_out name of the output file
1491 Note that v:fname_in and v:fname_out will never be the same.
1492 Note that v:charconvert_from and v:charconvert_to may be different
1493 from 'encoding'. Vim internally uses UTF-8 instead of UCS-2 or UCS-4.
1494 Encryption is not done by Vim when using 'charconvert'. If you want
1495 to encrypt the file after conversion, 'charconvert' should take care
1496 of this.
1497 This option cannot be set from a |modeline| or in the |sandbox|, for
1498 security reasons.
1499
1500 *'cindent'* *'cin'* *'nocindent'* *'nocin'*
1501'cindent' 'cin' boolean (default off)
1502 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001503 {not available when compiled without the |+cindent|
1504 feature}
Bram Moolenaar446cb832008-06-24 21:56:24 +00001505 Enables automatic C program indenting. See 'cinkeys' to set the keys
Bram Moolenaar071d4272004-06-13 20:20:40 +00001506 that trigger reindenting in insert mode and 'cinoptions' to set your
1507 preferred indent style.
1508 If 'indentexpr' is not empty, it overrules 'cindent'.
1509 If 'lisp' is not on and both 'indentexpr' and 'equalprg' are empty,
1510 the "=" operator indents using this algorithm rather than calling an
1511 external program.
1512 See |C-indenting|.
1513 When you don't like the way 'cindent' works, try the 'smartindent'
1514 option or 'indentexpr'.
1515 This option is not used when 'paste' is set.
1516 NOTE: This option is reset when 'compatible' is set.
1517
1518 *'cinkeys'* *'cink'*
Bram Moolenaarce655742019-01-31 14:12:57 +01001519'cinkeys' 'cink' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00001520 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001521 {not available when compiled without the |+cindent|
1522 feature}
1523 A list of keys that, when typed in Insert mode, cause reindenting of
1524 the current line. Only used if 'cindent' is on and 'indentexpr' is
1525 empty.
1526 For the format of this option see |cinkeys-format|.
1527 See |C-indenting|.
1528
1529 *'cinoptions'* *'cino'*
1530'cinoptions' 'cino' string (default "")
1531 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001532 {not available when compiled without the |+cindent|
1533 feature}
1534 The 'cinoptions' affect the way 'cindent' reindents lines in a C
1535 program. See |cinoptions-values| for the values of this option, and
1536 |C-indenting| for info on C indenting in general.
1537
1538
1539 *'cinwords'* *'cinw'*
1540'cinwords' 'cinw' string (default "if,else,while,do,for,switch")
1541 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001542 {not available when compiled without both the
1543 |+cindent| and the |+smartindent| features}
1544 These keywords start an extra indent in the next line when
1545 'smartindent' or 'cindent' is set. For 'cindent' this is only done at
1546 an appropriate place (inside {}).
1547 Note that 'ignorecase' isn't used for 'cinwords'. If case doesn't
1548 matter, include the keyword both the uppercase and lowercase:
1549 "if,If,IF".
1550
1551 *'clipboard'* *'cb'*
1552'clipboard' 'cb' string (default "autoselect,exclude:cons\|linux"
1553 for X-windows, "" otherwise)
1554 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001555 {only in GUI versions or when the |+xterm_clipboard|
1556 feature is included}
1557 This option is a list of comma separated names.
1558 These names are recognized:
1559
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001560 *clipboard-unnamed*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001561 unnamed When included, Vim will use the clipboard register '*'
1562 for all yank, delete, change and put operations which
1563 would normally go to the unnamed register. When a
1564 register is explicitly specified, it will always be
1565 used regardless of whether "unnamed" is in 'clipboard'
1566 or not. The clipboard register can always be
1567 explicitly accessed using the "* notation. Also see
1568 |gui-clipboard|.
1569
Bram Moolenaar30b65812012-07-12 22:01:11 +02001570 *clipboard-unnamedplus*
Bram Moolenaar00154502013-02-13 16:15:55 +01001571 unnamedplus A variant of the "unnamed" flag which uses the
1572 clipboard register '+' (|quoteplus|) instead of
1573 register '*' for all yank, delete, change and put
1574 operations which would normally go to the unnamed
1575 register. When "unnamed" is also included to the
1576 option, yank operations (but not delete, change or
1577 put) will additionally copy the text into register
1578 '*'.
Bram Moolenaar81af9252010-12-10 20:35:50 +01001579 Only available with the |+X11| feature.
Bram Moolenaarbf9680e2010-12-02 21:43:16 +01001580 Availability can be checked with: >
1581 if has('unnamedplus')
1582<
Bram Moolenaar30b65812012-07-12 22:01:11 +02001583 *clipboard-autoselect*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001584 autoselect Works like the 'a' flag in 'guioptions': If present,
1585 then whenever Visual mode is started, or the Visual
1586 area extended, Vim tries to become the owner of the
1587 windowing system's global selection or put the
1588 selected text on the clipboard used by the selection
Bram Moolenaarba3ff532018-11-04 14:45:49 +01001589 register "*. See |'go-a'| and |quotestar| for details.
1590 When the GUI is active, the 'a' flag in 'guioptions'
1591 is used, when the GUI is not active, this "autoselect"
1592 flag is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001593 Also applies to the modeless selection.
1594
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001595 *clipboard-autoselectplus*
1596 autoselectplus Like "autoselect" but using the + register instead of
1597 the * register. Compare to the 'P' flag in
1598 'guioptions'.
1599
1600 *clipboard-autoselectml*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001601 autoselectml Like "autoselect", but for the modeless selection
1602 only. Compare to the 'A' flag in 'guioptions'.
1603
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001604 *clipboard-html*
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001605 html When the clipboard contains HTML, use this when
1606 pasting. When putting text on the clipboard, mark it
1607 as HTML. This works to copy rendered HTML from
1608 Firefox, paste it as raw HTML in Vim, select the HTML
1609 in Vim and paste it in a rich edit box in Firefox.
Bram Moolenaar20a825a2010-05-31 21:27:30 +02001610 You probably want to add this only temporarily,
1611 possibly use BufEnter autocommands.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001612 Only supported for GTK version 2 and later.
Bram Moolenaar3a6eaa52009-06-16 13:23:06 +00001613
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02001614 *clipboard-exclude*
Bram Moolenaar071d4272004-06-13 20:20:40 +00001615 exclude:{pattern}
1616 Defines a pattern that is matched against the name of
1617 the terminal 'term'. If there is a match, no
1618 connection will be made to the X server. This is
1619 useful in this situation:
1620 - Running Vim in a console.
1621 - $DISPLAY is set to start applications on another
1622 display.
1623 - You do not want to connect to the X server in the
1624 console, but do want this in a terminal emulator.
1625 To never connect to the X server use: >
1626 exclude:.*
1627< This has the same effect as using the |-X| argument.
1628 Note that when there is no connection to the X server
1629 the window title won't be restored and the clipboard
1630 cannot be accessed.
1631 The value of 'magic' is ignored, {pattern} is
1632 interpreted as if 'magic' was on.
1633 The rest of the option value will be used for
1634 {pattern}, this must be the last entry.
1635
1636 *'cmdheight'* *'ch'*
1637'cmdheight' 'ch' number (default 1)
1638 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001639 Number of screen lines to use for the command-line. Helps avoiding
1640 |hit-enter| prompts.
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00001641 The value of this option is stored with the tab page, so that each tab
1642 page can have a different value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001643
1644 *'cmdwinheight'* *'cwh'*
1645'cmdwinheight' 'cwh' number (default 7)
1646 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001647 Number of screen lines to use for the command-line window. |cmdwin|
1648
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001649 *'colorcolumn'* *'cc'*
1650'colorcolumn' 'cc' string (default "")
1651 local to window
Bram Moolenaar483c5d82010-10-20 18:45:33 +02001652 {not available when compiled without the |+syntax|
1653 feature}
1654 'colorcolumn' is a comma separated list of screen columns that are
1655 highlighted with ColorColumn |hl-ColorColumn|. Useful to align
1656 text. Will make screen redrawing slower.
1657 The screen column can be an absolute number, or a number preceded with
1658 '+' or '-', which is added to or subtracted from 'textwidth'. >
1659
1660 :set cc=+1 " highlight column after 'textwidth'
1661 :set cc=+1,+2,+3 " highlight three columns after 'textwidth'
1662 :hi ColorColumn ctermbg=lightgrey guibg=lightgrey
1663<
1664 When 'textwidth' is zero then the items with '-' and '+' are not used.
1665 A maximum of 256 columns are highlighted.
1666
Bram Moolenaar071d4272004-06-13 20:20:40 +00001667 *'columns'* *'co'* *E594*
1668'columns' 'co' number (default 80 or terminal width)
1669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001670 Number of columns of the screen. Normally this is set by the terminal
Bram Moolenaar7c626922005-02-07 22:01:03 +00001671 initialization and does not have to be set by hand. Also see
1672 |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001673 When Vim is running in the GUI or in a resizable window, setting this
1674 option will cause the window size to be changed. When you only want
1675 to use the size for the GUI, put the command in your |gvimrc| file.
1676 When you set this option and Vim is unable to change the physical
Bram Moolenaar02467872007-05-06 13:22:01 +00001677 number of columns of the display, the display may be messed up. For
1678 the GUI it is always possible and Vim limits the number of columns to
1679 what fits on the screen. You can use this command to get the widest
1680 window possible: >
1681 :set columns=9999
1682< Minimum value is 12, maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001683
1684 *'comments'* *'com'* *E524* *E525*
1685'comments' 'com' string (default
1686 "s1:/*,mb:*,ex:*/,://,b:#,:%,:XCOMM,n:>,fb:-")
1687 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001688 A comma separated list of strings that can start a comment line. See
1689 |format-comments|. See |option-backslash| about using backslashes to
1690 insert a space.
1691
1692 *'commentstring'* *'cms'* *E537*
1693'commentstring' 'cms' string (default "/*%s*/")
1694 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001695 {not available when compiled without the |+folding|
1696 feature}
1697 A template for a comment. The "%s" in the value is replaced with the
1698 comment text. Currently only used to add markers for folding, see
1699 |fold-marker|.
1700
1701 *'compatible'* *'cp'* *'nocompatible'* *'nocp'*
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001702'compatible' 'cp' boolean (default on, off when a |vimrc| or |gvimrc|
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02001703 file is found, reset in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001704 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001705 This option has the effect of making Vim either more Vi-compatible, or
1706 make Vim behave in a more useful way.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001707
Bram Moolenaar071d4272004-06-13 20:20:40 +00001708 This is a special kind of option, because when it's set or reset,
Bram Moolenaar214641f2017-03-05 17:04:09 +01001709 other options are also changed as a side effect.
1710 NOTE: Setting or resetting this option can have a lot of unexpected
1711 effects: Mappings are interpreted in another way, undo behaves
1712 differently, etc. If you set this option in your vimrc file, you
1713 should probably put it at the very start.
1714
Bram Moolenaar071d4272004-06-13 20:20:40 +00001715 By default this option is on and the Vi defaults are used for the
1716 options. This default was chosen for those people who want to use Vim
1717 just like Vi, and don't even (want to) know about the 'compatible'
1718 option.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001719 When a |vimrc| or |gvimrc| file is found while Vim is starting up,
Bram Moolenaard042c562005-06-30 22:04:15 +00001720 this option is switched off, and all options that have not been
1721 modified will be set to the Vim defaults. Effectively, this means
Bram Moolenaar910f66f2006-04-05 20:41:53 +00001722 that when a |vimrc| or |gvimrc| file exists, Vim will use the Vim
Bram Moolenaard042c562005-06-30 22:04:15 +00001723 defaults, otherwise it will use the Vi defaults. (Note: This doesn't
Bram Moolenaar02467872007-05-06 13:22:01 +00001724 happen for the system-wide vimrc or gvimrc file, nor for a file given
1725 with the |-u| argument). Also see |compatible-default| and
1726 |posix-compliance|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001727 You can also set this option with the "-C" argument, and reset it with
1728 "-N". See |-C| and |-N|.
Bram Moolenaar214641f2017-03-05 17:04:09 +01001729 See 'cpoptions' for more fine tuning of Vi compatibility.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001730
Bram Moolenaar214641f2017-03-05 17:04:09 +01001731 When this option is set, numerous other options are set to make Vim as
1732 Vi-compatible as possible. When this option is unset, various options
1733 are set to make Vim more useful. The table below lists all the
1734 options affected.
1735 The {?} column indicates when the options are affected:
1736 + Means that the option is set to the value given in {set value} when
1737 'compatible' is set.
1738 & Means that the option is set to the value given in {set value} when
1739 'compatible' is set AND is set to its Vim default value when
1740 'compatible' is unset.
1741 - Means the option is NOT changed when setting 'compatible' but IS
1742 set to its Vim default when 'compatible' is unset.
1743 The {effect} column summarises the change when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00001744
Bram Moolenaar036986f2017-03-16 17:41:02 +01001745 option ? set value effect ~
Bram Moolenaar214641f2017-03-05 17:04:09 +01001746
1747 'allowrevins' + off no CTRL-_ command
1748 'antialias' + off don't use antialiased fonts
1749 'arabic' + off reset arabic-related options
1750 'arabicshape' + on correct character shapes
1751 'backspace' + "" normal backspace
1752 'backup' + off no backup file
1753 'backupcopy' & Unix: "yes" backup file is a copy
1754 else: "auto" copy or rename backup file
1755 'balloonexpr' + "" text to show in evaluation balloon
1756 'breakindent' + off don't indent when wrapping lines
1757 'cedit' - {unchanged} {set vim default only on resetting 'cp'}
1758 'cindent' + off no C code indentation
1759 'compatible' - {unchanged} {set vim default only on resetting 'cp'}
1760 'copyindent' + off don't copy indent structure
1761 'cpoptions' & (all flags) Vi-compatible flags
1762 'cscopepathcomp'+ 0 don't show directories in tags list
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01001763 'cscoperelative'+ off don't use basename of path as prefix
Bram Moolenaar214641f2017-03-05 17:04:09 +01001764 'cscopetag' + off don't use cscope for ":tag"
Bram Moolenaar036986f2017-03-16 17:41:02 +01001765 'cscopetagorder'+ 0 see |cscopetagorder|
Bram Moolenaar214641f2017-03-05 17:04:09 +01001766 'cscopeverbose' + off see |cscopeverbose|
1767 'delcombine' + off unicode: delete whole char combination
1768 'digraph' + off no digraphs
1769 'esckeys' & off no <Esc>-keys in Insert mode
1770 'expandtab' + off tabs not expanded to spaces
1771 'fileformats' & "" no automatic file format detection,
Bram Moolenaar071d4272004-06-13 20:20:40 +00001772 "dos,unix" except for DOS, Windows and OS/2
Bram Moolenaar214641f2017-03-05 17:04:09 +01001773 'formatexpr' + "" use 'formatprg' for auto-formatting
1774 'formatoptions' & "vt" Vi compatible formatting
1775 'gdefault' + off no default 'g' flag for ":s"
1776 'history' & 0 no commandline history
1777 'hkmap' + off no Hebrew keyboard mapping
1778 'hkmapp' + off no phonetic Hebrew keyboard mapping
1779 'hlsearch' + off no highlighting of search matches
1780 'incsearch' + off no incremental searching
1781 'indentexpr' + "" no indenting by expression
1782 'insertmode' + off do not start in Insert mode
1783 'iskeyword' & "@,48-57,_" keywords contain alphanumeric
Bram Moolenaar071d4272004-06-13 20:20:40 +00001784 characters and '_'
Bram Moolenaar214641f2017-03-05 17:04:09 +01001785 'joinspaces' + on insert 2 spaces after period
1786 'modeline' & off no modelines
1787 'more' & off no pauses in listings
1788 'mzquantum' - {unchanged} {set vim default only on resetting 'cp'}
1789 'numberwidth' & 8 min number of columns for line number
1790 'preserveindent'+ off don't preserve current indent structure
1791 when changing it
1792 'revins' + off no reverse insert
1793 'ruler' + off no ruler
1794 'scrolljump' + 1 no jump scroll
1795 'scrolloff' + 0 no scroll offset
1796 'shelltemp' - {unchanged} {set vim default only on resetting 'cp'}
1797 'shiftround' + off indent not rounded to shiftwidth
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02001798 'shortmess' & "S" no shortening of messages
Bram Moolenaar214641f2017-03-05 17:04:09 +01001799 'showcmd' & off command characters not shown
1800 'showmode' & off current mode not shown
1801 'sidescrolloff' + 0 cursor moves to edge of screen in scroll
1802 'smartcase' + off no automatic ignore case switch
1803 'smartindent' + off no smart indentation
1804 'smarttab' + off no smart tab size
1805 'softtabstop' + 0 tabs are always 'tabstop' positions
1806 'startofline' + on goto startofline with some commands
1807 'tagcase' & "followic" 'ignorecase' when searching tags file
1808 'tagrelative' & off tag file names are not relative
1809 'termguicolors' + off don't use highlight-(guifg|guibg)
1810 'textauto' & off no automatic textmode detection
1811 'textwidth' + 0 no automatic line wrap
1812 'tildeop' + off tilde is not an operator
1813 'ttimeout' + off no terminal timeout
1814 'undofile' + off don't use an undo file
Bram Moolenaar036986f2017-03-16 17:41:02 +01001815 'viminfo' - {unchanged} {set Vim default only on resetting 'cp'}
Bram Moolenaar214641f2017-03-05 17:04:09 +01001816 'virtualedit' + "" cursor can only be placed on characters
1817 'whichwrap' & "" left-right movements don't wrap
1818 'wildchar' & CTRL-E only when the current value is <Tab>
Bram Moolenaar071d4272004-06-13 20:20:40 +00001819 use CTRL-E for cmdline completion
Bram Moolenaar214641f2017-03-05 17:04:09 +01001820 'writebackup' + on or off depends on the |+writebackup| feature
Bram Moolenaar071d4272004-06-13 20:20:40 +00001821
1822 *'complete'* *'cpt'* *E535*
1823'complete' 'cpt' string (default: ".,w,b,u,t,i")
1824 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00001825 This option specifies how keyword completion |ins-completion| works
1826 when CTRL-P or CTRL-N are used. It is also used for whole-line
1827 completion |i_CTRL-X_CTRL-L|. It indicates the type of completion
1828 and the places to scan. It is a comma separated list of flags:
Bram Moolenaar3848e002016-03-19 18:42:29 +01001829 . scan the current buffer ('wrapscan' is ignored)
Bram Moolenaar071d4272004-06-13 20:20:40 +00001830 w scan buffers from other windows
1831 b scan other loaded buffers that are in the buffer list
1832 u scan the unloaded buffers that are in the buffer list
1833 U scan the buffers that are not in the buffer list
1834 k scan the files given with the 'dictionary' option
Bram Moolenaar0b238792006-03-02 22:49:12 +00001835 kspell use the currently active spell checking |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00001836 k{dict} scan the file {dict}. Several "k" flags can be given,
1837 patterns are valid too. For example: >
1838 :set cpt=k/usr/dict/*,k~/spanish
1839< s scan the files given with the 'thesaurus' option
1840 s{tsr} scan the file {tsr}. Several "s" flags can be given, patterns
1841 are valid too.
1842 i scan current and included files
1843 d scan current and included files for defined name or macro
1844 |i_CTRL-X_CTRL-D|
1845 ] tag completion
1846 t same as "]"
1847
1848 Unloaded buffers are not loaded, thus their autocmds |:autocmd| are
1849 not executed, this may lead to unexpected completions from some files
1850 (gzipped files for example). Unloaded buffers are not scanned for
1851 whole-line completion.
1852
1853 The default is ".,w,b,u,t,i", which means to scan:
1854 1. the current buffer
1855 2. buffers in other windows
1856 3. other loaded buffers
1857 4. unloaded buffers
1858 5. tags
1859 6. included files
1860
1861 As you can see, CTRL-N and CTRL-P can be used to do any 'iskeyword'-
Bram Moolenaar582fd852005-03-28 20:58:01 +00001862 based expansion (e.g., dictionary |i_CTRL-X_CTRL-K|, included patterns
1863 |i_CTRL-X_CTRL-I|, tags |i_CTRL-X_CTRL-]| and normal expansions).
Bram Moolenaar071d4272004-06-13 20:20:40 +00001864
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00001865 *'completefunc'* *'cfu'*
1866'completefunc' 'cfu' string (default: empty)
1867 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02001868 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02001869 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00001870 This option specifies a function to be used for Insert mode completion
1871 with CTRL-X CTRL-U. |i_CTRL-X_CTRL-U|
Bram Moolenaar280f1262006-01-30 00:14:18 +00001872 See |complete-functions| for an explanation of how the function is
1873 invoked and what it should return.
Bram Moolenaar166af9b2010-11-16 20:34:40 +01001874 This option cannot be set from a |modeline| or in the |sandbox|, for
1875 security reasons.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00001876
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001877 *'completeslash'* *'csl'*
1878'completeslash' 'csl' string (default: "")
1879 local to buffer
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001880 {only for MS-Windows}
Bram Moolenaarac3150d2019-07-28 16:36:39 +02001881 When this option is set it overrules 'shellslash' for completion:
1882 - When this option is set to "slash", a forward slash is used for path
1883 completion in insert mode. This is useful when editing HTML tag, or
1884 Makefile with 'noshellslash' on Windows.
1885 - When this option is set to "backslash", backslash is used. This is
1886 useful when editing a batch file with 'shellslash' set on Windows.
1887 - When this option is empty, same character is used as for
1888 'shellslash'.
1889 For Insert mode completion the buffer-local value is used. For
1890 command line completion the global value is used.
1891
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001892 *'completeopt'* *'cot'*
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001893'completeopt' 'cot' string (default: "menu,preview")
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001894 global
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001895 A comma separated list of options for Insert mode completion
1896 |ins-completion|. The supported values are:
Bram Moolenaar1c7715d2005-10-03 22:02:18 +00001897
1898 menu Use a popup menu to show the possible completions. The
1899 menu is only shown when there is more than one match and
1900 sufficient colors are available. |ins-completion-menu|
1901
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001902 menuone Use the popup menu also when there is only one match.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00001903 Useful when there is additional information about the
Bram Moolenaar65c923a2006-03-03 22:56:30 +00001904 match, e.g., what file it comes from.
1905
Bram Moolenaarc1e37902006-04-18 21:55:01 +00001906 longest Only insert the longest common text of the matches. If
1907 the menu is displayed you can use CTRL-L to add more
1908 characters. Whether case is ignored depends on the kind
1909 of completion. For buffer text the 'ignorecase' option is
1910 used.
Bram Moolenaarc7453f52006-02-10 23:20:28 +00001911
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001912 preview Show extra information about the currently selected
Bram Moolenaar02467872007-05-06 13:22:01 +00001913 completion in the preview window. Only works in
1914 combination with "menu" or "menuone".
1915
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001916 popup Show extra information about the currently selected
1917 completion in a popup window. Only works in combination
1918 with "menu" or "menuone". Overrides "preview".
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001919 See |'completepopup'| for specifying properties.
Bram Moolenaar2e693a82019-10-16 22:35:02 +02001920 {only works when compiled with the |+textprop| feature}
Bram Moolenaar576a4a62019-08-18 15:25:17 +02001921
Bram Moolenaardca7abe2019-10-20 18:17:57 +02001922 popuphidden
1923 Just like "popup" but initially hide the popup. Use a
1924 |CompleteChanged| autocommand to fetch the info and call
1925 |popup_show()| once the popup has been filled.
1926 See the example at |complete-popuphidden|.
1927 {only works when compiled with the |+textprop| feature}
1928
Bram Moolenaarb6be1e22015-07-10 18:18:40 +02001929 noinsert Do not insert any text for a match until the user selects
1930 a match from the menu. Only works in combination with
1931 "menu" or "menuone". No effect if "longest" is present.
1932
1933 noselect Do not select a match in the menu, force the user to
1934 select one from the menu. Only works in combination with
1935 "menu" or "menuone".
1936
Bram Moolenaar96d2c5b2006-03-11 21:27:59 +00001937
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001938 *'completepopup'* *'cpp'*
1939'completepopup' 'cpp' string (default empty)
1940 global
1941 {not available when compiled without the |+textprop|
1942 or |+quickfix| feature}
1943 When 'completeopt' contains "popup" then this option is used for the
Bram Moolenaar06fe74a2019-08-31 16:20:32 +02001944 properties of the info popup when it is created. You can also use
1945 |popup_findinfo()| and then set properties for an existing info popup
1946 with |popup_setoptions()|. See |complete-popup|.
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02001947
1948
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001949 *'concealcursor'* *'cocu'*
1950'concealcursor' 'cocu' string (default: "")
1951 local to window
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001952 {not available when compiled without the |+conceal|
1953 feature}
1954 Sets the modes in which text in the cursor line can also be concealed.
1955 When the current mode is listed then concealing happens just like in
1956 other lines.
1957 n Normal mode
1958 v Visual mode
1959 i Insert mode
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001960 c Command line editing, for 'incsearch'
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001961
Bram Moolenaare6dc5732010-07-24 23:52:26 +02001962 'v' applies to all lines in the Visual area, not only the cursor.
Bram Moolenaarca8c9862010-07-24 15:00:38 +02001963 A useful value is "nc". This is used in help files. So long as you
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001964 are moving around text is concealed, but when starting to insert text
1965 or selecting a Visual area the concealed text is displayed, so that
1966 you can see what you are doing.
Bram Moolenaarf70e3d62010-07-24 13:15:07 +02001967 Keep in mind that the cursor position is not always where it's
1968 displayed. E.g., when moving vertically it may change column.
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001969
1970
Bram Moolenaar95bafa22018-10-02 13:26:25 +02001971 *'conceallevel'* *'cole'*
1972'conceallevel' 'cole' number (default 0)
Bram Moolenaar860cae12010-06-05 23:22:07 +02001973 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02001974 {not available when compiled without the |+conceal|
1975 feature}
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001976 Determine how text with the "conceal" syntax attribute |:syn-conceal|
1977 is shown:
Bram Moolenaar860cae12010-06-05 23:22:07 +02001978
Bram Moolenaar6df6f472010-07-18 18:04:50 +02001979 Value Effect ~
Bram Moolenaar860cae12010-06-05 23:22:07 +02001980 0 Text is shown normally
Bram Moolenaar477db062010-07-28 18:17:41 +02001981 1 Each block of concealed text is replaced with one
1982 character. If the syntax item does not have a custom
1983 replacement character defined (see |:syn-cchar|) the
1984 character defined in 'listchars' is used (default is a
1985 space).
1986 It is highlighted with the "Conceal" highlight group.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001987 2 Concealed text is completely hidden unless it has a
1988 custom replacement character defined (see
Bram Moolenaar477db062010-07-28 18:17:41 +02001989 |:syn-cchar|).
Bram Moolenaara7781e02010-07-19 20:13:22 +02001990 3 Concealed text is completely hidden.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001991
Bram Moolenaara7781e02010-07-19 20:13:22 +02001992 Note: in the cursor line concealed text is not hidden, so that you can
Bram Moolenaarf5963f72010-07-23 22:10:27 +02001993 edit and copy the text. This can be changed with the 'concealcursor'
1994 option.
Bram Moolenaar860cae12010-06-05 23:22:07 +02001995
Bram Moolenaar071d4272004-06-13 20:20:40 +00001996 *'confirm'* *'cf'* *'noconfirm'* *'nocf'*
1997'confirm' 'cf' boolean (default off)
1998 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00001999 When 'confirm' is on, certain operations that would normally
2000 fail because of unsaved changes to a buffer, e.g. ":q" and ":e",
2001 instead raise a |dialog| asking if you wish to save the current
2002 file(s). You can still use a ! to unconditionally |abandon| a buffer.
2003 If 'confirm' is off you can still activate confirmation for one
2004 command only (this is most useful in mappings) with the |:confirm|
2005 command.
2006 Also see the |confirm()| function and the 'v' flag in 'guioptions'.
2007
2008 *'conskey'* *'consk'* *'noconskey'* *'noconsk'*
2009'conskey' 'consk' boolean (default off)
2010 global
Bram Moolenaarf3913272016-02-25 00:00:01 +01002011 This was for MS-DOS and is no longer supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002012
2013 *'copyindent'* *'ci'* *'nocopyindent'* *'noci'*
2014'copyindent' 'ci' boolean (default off)
2015 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002016 Copy the structure of the existing lines indent when autoindenting a
2017 new line. Normally the new indent is reconstructed by a series of
2018 tabs followed by spaces as required (unless |'expandtab'| is enabled,
2019 in which case only spaces are used). Enabling this option makes the
2020 new line copy whatever characters were used for indenting on the
Bram Moolenaar446cb832008-06-24 21:56:24 +00002021 existing line. 'expandtab' has no effect on these characters, a Tab
2022 remains a Tab. If the new indent is greater than on the existing
Bram Moolenaar071d4272004-06-13 20:20:40 +00002023 line, the remaining space is filled in the normal manner.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002024 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002025 Also see 'preserveindent'.
2026
Bram Moolenaare0fa3742016-02-20 15:47:01 +01002027 *'cpoptions'* *'cpo'* *cpo*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002028'cpoptions' 'cpo' string (Vim default: "aABceFs",
2029 Vi default: all flags)
2030 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002031 A sequence of single character flags. When a character is present
Bram Moolenaar7cba6c02013-09-05 22:13:31 +02002032 this indicates Vi-compatible behavior. This is used for things where
2033 not being Vi-compatible is mostly or sometimes preferred.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002034 'cpoptions' stands for "compatible-options".
2035 Commas can be added for readability.
2036 To avoid problems with flags that are added in the future, use the
2037 "+=" and "-=" feature of ":set" |add-option-flags|.
2038 NOTE: This option is set to the Vi default value when 'compatible' is
2039 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002040 NOTE: This option is set to the POSIX default value at startup when
2041 the Vi default value would be used and the $VIM_POSIX environment
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002042 variable exists |posix|. This means Vim tries to behave like the
2043 POSIX specification.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002044
2045 contains behavior ~
2046 *cpo-a*
2047 a When included, a ":read" command with a file name
2048 argument will set the alternate file name for the
2049 current window.
2050 *cpo-A*
2051 A When included, a ":write" command with a file name
2052 argument will set the alternate file name for the
2053 current window.
2054 *cpo-b*
2055 b "\|" in a ":map" command is recognized as the end of
2056 the map command. The '\' is included in the mapping,
2057 the text after the '|' is interpreted as the next
2058 command. Use a CTRL-V instead of a backslash to
2059 include the '|' in the mapping. Applies to all
2060 mapping, abbreviation, menu and autocmd commands.
2061 See also |map_bar|.
2062 *cpo-B*
2063 B A backslash has no special meaning in mappings,
Bram Moolenaara9604e62018-07-21 05:56:22 +02002064 abbreviations, user commands and the "to" part of the
2065 menu commands. Remove this flag to be able to use a
2066 backslash like a CTRL-V. For example, the command
2067 ":map X \<Esc>" results in X being mapped to:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002068 'B' included: "\^[" (^[ is a real <Esc>)
2069 'B' excluded: "<Esc>" (5 characters)
2070 ('<' excluded in both cases)
2071 *cpo-c*
2072 c Searching continues at the end of any match at the
2073 cursor position, but not further than the start of the
2074 next line. When not present searching continues
2075 one character from the cursor position. With 'c'
2076 "abababababab" only gets three matches when repeating
2077 "/abab", without 'c' there are five matches.
2078 *cpo-C*
2079 C Do not concatenate sourced lines that start with a
2080 backslash. See |line-continuation|.
2081 *cpo-d*
2082 d Using "./" in the 'tags' option doesn't mean to use
2083 the tags file relative to the current file, but the
2084 tags file in the current directory.
2085 *cpo-D*
2086 D Can't use CTRL-K to enter a digraph after Normal mode
2087 commands with a character argument, like |r|, |f| and
2088 |t|.
2089 *cpo-e*
2090 e When executing a register with ":@r", always add a
2091 <CR> to the last line, also when the register is not
2092 linewise. If this flag is not present, the register
2093 is not linewise and the last line does not end in a
2094 <CR>, then the last line is put on the command-line
2095 and can be edited before hitting <CR>.
2096 *cpo-E*
2097 E It is an error when using "y", "d", "c", "g~", "gu" or
2098 "gU" on an Empty region. The operators only work when
Bram Moolenaar15142e22018-04-30 22:19:58 +02002099 at least one character is to be operated on. Example:
Bram Moolenaar071d4272004-06-13 20:20:40 +00002100 This makes "y0" fail in the first column.
2101 *cpo-f*
2102 f When included, a ":read" command with a file name
2103 argument will set the file name for the current buffer,
2104 if the current buffer doesn't have a file name yet.
2105 *cpo-F*
2106 F When included, a ":write" command with a file name
2107 argument will set the file name for the current
2108 buffer, if the current buffer doesn't have a file name
Bram Moolenaarb3480382005-12-11 21:33:32 +00002109 yet. Also see |cpo-P|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002110 *cpo-g*
2111 g Goto line 1 when using ":edit" without argument.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002112 *cpo-H*
2113 H When using "I" on a line with only blanks, insert
2114 before the last blank. Without this flag insert after
2115 the last blank.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002116 *cpo-i*
2117 i When included, interrupting the reading of a file will
2118 leave it modified.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002119 *cpo-I*
2120 I When moving the cursor up or down just after inserting
2121 indent for 'autoindent', do not delete the indent.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002122 *cpo-j*
2123 j When joining lines, only add two spaces after a '.',
2124 not after '!' or '?'. Also see 'joinspaces'.
2125 *cpo-J*
2126 J A |sentence| has to be followed by two spaces after
Bram Moolenaar582fd852005-03-28 20:58:01 +00002127 the '.', '!' or '?'. A <Tab> is not recognized as
Bram Moolenaar071d4272004-06-13 20:20:40 +00002128 white space.
2129 *cpo-k*
2130 k Disable the recognition of raw key codes in
2131 mappings, abbreviations, and the "to" part of menu
2132 commands. For example, if <Key> sends ^[OA (where ^[
2133 is <Esc>), the command ":map X ^[OA" results in X
2134 being mapped to:
2135 'k' included: "^[OA" (3 characters)
2136 'k' excluded: "<Key>" (one key code)
2137 Also see the '<' flag below.
2138 *cpo-K*
2139 K Don't wait for a key code to complete when it is
2140 halfway a mapping. This breaks mapping <F1><F1> when
2141 only part of the second <F1> has been read. It
2142 enables cancelling the mapping by typing <F1><Esc>.
2143 *cpo-l*
2144 l Backslash in a [] range in a search pattern is taken
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002145 literally, only "\]", "\^", "\-" and "\\" are special.
2146 See |/[]|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002147 'l' included: "/[ \t]" finds <Space>, '\' and 't'
2148 'l' excluded: "/[ \t]" finds <Space> and <Tab>
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002149 Also see |cpo-\|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002150 *cpo-L*
2151 L When the 'list' option is set, 'wrapmargin',
2152 'textwidth', 'softtabstop' and Virtual Replace mode
2153 (see |gR|) count a <Tab> as two characters, instead of
2154 the normal behavior of a <Tab>.
2155 *cpo-m*
2156 m When included, a showmatch will always wait half a
2157 second. When not included, a showmatch will wait half
2158 a second or until a character is typed. |'showmatch'|
2159 *cpo-M*
2160 M When excluded, "%" matching will take backslashes into
2161 account. Thus in "( \( )" and "\( ( \)" the outer
2162 parenthesis match. When included "%" ignores
2163 backslashes, which is Vi compatible.
2164 *cpo-n*
Bram Moolenaar64486672010-05-16 15:46:46 +02002165 n When included, the column used for 'number' and
2166 'relativenumber' will also be used for text of wrapped
2167 lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002168 *cpo-o*
2169 o Line offset to search command is not remembered for
2170 next search.
2171 *cpo-O*
2172 O Don't complain if a file is being overwritten, even
2173 when it didn't exist when editing it. This is a
2174 protection against a file unexpectedly created by
2175 someone else. Vi didn't complain about this.
2176 *cpo-p*
2177 p Vi compatible Lisp indenting. When not present, a
2178 slightly better algorithm is used.
Bram Moolenaarb3480382005-12-11 21:33:32 +00002179 *cpo-P*
2180 P When included, a ":write" command that appends to a
2181 file will set the file name for the current buffer, if
2182 the current buffer doesn't have a file name yet and
2183 the 'F' flag is also included |cpo-F|.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002184 *cpo-q*
2185 q When joining multiple lines leave the cursor at the
2186 position where it would be when joining two lines.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002187 *cpo-r*
2188 r Redo ("." command) uses "/" to repeat a search
2189 command, instead of the actually used search string.
2190 *cpo-R*
2191 R Remove marks from filtered lines. Without this flag
2192 marks are kept like |:keepmarks| was used.
2193 *cpo-s*
2194 s Set buffer options when entering the buffer for the
2195 first time. This is like it is in Vim version 3.0.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002196 And it is the default. If not present the options are
Bram Moolenaar071d4272004-06-13 20:20:40 +00002197 set when the buffer is created.
2198 *cpo-S*
2199 S Set buffer options always when entering a buffer
2200 (except 'readonly', 'fileformat', 'filetype' and
2201 'syntax'). This is the (most) Vi compatible setting.
2202 The options are set to the values in the current
2203 buffer. When you change an option and go to another
2204 buffer, the value is copied. Effectively makes the
2205 buffer options global to all buffers.
2206
2207 's' 'S' copy buffer options
2208 no no when buffer created
2209 yes no when buffer first entered (default)
2210 X yes each time when buffer entered (vi comp.)
2211 *cpo-t*
2212 t Search pattern for the tag command is remembered for
2213 "n" command. Otherwise Vim only puts the pattern in
2214 the history for search pattern, but doesn't change the
2215 last used search pattern.
2216 *cpo-u*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002217 u Undo is Vi compatible. See |undo-two-ways|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002218 *cpo-v*
2219 v Backspaced characters remain visible on the screen in
2220 Insert mode. Without this flag the characters are
2221 erased from the screen right away. With this flag the
2222 screen newly typed text overwrites backspaced
2223 characters.
2224 *cpo-w*
2225 w When using "cw" on a blank character, only change one
2226 character and not all blanks until the start of the
2227 next word.
2228 *cpo-W*
2229 W Don't overwrite a readonly file. When omitted, ":w!"
2230 overwrites a readonly file, if possible.
2231 *cpo-x*
2232 x <Esc> on the command-line executes the command-line.
2233 The default in Vim is to abandon the command-line,
2234 because <Esc> normally aborts a command. |c_<Esc>|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002235 *cpo-X*
2236 X When using a count with "R" the replaced text is
2237 deleted only once. Also when repeating "R" with "."
2238 and a count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002239 *cpo-y*
Bram Moolenaard09091d2019-01-17 16:07:22 +01002240 y A yank command can be redone with ".". Think twice if
2241 you really want to use this, it may break some
2242 plugins, since most people expect "." to only repeat a
2243 change.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002244 *cpo-Z*
2245 Z When using "w!" while the 'readonly' option is set,
2246 don't reset 'readonly'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002247 *cpo-!*
2248 ! When redoing a filter command, use the last used
2249 external command, whatever it was. Otherwise the last
2250 used -filter- command is used.
2251 *cpo-$*
2252 $ When making a change to one line, don't redisplay the
2253 line, but put a '$' at the end of the changed text.
2254 The changed text will be overwritten when you type the
2255 new text. The line is redisplayed if you type any
2256 command that moves the cursor from the insertion
2257 point.
2258 *cpo-%*
2259 % Vi-compatible matching is done for the "%" command.
2260 Does not recognize "#if", "#endif", etc.
2261 Does not recognize "/*" and "*/".
2262 Parens inside single and double quotes are also
2263 counted, causing a string that contains a paren to
2264 disturb the matching. For example, in a line like
2265 "if (strcmp("foo(", s))" the first paren does not
2266 match the last one. When this flag is not included,
2267 parens inside single and double quotes are treated
2268 specially. When matching a paren outside of quotes,
2269 everything inside quotes is ignored. When matching a
2270 paren inside quotes, it will find the matching one (if
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002271 there is one). This works very well for C programs.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00002272 This flag is also used for other features, such as
2273 C-indenting.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002274 *cpo--*
2275 - When included, a vertical movement command fails when
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002276 it would go above the first line or below the last
2277 line. Without it the cursor moves to the first or
2278 last line, unless it already was in that line.
Bram Moolenaar7c626922005-02-07 22:01:03 +00002279 Applies to the commands "-", "k", CTRL-P, "+", "j",
Bram Moolenaar8ada17c2006-01-19 22:16:24 +00002280 CTRL-N, CTRL-J and ":1234".
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002281 *cpo-+*
2282 + When included, a ":write file" command will reset the
2283 'modified' flag of the buffer, even though the buffer
2284 itself may still be different from its file.
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002285 *cpo-star*
Bram Moolenaar071d4272004-06-13 20:20:40 +00002286 * Use ":*" in the same way as ":@". When not included,
2287 ":*" is an alias for ":'<,'>", select the Visual area.
2288 *cpo-<*
2289 < Disable the recognition of special key codes in |<>|
2290 form in mappings, abbreviations, and the "to" part of
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002291 menu commands. For example, the command
Bram Moolenaar071d4272004-06-13 20:20:40 +00002292 ":map X <Tab>" results in X being mapped to:
2293 '<' included: "<Tab>" (5 characters)
2294 '<' excluded: "^I" (^I is a real <Tab>)
2295 Also see the 'k' flag above.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002296 *cpo->*
2297 > When appending to a register, put a line break before
2298 the appended text.
Bram Moolenaar8b3e0332011-06-26 05:36:34 +02002299 *cpo-;*
2300 ; When using |,| or |;| to repeat the last |t| search
2301 and the cursor is right in front of the searched
2302 character, the cursor won't move. When not included,
2303 the cursor would skip over it and jump to the
Bram Moolenaarc8734422012-06-01 22:38:45 +02002304 following occurrence.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002305
2306 POSIX flags. These are not included in the Vi default value, except
2307 when $VIM_POSIX was set on startup. |posix|
2308
2309 contains behavior ~
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00002310 *cpo-#*
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002311 # A count before "D", "o" and "O" has no effect.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002312 *cpo-&*
2313 & When ":preserve" was used keep the swap file when
2314 exiting normally while this buffer is still loaded.
2315 This flag is tested when exiting.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002316 *cpo-\*
2317 \ Backslash in a [] range in a search pattern is taken
2318 literally, only "\]" is special See |/[]|
Bram Moolenaar90915b52005-08-21 22:17:52 +00002319 '\' included: "/[ \-]" finds <Space>, '\' and '-'
2320 '\' excluded: "/[ \-]" finds <Space> and '-'
2321 Also see |cpo-l|.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002322 *cpo-/*
2323 / When "%" is used as the replacement string in a |:s|
2324 command, use the previous replacement string. |:s%|
2325 *cpo-{*
2326 { The |{| and |}| commands also stop at a "{" character
2327 at the start of a line.
2328 *cpo-.*
2329 . The ":chdir" and ":cd" commands fail if the current
2330 buffer is modified, unless ! is used. Vim doesn't
2331 need this, since it remembers the full path of an
2332 opened file.
2333 *cpo-bar*
2334 | The value of the $LINES and $COLUMNS environment
2335 variables overrule the terminal size values obtained
2336 with system specific functions.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00002337
Bram Moolenaar071d4272004-06-13 20:20:40 +00002338
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002339 *'cryptmethod'* *'cm'*
Bram Moolenaara86187b2018-12-16 18:20:00 +01002340'cryptmethod' 'cm' string (default "blowfish2")
Bram Moolenaar49771f42010-07-20 17:32:38 +02002341 global or local to buffer |global-local|
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002342 Method used for encryption when the buffer is written to a file:
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002343 *pkzip*
Bram Moolenaar49771f42010-07-20 17:32:38 +02002344 zip PkZip compatible method. A weak kind of encryption.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002345 Backwards compatible with Vim 7.2 and older.
Bram Moolenaar0bbabe82010-05-17 20:32:55 +02002346 *blowfish*
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002347 blowfish Blowfish method. Medium strong encryption but it has
2348 an implementation flaw. Requires Vim 7.3 or later,
2349 files can NOT be read by Vim 7.2 and older. This adds
2350 a "seed" to the file, every time you write the file
2351 the encrypted bytes will be different.
2352 *blowfish2*
2353 blowfish2 Blowfish method. Medium strong encryption. Requires
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01002354 Vim 7.4.401 or later, files can NOT be read by Vim 7.3
Bram Moolenaar8f4ac012014-08-10 13:38:34 +02002355 and older. This adds a "seed" to the file, every time
2356 you write the file the encrypted bytes will be
2357 different. The whole undo file is encrypted, not just
2358 the pieces of text.
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002359
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01002360 You should use "blowfish2", also to re-encrypt older files.
2361
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002362 When reading an encrypted file 'cryptmethod' will be set automatically
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002363 to the detected method of the file being read. Thus if you write it
2364 without changing 'cryptmethod' the same method will be used.
2365 Changing 'cryptmethod' does not mark the file as modified, you have to
Bram Moolenaar49771f42010-07-20 17:32:38 +02002366 explicitly write it, you don't get a warning unless there are other
2367 modifications. Also see |:X|.
2368
2369 When setting the global value to an empty string, it will end up with
Bram Moolenaara86187b2018-12-16 18:20:00 +01002370 the value "blowfish2". When setting the local value to an empty
2371 string the buffer will use the global value.
Bram Moolenaar49771f42010-07-20 17:32:38 +02002372
Bram Moolenaarf50a2532010-05-21 15:36:08 +02002373 When a new encryption method is added in a later version of Vim, and
2374 the current version does not recognize it, you will get *E821* .
Bram Moolenaar49771f42010-07-20 17:32:38 +02002375 You need to edit this file with the later version of Vim.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02002376
2377
Bram Moolenaar071d4272004-06-13 20:20:40 +00002378 *'cscopepathcomp'* *'cspc'*
2379'cscopepathcomp' 'cspc' number (default 0)
2380 global
2381 {not available when compiled without the |+cscope|
2382 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002383 Determines how many components of the path to show in a list of tags.
2384 See |cscopepathcomp|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002385 NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002386
2387 *'cscopeprg'* *'csprg'*
2388'cscopeprg' 'csprg' string (default "cscope")
2389 global
2390 {not available when compiled without the |+cscope|
2391 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002392 Specifies the command to execute cscope. See |cscopeprg|.
2393 This option cannot be set from a |modeline| or in the |sandbox|, for
2394 security reasons.
2395
2396 *'cscopequickfix'* *'csqf'*
2397'cscopequickfix' 'csqf' string (default "")
2398 global
2399 {not available when compiled without the |+cscope|
2400 or |+quickfix| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002401 Specifies whether to use quickfix window to show cscope results.
2402 See |cscopequickfix|.
2403
Bram Moolenaarec7944a2013-06-12 21:29:15 +02002404 *'cscoperelative'* *'csre'* *'nocscoperelative'* *'nocsre'*
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002405'cscoperelative' 'csre' boolean (default off)
2406 global
2407 {not available when compiled without the |+cscope|
2408 feature}
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002409 In the absence of a prefix (-P) for cscope. setting this option enables
2410 to use the basename of cscope.out path as the prefix.
2411 See |cscoperelative|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002412 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar2f982e42011-06-12 20:42:22 +02002413
Bram Moolenaar071d4272004-06-13 20:20:40 +00002414 *'cscopetag'* *'cst'* *'nocscopetag'* *'nocst'*
2415'cscopetag' 'cst' boolean (default off)
2416 global
2417 {not available when compiled without the |+cscope|
2418 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002419 Use cscope for tag commands. See |cscope-options|.
2420 NOTE: This option is reset when 'compatible' is set.
2421
2422 *'cscopetagorder'* *'csto'*
2423'cscopetagorder' 'csto' number (default 0)
2424 global
2425 {not available when compiled without the |+cscope|
2426 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002427 Determines the order in which ":cstag" performs a search. See
2428 |cscopetagorder|.
2429 NOTE: This option is set to 0 when 'compatible' is set.
2430
2431 *'cscopeverbose'* *'csverb'*
2432 *'nocscopeverbose'* *'nocsverb'*
2433'cscopeverbose' 'csverb' boolean (default off)
2434 global
2435 {not available when compiled without the |+cscope|
2436 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00002437 Give messages when adding a cscope database. See |cscopeverbose|.
2438 NOTE: This option is reset when 'compatible' is set.
2439
Bram Moolenaar860cae12010-06-05 23:22:07 +02002440 *'cursorbind'* *'crb'* *'nocursorbind'* *'nocrb'*
2441'cursorbind' 'crb' boolean (default off)
2442 local to window
Bram Moolenaar860cae12010-06-05 23:22:07 +02002443 When this option is set, as the cursor in the current
2444 window moves other cursorbound windows (windows that also have
2445 this option set) move their cursors to the corresponding line and
2446 column. This option is useful for viewing the
2447 differences between two versions of a file (see 'diff'); in diff mode,
2448 inserted and deleted lines (though not characters within a line) are
Bram Moolenaar1a384422010-07-14 19:53:30 +02002449 taken into account.
Bram Moolenaar860cae12010-06-05 23:22:07 +02002450
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002451
2452 *'cursorcolumn'* *'cuc'* *'nocursorcolumn'* *'nocuc'*
2453'cursorcolumn' 'cuc' boolean (default off)
2454 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002455 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002456 feature}
2457 Highlight the screen column of the cursor with CursorColumn
2458 |hl-CursorColumn|. Useful to align text. Will make screen redrawing
2459 slower.
Bram Moolenaar4c3f5362006-04-11 21:38:50 +00002460 If you only want the highlighting in the current window you can use
2461 these autocommands: >
2462 au WinLeave * set nocursorline nocursorcolumn
2463 au WinEnter * set cursorline cursorcolumn
2464<
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002465
2466 *'cursorline'* *'cul'* *'nocursorline'* *'nocul'*
2467'cursorline' 'cul' boolean (default off)
2468 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02002469 {not available when compiled without the |+syntax|
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002470 feature}
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002471 Highlight the text line of the cursor with CursorLine |hl-CursorLine|.
2472 Useful to easily spot the cursor. Will make screen redrawing slower.
Bram Moolenaare2f98b92006-03-29 21:18:24 +00002473 When Visual mode is active the highlighting isn't used to make it
Bram Moolenaar779b74b2006-04-10 14:55:34 +00002474 easier to see the selected text.
Bram Moolenaar600dddc2006-03-12 22:05:10 +00002475
2476
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002477 *'cursorlineopt'* *'culopt'*
Bram Moolenaar017ba072019-09-14 21:01:23 +02002478'cursorlineopt' 'culopt' string (default: "number,line")
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002479 local to window
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002480 {not available when compiled without the |+syntax|
2481 feature}
Bram Moolenaar017ba072019-09-14 21:01:23 +02002482 Comma separated list of settings for how 'cursorline' is displayed.
2483 Valid values:
2484 "line" Highlight the text line of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002485 CursorLine |hl-CursorLine|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002486 "screenline" Highlight only the screen line of the cursor with
2487 CursorLine |hl-CursorLine|.
2488 "number" Highlight the line number of the cursor with
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002489 CursorLineNr |hl-CursorLineNr|.
Bram Moolenaar017ba072019-09-14 21:01:23 +02002490
2491 Special value:
2492 "both" Alias for the values "line,number".
2493
2494 "line" and "screenline" cannot be used together.
Bram Moolenaar410e98a2019-09-09 22:05:49 +02002495
2496
Bram Moolenaar071d4272004-06-13 20:20:40 +00002497 *'debug'*
2498'debug' string (default "")
2499 global
Bram Moolenaar57657d82006-04-21 22:12:41 +00002500 These values can be used:
2501 msg Error messages that would otherwise be omitted will be given
2502 anyway.
2503 throw Error messages that would otherwise be omitted will be given
2504 anyway and also throw an exception and set |v:errmsg|.
2505 beep A message will be given when otherwise only a beep would be
2506 produced.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00002507 The values can be combined, separated by a comma.
Bram Moolenaar57657d82006-04-21 22:12:41 +00002508 "msg" and "throw" are useful for debugging 'foldexpr', 'formatexpr' or
2509 'indentexpr'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002510
2511 *'define'* *'def'*
2512'define' 'def' string (default "^\s*#\s*define")
2513 global or local to buffer |global-local|
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002514 Pattern to be used to find a macro definition. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00002515 pattern, just like for the "/" command. This option is used for the
2516 commands like "[i" and "[d" |include-search|. The 'isident' option is
2517 used to recognize the defined name after the match:
2518 {match with 'define'}{non-ID chars}{defined name}{non-ID char}
2519 See |option-backslash| about inserting backslashes to include a space
2520 or backslash.
2521 The default value is for C programs. For C++ this value would be
2522 useful, to include const type declarations: >
2523 ^\(#\s*define\|[a-z]*\s*const\s*[a-z]*\)
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002524< You can also use "\ze" just before the name and continue the pattern
2525 to check what is following. E.g. for Javascript, if a function is
2526 defined with "func_name = function(args)": >
2527 ^\s*\ze\i\+\s*=\s*function(
2528< If the function is defined with "func_name : function() {...": >
2529 ^\s*\ze\i\+\s*[:]\s*(*function\s*(
Bram Moolenaar071d4272004-06-13 20:20:40 +00002530< When using the ":set" command, you need to double the backslashes!
Bram Moolenaar63b74a82019-03-24 15:09:13 +01002531 To avoid that use `:let` with a single quote string: >
2532 let &l:define = '^\s*\ze\k\+\s*=\s*function('
Bram Moolenaar911ead12019-04-21 00:03:35 +02002533<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002534
2535 *'delcombine'* *'deco'* *'nodelcombine'* *'nodeco'*
2536'delcombine' 'deco' boolean (default off)
2537 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002538 If editing Unicode and this option is set, backspace and Normal mode
2539 "x" delete each combining character on its own. When it is off (the
2540 default) the character along with its combining characters are
2541 deleted.
2542 Note: When 'delcombine' is set "xx" may work different from "2x"!
2543
2544 This is useful for Arabic, Hebrew and many other languages where one
2545 may have combining characters overtop of base characters, and want
2546 to remove only the combining ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01002547 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002548
2549 *'dictionary'* *'dict'*
2550'dictionary' 'dict' string (default "")
2551 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002552 List of file names, separated by commas, that are used to lookup words
2553 for keyword completion commands |i_CTRL-X_CTRL-K|. Each file should
2554 contain a list of words. This can be one word per line, or several
2555 words per line, separated by non-keyword characters (white space is
2556 preferred). Maximum line length is 510 bytes.
Bram Moolenaar259f26a2018-05-15 22:25:40 +02002557
2558 When this option is empty or an entry "spell" is present, and spell
2559 checking is enabled, words in the word lists for the currently active
2560 'spelllang' are used. See |spell|.
2561
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002562 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00002563 after a comma are ignored, otherwise spaces are included in the file
2564 name. See |option-backslash| about using backslashes.
Bram Moolenaard8b02732005-01-14 21:48:43 +00002565 This has nothing to do with the |Dictionary| variable type.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002566 Where to find a list of words?
2567 - On FreeBSD, there is the file "/usr/share/dict/words".
2568 - In the Simtel archive, look in the "msdos/linguist" directory.
2569 - In "miscfiles" of the GNU collection.
2570 The use of |:set+=| and |:set-=| is preferred when adding or removing
2571 directories from the list. This avoids problems when a future version
2572 uses another default.
2573 Backticks cannot be used in this option for security reasons.
2574
2575 *'diff'* *'nodiff'*
2576'diff' boolean (default off)
2577 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00002578 {not available when compiled without the |+diff|
2579 feature}
2580 Join the current window in the group of windows that shows differences
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002581 between files. See |vimdiff|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002582
2583 *'dex'* *'diffexpr'*
2584'diffexpr' 'dex' string (default "")
2585 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002586 {not available when compiled without the |+diff|
2587 feature}
Bram Moolenaare828b762018-09-10 17:51:58 +02002588 Expression which is evaluated to obtain a diff file (either ed-style
2589 or unified-style) from two versions of a file. See |diff-diffexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002590 This option cannot be set from a |modeline| or in the |sandbox|, for
2591 security reasons.
2592
2593 *'dip'* *'diffopt'*
Bram Moolenaarc93262b2018-09-10 21:15:40 +02002594'diffopt' 'dip' string (default "internal,filler")
Bram Moolenaar071d4272004-06-13 20:20:40 +00002595 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002596 {not available when compiled without the |+diff|
2597 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002598 Option settings for diff mode. It can consist of the following items.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002599 All are optional. Items must be separated by a comma.
2600
2601 filler Show filler lines, to keep the text
2602 synchronized with a window that has inserted
2603 lines at the same position. Mostly useful
2604 when windows are side-by-side and 'scrollbind'
2605 is set.
2606
2607 context:{n} Use a context of {n} lines between a change
2608 and a fold that contains unchanged lines.
2609 When omitted a context of six lines is used.
Bram Moolenaarf6b40102019-02-22 15:24:03 +01002610 When using zero the context is actually one,
2611 since folds require a line in between, also
2612 for a deleted line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002613 See |fold-diff|.
2614
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002615 iblank Ignore changes where lines are all blank. Adds
2616 the "-B" flag to the "diff" command if
2617 'diffexpr' is empty. Check the documentation
2618 of the "diff" command for what this does
2619 exactly.
2620 NOTE: the diff windows will get out of sync,
2621 because no differences between blank lines are
2622 taken into account.
2623
Bram Moolenaar071d4272004-06-13 20:20:40 +00002624 icase Ignore changes in case of text. "a" and "A"
2625 are considered the same. Adds the "-i" flag
2626 to the "diff" command if 'diffexpr' is empty.
2627
2628 iwhite Ignore changes in amount of white space. Adds
2629 the "-b" flag to the "diff" command if
2630 'diffexpr' is empty. Check the documentation
2631 of the "diff" command for what this does
2632 exactly. It should ignore adding trailing
2633 white space, but not leading white space.
2634
Bram Moolenaar95bafa22018-10-02 13:26:25 +02002635 iwhiteall Ignore all white space changes. Adds
2636 the "-w" flag to the "diff" command if
2637 'diffexpr' is empty. Check the documentation
2638 of the "diff" command for what this does
2639 exactly.
2640
2641 iwhiteeol Ignore white space changes at end of line.
2642 Adds the "-Z" flag to the "diff" command if
2643 'diffexpr' is empty. Check the documentation
2644 of the "diff" command for what this does
2645 exactly.
2646
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002647 horizontal Start diff mode with horizontal splits (unless
2648 explicitly specified otherwise).
2649
2650 vertical Start diff mode with vertical splits (unless
2651 explicitly specified otherwise).
2652
Bram Moolenaar97ce4192017-12-01 20:35:58 +01002653 hiddenoff Do not use diff mode for a buffer when it
2654 becomes hidden.
2655
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00002656 foldcolumn:{n} Set the 'foldcolumn' option to {n} when
2657 starting diff mode. Without this 2 is used.
2658
Bram Moolenaare828b762018-09-10 17:51:58 +02002659 internal Use the internal diff library. This is
2660 ignored when 'diffexpr' is set. *E960*
2661 When running out of memory when writing a
2662 buffer this item will be ignored for diffs
2663 involving that buffer. Set the 'verbose'
2664 option to see when this happens.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002665
Bram Moolenaare828b762018-09-10 17:51:58 +02002666 indent-heuristic
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002667 Use the indent heuristic for the internal
2668 diff library.
Bram Moolenaare828b762018-09-10 17:51:58 +02002669
2670 algorithm:{text} Use the specified diff algorithm with the
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01002671 internal diff engine. Currently supported
Bram Moolenaare828b762018-09-10 17:51:58 +02002672 algorithms are:
2673 myers the default algorithm
2674 minimal spend extra time to generate the
2675 smallest possible diff
2676 patience patience diff algorithm
2677 histogram histogram diff algorithm
2678
2679 Examples: >
2680 :set diffopt=internal,filler,context:4
Bram Moolenaar071d4272004-06-13 20:20:40 +00002681 :set diffopt=
Bram Moolenaare828b762018-09-10 17:51:58 +02002682 :set diffopt=internal,filler,foldcolumn:3
2683 :set diffopt-=internal " do NOT use the internal diff parser
Bram Moolenaar071d4272004-06-13 20:20:40 +00002684<
2685 *'digraph'* *'dg'* *'nodigraph'* *'nodg'*
2686'digraph' 'dg' boolean (default off)
2687 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002688 {not available when compiled without the |+digraphs|
2689 feature}
2690 Enable the entering of digraphs in Insert mode with {char1} <BS>
2691 {char2}. See |digraphs|.
2692 NOTE: This option is reset when 'compatible' is set.
2693
2694 *'directory'* *'dir'*
2695'directory' 'dir' string (default for Amiga: ".,t:",
Bram Moolenaardfb18412013-12-11 18:53:29 +01002696 for MS-DOS and Win32: ".,$TEMP,c:\tmp,c:\temp"
Bram Moolenaar071d4272004-06-13 20:20:40 +00002697 for Unix: ".,~/tmp,/var/tmp,/tmp")
2698 global
2699 List of directory names for the swap file, separated with commas.
2700 - The swap file will be created in the first directory where this is
2701 possible.
2702 - Empty means that no swap file will be used (recovery is
Bram Moolenaar00e192b2019-10-19 17:01:28 +02002703 impossible!) and no |E303| error will be given.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002704 - A directory "." means to put the swap file in the same directory as
2705 the edited file. On Unix, a dot is prepended to the file name, so
2706 it doesn't show in a directory listing. On MS-Windows the "hidden"
2707 attribute is set and a dot prepended if possible.
Bram Moolenaar009b2592004-10-24 19:18:58 +00002708 - A directory starting with "./" (or ".\" for MS-DOS et al.) means to
Bram Moolenaar071d4272004-06-13 20:20:40 +00002709 put the swap file relative to where the edited file is. The leading
2710 "." is replaced with the path name of the edited file.
Bram Moolenaarb782ba42018-08-07 21:39:28 +02002711 - For Unix and Win32, if a directory ends in two path separators "//",
2712 the swap file name will be built from the complete path to the file
2713 with all path separators substituted to percent '%' signs. This will
2714 ensure file name uniqueness in the preserve directory.
2715 On Win32, it is also possible to end with "\\". However, When a
2716 separating comma is following, you must use "//", since "\\" will
2717 include the comma in the file name. Therefore it is recommended to
2718 use '//', instead of '\\'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002719 - Spaces after the comma are ignored, other spaces are considered part
2720 of the directory name. To have a space at the start of a directory
2721 name, precede it with a backslash.
2722 - To include a comma in a directory name precede it with a backslash.
2723 - A directory name may end in an ':' or '/'.
2724 - Environment variables are expanded |:set_env|.
2725 - Careful with '\' characters, type one before a space, type two to
2726 get one in the option (see |option-backslash|), for example: >
2727 :set dir=c:\\tmp,\ dir\\,with\\,commas,\\\ dir\ with\ spaces
2728< - For backwards compatibility with Vim version 3.0 a '>' at the start
2729 of the option is removed.
2730 Using "." first in the list is recommended. This means that editing
2731 the same file twice will result in a warning. Using "/tmp" on Unix is
2732 discouraged: When the system crashes you lose the swap file.
2733 "/var/tmp" is often not cleared when rebooting, thus is a better
2734 choice than "/tmp". But it can contain a lot of files, your swap
2735 files get lost in the crowd. That is why a "tmp" directory in your
2736 home directory is tried first.
2737 The use of |:set+=| and |:set-=| is preferred when adding or removing
2738 directories from the list. This avoids problems when a future version
2739 uses another default.
2740 This option cannot be set from a |modeline| or in the |sandbox|, for
2741 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002742
2743 *'display'* *'dy'*
Bram Moolenaarbc8801c2016-08-02 21:04:33 +02002744'display' 'dy' string (default "", set to "truncate" in
2745 |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00002746 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002747 Change the way text is displayed. This is comma separated list of
2748 flags:
2749 lastline When included, as much as possible of the last line
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002750 in a window will be displayed. "@@@" is put in the
2751 last columns of the last screen line to indicate the
2752 rest of the line is not displayed.
2753 truncate Like "lastline", but "@@@" is displayed in the first
2754 column of the last screen line. Overrules "lastline".
Bram Moolenaar071d4272004-06-13 20:20:40 +00002755 uhex Show unprintable characters hexadecimal as <xx>
2756 instead of using ^C and ~C.
2757
Bram Moolenaard0796902016-09-16 20:02:31 +02002758 When neither "lastline" nor "truncate" is included, a last line that
Bram Moolenaarad9c2a02016-07-27 23:26:04 +02002759 doesn't fit is replaced with "@" lines.
2760
Bram Moolenaar071d4272004-06-13 20:20:40 +00002761 *'eadirection'* *'ead'*
2762'eadirection' 'ead' string (default "both")
2763 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002764 Tells when the 'equalalways' option applies:
2765 ver vertically, width of windows is not affected
2766 hor horizontally, height of windows is not affected
2767 both width and height of windows is affected
2768
2769 *'ed'* *'edcompatible'* *'noed'* *'noedcompatible'*
2770'edcompatible' 'ed' boolean (default off)
2771 global
2772 Makes the 'g' and 'c' flags of the ":substitute" command to be
2773 toggled each time the flag is given. See |complex-change|. See
2774 also 'gdefault' option.
Bram Moolenaarb4d6c3e2017-05-27 16:45:17 +02002775 Switching this option on may break plugins!
Bram Moolenaar071d4272004-06-13 20:20:40 +00002776
Bram Moolenaar03413f42016-04-12 21:07:15 +02002777 *'emoji'* *'emo'* *'noemoji'* *'noemo'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01002778'emoji' 'emo' boolean (default: on)
2779 global
Bram Moolenaar3848e002016-03-19 18:42:29 +01002780 When on all Unicode emoji characters are considered to be full width.
2781
2782
Bram Moolenaar071d4272004-06-13 20:20:40 +00002783 *'encoding'* *'enc'* *E543*
2784'encoding' 'enc' string (default: "latin1" or value from $LANG)
2785 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002786 Sets the character encoding used inside Vim. It applies to text in
2787 the buffers, registers, Strings in expressions, text stored in the
2788 viminfo file, etc. It sets the kind of characters which Vim can work
2789 with. See |encoding-names| for the possible values.
2790
2791 NOTE: Changing this option will not change the encoding of the
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00002792 existing text in Vim. It may cause non-ASCII text to become invalid.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002793 It should normally be kept at its default value, or set when Vim
Bram Moolenaar02467872007-05-06 13:22:01 +00002794 starts up. See |multibyte|. To reload the menus see |:menutrans|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002795
Bram Moolenaar865242e2010-07-14 21:12:05 +02002796 This option cannot be set from a |modeline|. It would most likely
2797 corrupt the text.
2798
Bram Moolenaar3df01732017-02-17 22:47:16 +01002799 NOTE: For GTK+ 2 or later, it is highly recommended to set 'encoding'
2800 to "utf-8". Although care has been taken to allow different values of
Bram Moolenaar071d4272004-06-13 20:20:40 +00002801 'encoding', "utf-8" is the natural choice for the environment and
2802 avoids unnecessary conversion overhead. "utf-8" has not been made
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002803 the default to prevent different behavior of the GUI and terminal
Bram Moolenaar071d4272004-06-13 20:20:40 +00002804 versions, and to avoid changing the encoding of newly created files
2805 without your knowledge (in case 'fileencodings' is empty).
2806
2807 The character encoding of files can be different from 'encoding'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002808 This is specified with 'fileencoding'. The conversion is done with
Bram Moolenaar071d4272004-06-13 20:20:40 +00002809 iconv() or as specified with 'charconvert'.
2810
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002811 If you need to know whether 'encoding' is a multi-byte encoding, you
2812 can use: >
2813 if has("multi_byte_encoding")
2814<
Bram Moolenaar071d4272004-06-13 20:20:40 +00002815 Normally 'encoding' will be equal to your current locale. This will
2816 be the default if Vim recognizes your environment settings. If
2817 'encoding' is not set to the current locale, 'termencoding' must be
2818 set to convert typed and displayed text. See |encoding-table|.
2819
2820 When you set this option, it fires the |EncodingChanged| autocommand
2821 event so that you can set up fonts if necessary.
2822
2823 When the option is set, the value is converted to lowercase. Thus
2824 you can set it with uppercase values too. Underscores are translated
2825 to '-' signs.
2826 When the encoding is recognized, it is changed to the standard name.
2827 For example "Latin-1" becomes "latin1", "ISO_88592" becomes
2828 "iso-8859-2" and "utf8" becomes "utf-8".
2829
2830 Note: "latin1" is also used when the encoding could not be detected.
2831 This only works when editing files in the same encoding! When the
2832 actual character set is not latin1, make sure 'fileencoding' and
2833 'fileencodings' are empty. When conversion is needed, switch to using
2834 utf-8.
2835
2836 When "unicode", "ucs-2" or "ucs-4" is used, Vim internally uses utf-8.
2837 You don't notice this while editing, but it does matter for the
2838 |viminfo-file|. And Vim expects the terminal to use utf-8 too. Thus
2839 setting 'encoding' to one of these values instead of utf-8 only has
2840 effect for encoding used for files when 'fileencoding' is empty.
2841
Bram Moolenaar661b1822005-07-28 22:36:45 +00002842 When 'encoding' is set to a Unicode encoding, and 'fileencodings' was
2843 not set yet, the default for 'fileencodings' is changed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002844
2845 *'endofline'* *'eol'* *'noendofline'* *'noeol'*
2846'endofline' 'eol' boolean (default on)
2847 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002848 When writing a file and this option is off and the 'binary' option
Bram Moolenaar34d72d42015-07-17 14:18:08 +02002849 is on, or 'fixeol' option is off, no <EOL> will be written for the
2850 last line in the file. This option is automatically set or reset when
2851 starting to edit a new file, depending on whether file has an <EOL>
2852 for the last line in the file. Normally you don't have to set or
2853 reset this option.
2854 When 'binary' is off and 'fixeol' is on the value is not used when
2855 writing the file. When 'binary' is on or 'fixeol' is off it is used
2856 to remember the presence of a <EOL> for the last line in the file, so
2857 that when you write the file the situation from the original file can
2858 be kept. But you can change it if you want to.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002859
2860 *'equalalways'* *'ea'* *'noequalalways'* *'noea'*
2861'equalalways' 'ea' boolean (default on)
2862 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002863 When on, all the windows are automatically made the same size after
Bram Moolenaar009b2592004-10-24 19:18:58 +00002864 splitting or closing a window. This also happens the moment the
2865 option is switched on. When off, splitting a window will reduce the
2866 size of the current window and leave the other windows the same. When
2867 closing a window the extra lines are given to the window next to it
2868 (depending on 'splitbelow' and 'splitright').
Bram Moolenaar071d4272004-06-13 20:20:40 +00002869 When mixing vertically and horizontally split windows, a minimal size
2870 is computed and some windows may be larger if there is room. The
2871 'eadirection' option tells in which direction the size is affected.
Bram Moolenaar67f71312007-08-12 14:55:56 +00002872 Changing the height and width of a window can be avoided by setting
2873 'winfixheight' and 'winfixwidth', respectively.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002874 If a window size is specified when creating a new window sizes are
2875 currently not equalized (it's complicated, but may be implemented in
2876 the future).
Bram Moolenaar071d4272004-06-13 20:20:40 +00002877
2878 *'equalprg'* *'ep'*
2879'equalprg' 'ep' string (default "")
2880 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002881 External program to use for "=" command. When this option is empty
Bram Moolenaar446cb832008-06-24 21:56:24 +00002882 the internal formatting functions are used; either 'lisp', 'cindent'
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002883 or 'indentexpr'. When Vim was compiled without internal formatting,
2884 the "indent" program is used.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002885 Environment variables are expanded |:set_env|. See |option-backslash|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002886 about including spaces and backslashes.
2887 This option cannot be set from a |modeline| or in the |sandbox|, for
2888 security reasons.
2889
2890 *'errorbells'* *'eb'* *'noerrorbells'* *'noeb'*
2891'errorbells' 'eb' boolean (default off)
2892 global
2893 Ring the bell (beep or screen flash) for error messages. This only
2894 makes a difference for error messages, the bell will be used always
2895 for a lot of errors without a message (e.g., hitting <Esc> in Normal
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002896 mode). See 'visualbell' on how to make the bell behave like a beep,
Bram Moolenaar165bc692015-07-21 17:53:25 +02002897 screen flash or do nothing. See 'belloff' to finetune when to ring the
2898 bell.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002899
2900 *'errorfile'* *'ef'*
2901'errorfile' 'ef' string (Amiga default: "AztecC.Err",
2902 others: "errors.err")
2903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002904 {not available when compiled without the |+quickfix|
2905 feature}
2906 Name of the errorfile for the QuickFix mode (see |:cf|).
2907 When the "-q" command-line argument is used, 'errorfile' is set to the
2908 following argument. See |-q|.
2909 NOT used for the ":make" command. See 'makeef' for that.
2910 Environment variables are expanded |:set_env|.
2911 See |option-backslash| about including spaces and backslashes.
2912 This option cannot be set from a |modeline| or in the |sandbox|, for
2913 security reasons.
2914
2915 *'errorformat'* *'efm'*
2916'errorformat' 'efm' string (default is very long)
2917 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00002918 {not available when compiled without the |+quickfix|
2919 feature}
2920 Scanf-like description of the format for the lines in the error file
2921 (see |errorformat|).
2922
2923 *'esckeys'* *'ek'* *'noesckeys'* *'noek'*
2924'esckeys' 'ek' boolean (Vim default: on, Vi default: off)
2925 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002926 Function keys that start with an <Esc> are recognized in Insert
2927 mode. When this option is off, the cursor and function keys cannot be
2928 used in Insert mode if they start with an <Esc>. The advantage of
2929 this is that the single <Esc> is recognized immediately, instead of
2930 after one second. Instead of resetting this option, you might want to
2931 try changing the values for 'timeoutlen' and 'ttimeoutlen'. Note that
2932 when 'esckeys' is off, you can still map anything, but the cursor keys
2933 won't work by default.
2934 NOTE: This option is set to the Vi default value when 'compatible' is
2935 set and to the Vim default value when 'compatible' is reset.
2936
2937 *'eventignore'* *'ei'*
2938'eventignore' 'ei' string (default "")
2939 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002940 A list of autocommand event names, which are to be ignored.
Bram Moolenaarf193fff2006-04-27 00:02:13 +00002941 When set to "all" or when "all" is one of the items, all autocommand
2942 events are ignored, autocommands will not be executed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002943 Otherwise this is a comma separated list of event names. Example: >
2944 :set ei=WinEnter,WinLeave
2945<
2946 *'expandtab'* *'et'* *'noexpandtab'* *'noet'*
2947'expandtab' 'et' boolean (default off)
2948 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002949 In Insert mode: Use the appropriate number of spaces to insert a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00002950 <Tab>. Spaces are used in indents with the '>' and '<' commands and
Bram Moolenaar071d4272004-06-13 20:20:40 +00002951 when 'autoindent' is on. To insert a real tab when 'expandtab' is
2952 on, use CTRL-V<Tab>. See also |:retab| and |ins-expandtab|.
Bram Moolenaarca635012015-09-25 20:34:21 +02002953 This option is reset when the 'paste' option is set and restored when
2954 the 'paste' option is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002955 NOTE: This option is reset when 'compatible' is set.
2956
2957 *'exrc'* *'ex'* *'noexrc'* *'noex'*
2958'exrc' 'ex' boolean (default off)
2959 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00002960 Enables the reading of .vimrc, .exrc and .gvimrc in the current
Bram Moolenaar36f44c22016-08-28 18:17:20 +02002961 directory.
2962
2963 Setting this option is a potential security leak. E.g., consider
2964 unpacking a package or fetching files from github, a .vimrc in there
2965 might be a trojan horse. BETTER NOT SET THIS OPTION!
2966 Instead, define an autocommand in your .vimrc to set options for a
2967 matching directory.
2968
2969 If you do switch this option on you should also consider setting the
2970 'secure' option (see |initialization|).
2971 Also see |.vimrc| and |gui-init|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002972 This option cannot be set from a |modeline| or in the |sandbox|, for
2973 security reasons.
2974
2975 *'fileencoding'* *'fenc'* *E213*
2976'fileencoding' 'fenc' string (default: "")
2977 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00002978 Sets the character encoding for the file of this buffer.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002979
Bram Moolenaar071d4272004-06-13 20:20:40 +00002980 When 'fileencoding' is different from 'encoding', conversion will be
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002981 done when writing the file. For reading see below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002982 When 'fileencoding' is empty, the same value as 'encoding' will be
2983 used (no conversion when reading or writing a file).
Bram Moolenaar214641f2017-03-05 17:04:09 +01002984 No error will be given when the value is set, only when it is used,
2985 only when writing a file.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002986 Conversion will also be done when 'encoding' and 'fileencoding' are
2987 both a Unicode encoding and 'fileencoding' is not utf-8. That's
2988 because internally Unicode is always stored as utf-8.
Bram Moolenaar071d4272004-06-13 20:20:40 +00002989 WARNING: Conversion can cause loss of information! When
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01002990 'encoding' is "utf-8" or another Unicode encoding, conversion
2991 is most likely done in a way that the reverse conversion
2992 results in the same text. When 'encoding' is not "utf-8" some
2993 characters may be lost!
Bram Moolenaar865242e2010-07-14 21:12:05 +02002994
Bram Moolenaar071d4272004-06-13 20:20:40 +00002995 See 'encoding' for the possible values. Additionally, values may be
2996 specified that can be handled by the converter, see
2997 |mbyte-conversion|.
Bram Moolenaar865242e2010-07-14 21:12:05 +02002998
Bram Moolenaar071d4272004-06-13 20:20:40 +00002999 When reading a file 'fileencoding' will be set from 'fileencodings'.
3000 To read a file in a certain encoding it won't work by setting
Bram Moolenaar02467872007-05-06 13:22:01 +00003001 'fileencoding', use the |++enc| argument. One exception: when
3002 'fileencodings' is empty the value of 'fileencoding' is used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003003 For a new file the global value of 'fileencoding' is used.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003004
Bram Moolenaar071d4272004-06-13 20:20:40 +00003005 Prepending "8bit-" and "2byte-" has no meaning here, they are ignored.
3006 When the option is set, the value is converted to lowercase. Thus
3007 you can set it with uppercase values too. '_' characters are
3008 replaced with '-'. If a name is recognized from the list for
3009 'encoding', it is replaced by the standard name. For example
3010 "ISO8859-2" becomes "iso-8859-2".
Bram Moolenaar865242e2010-07-14 21:12:05 +02003011
Bram Moolenaar071d4272004-06-13 20:20:40 +00003012 When this option is set, after starting to edit a file, the 'modified'
3013 option is set, because the file would be different when written.
Bram Moolenaar865242e2010-07-14 21:12:05 +02003014
3015 Keep in mind that changing 'fenc' from a modeline happens
3016 AFTER the text has been read, thus it applies to when the file will be
3017 written. If you do set 'fenc' in a modeline, you might want to set
3018 'nomodified' to avoid not being able to ":q".
3019
Bram Moolenaar071d4272004-06-13 20:20:40 +00003020 This option can not be changed when 'modifiable' is off.
3021
3022 *'fe'*
3023 NOTE: Before version 6.0 this option specified the encoding for the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003024 whole of Vim, this was a mistake. Now use 'encoding' instead. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003025 old short name was 'fe', which is no longer used.
3026
3027 *'fileencodings'* *'fencs'*
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003028'fileencodings' 'fencs' string (default: "ucs-bom",
3029 "ucs-bom,utf-8,default,latin1" when
3030 'encoding' is set to a Unicode value)
Bram Moolenaar071d4272004-06-13 20:20:40 +00003031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003032 This is a list of character encodings considered when starting to edit
3033 an existing file. When a file is read, Vim tries to use the first
3034 mentioned character encoding. If an error is detected, the next one
3035 in the list is tried. When an encoding is found that works,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003036 'fileencoding' is set to it. If all fail, 'fileencoding' is set to
Bram Moolenaar071d4272004-06-13 20:20:40 +00003037 an empty string, which means the value of 'encoding' is used.
3038 WARNING: Conversion can cause loss of information! When
3039 'encoding' is "utf-8" (or one of the other Unicode variants)
3040 conversion is most likely done in a way that the reverse
3041 conversion results in the same text. When 'encoding' is not
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003042 "utf-8" some non-ASCII characters may be lost! You can use
3043 the |++bad| argument to specify what is done with characters
3044 that can't be converted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003045 For an empty file or a file with only ASCII characters most encodings
3046 will work and the first entry of 'fileencodings' will be used (except
3047 "ucs-bom", which requires the BOM to be present). If you prefer
3048 another encoding use an BufReadPost autocommand event to test if your
3049 preferred encoding is to be used. Example: >
3050 au BufReadPost * if search('\S', 'w') == 0 |
3051 \ set fenc=iso-2022-jp | endif
3052< This sets 'fileencoding' to "iso-2022-jp" if the file does not contain
3053 non-blank characters.
Bram Moolenaarc6d8db72005-12-13 20:04:55 +00003054 When the |++enc| argument is used then the value of 'fileencodings' is
3055 not used.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003056 Note that 'fileencodings' is not used for a new file, the global value
3057 of 'fileencoding' is used instead. You can set it with: >
3058 :setglobal fenc=iso-8859-2
3059< This means that a non-existing file may get a different encoding than
3060 an empty file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003061 The special value "ucs-bom" can be used to check for a Unicode BOM
3062 (Byte Order Mark) at the start of the file. It must not be preceded
3063 by "utf-8" or another Unicode encoding for this to work properly.
3064 An entry for an 8-bit encoding (e.g., "latin1") should be the last,
3065 because Vim cannot detect an error, thus the encoding is always
3066 accepted.
Bram Moolenaar1cd871b2004-12-19 22:46:22 +00003067 The special value "default" can be used for the encoding from the
3068 environment. This is the default value for 'encoding'. It is useful
3069 when 'encoding' is set to "utf-8" and your environment uses a
3070 non-latin1 encoding, such as Russian.
Bram Moolenaarca003e12006-03-17 23:19:38 +00003071 When 'encoding' is "utf-8" and a file contains an illegal byte
3072 sequence it won't be recognized as UTF-8. You can use the |8g8|
3073 command to find the illegal byte sequence.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003074 WRONG VALUES: WHAT'S WRONG:
3075 latin1,utf-8 "latin1" will always be used
3076 utf-8,ucs-bom,latin1 BOM won't be recognized in an utf-8
3077 file
3078 cp1250,latin1 "cp1250" will always be used
3079 If 'fileencodings' is empty, 'fileencoding' is not modified.
3080 See 'fileencoding' for the possible values.
3081 Setting this option does not have an effect until the next time a file
3082 is read.
3083
3084 *'fileformat'* *'ff'*
Bram Moolenaar00590742019-02-15 21:06:09 +01003085'fileformat' 'ff' string (MS-Windows default: "dos",
3086 Unix, macOS default: "unix")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003087 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003088 This gives the <EOL> of the current buffer, which is used for
3089 reading/writing the buffer from/to a file:
3090 dos <CR> <NL>
3091 unix <NL>
3092 mac <CR>
3093 When "dos" is used, CTRL-Z at the end of a file is ignored.
3094 See |file-formats| and |file-read|.
3095 For the character encoding of the file see 'fileencoding'.
3096 When 'binary' is set, the value of 'fileformat' is ignored, file I/O
Bram Moolenaarbf884932013-04-05 22:26:15 +02003097 works like it was set to "unix".
Bram Moolenaar071d4272004-06-13 20:20:40 +00003098 This option is set automatically when starting to edit a file and
3099 'fileformats' is not empty and 'binary' is off.
3100 When this option is set, after starting to edit a file, the 'modified'
3101 option is set, because the file would be different when written.
3102 This option can not be changed when 'modifiable' is off.
3103 For backwards compatibility: When this option is set to "dos",
3104 'textmode' is set, otherwise 'textmode' is reset.
3105
3106 *'fileformats'* *'ffs'*
3107'fileformats' 'ffs' string (default:
Bram Moolenaar00590742019-02-15 21:06:09 +01003108 Vim+Vi MS-Windows: "dos,unix",
3109 Vim Unix, macOS: "unix,dos",
Bram Moolenaar071d4272004-06-13 20:20:40 +00003110 Vi Cygwin: "unix,dos",
3111 Vi others: "")
3112 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003113 This gives the end-of-line (<EOL>) formats that will be tried when
3114 starting to edit a new buffer and when reading a file into an existing
3115 buffer:
3116 - When empty, the format defined with 'fileformat' will be used
3117 always. It is not set automatically.
3118 - When set to one name, that format will be used whenever a new buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003119 is opened. 'fileformat' is set accordingly for that buffer. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00003120 'fileformats' name will be used when a file is read into an existing
3121 buffer, no matter what 'fileformat' for that buffer is set to.
3122 - When more than one name is present, separated by commas, automatic
3123 <EOL> detection will be done when reading a file. When starting to
3124 edit a file, a check is done for the <EOL>:
3125 1. If all lines end in <CR><NL>, and 'fileformats' includes "dos",
3126 'fileformat' is set to "dos".
3127 2. If a <NL> is found and 'fileformats' includes "unix", 'fileformat'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003128 is set to "unix". Note that when a <NL> is found without a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003129 preceding <CR>, "unix" is preferred over "dos".
Bram Moolenaar2b8388b2015-02-28 13:11:45 +01003130 3. If 'fileformat' has not yet been set, and if a <CR> is found, and
3131 if 'fileformats' includes "mac", 'fileformat' is set to "mac".
Bram Moolenaar00659062010-09-21 22:34:02 +02003132 This means that "mac" is only chosen when:
3133 "unix" is not present or no <NL> is found in the file, and
3134 "dos" is not present or no <CR><NL> is found in the file.
3135 Except: if "unix" was chosen, but there is a <CR> before
3136 the first <NL>, and there appear to be more <CR>s than <NL>s in
Bram Moolenaar166af9b2010-11-16 20:34:40 +01003137 the first few lines, "mac" is used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003138 4. If 'fileformat' is still not set, the first name from
3139 'fileformats' is used.
3140 When reading a file into an existing buffer, the same is done, but
3141 this happens like 'fileformat' has been set appropriately for that
3142 file only, the option is not changed.
3143 When 'binary' is set, the value of 'fileformats' is not used.
3144
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01003145 When Vim starts up with an empty buffer the first item is used. You
3146 can overrule this by setting 'fileformat' in your .vimrc.
Bram Moolenaar81af9252010-12-10 20:35:50 +01003147
Bram Moolenaar071d4272004-06-13 20:20:40 +00003148 For systems with a Dos-like <EOL> (<CR><NL>), when reading files that
3149 are ":source"ed and for vimrc files, automatic <EOL> detection may be
3150 done:
3151 - When 'fileformats' is empty, there is no automatic detection. Dos
3152 format will be used.
3153 - When 'fileformats' is set to one or more names, automatic detection
3154 is done. This is based on the first <NL> in the file: If there is a
3155 <CR> in front of it, Dos format is used, otherwise Unix format is
3156 used.
3157 Also see |file-formats|.
3158 For backwards compatibility: When this option is set to an empty
3159 string or one format (no comma is included), 'textauto' is reset,
3160 otherwise 'textauto' is set.
3161 NOTE: This option is set to the Vi default value when 'compatible' is
3162 set and to the Vim default value when 'compatible' is reset.
3163
Bram Moolenaarbf884932013-04-05 22:26:15 +02003164 *'fileignorecase'* *'fic'* *'nofileignorecase'* *'nofic'*
3165'fileignorecase' 'fic' boolean (default on for systems where case in file
3166 names is normally ignored)
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003167 global
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01003168 When set case is ignored when using file names and directories.
3169 See 'wildignorecase' for only ignoring case when doing completion.
3170
Bram Moolenaar071d4272004-06-13 20:20:40 +00003171 *'filetype'* *'ft'*
3172'filetype' 'ft' string (default: "")
3173 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00003174 When this option is set, the FileType autocommand event is triggered.
3175 All autocommands that match with the value of this option will be
3176 executed. Thus the value of 'filetype' is used in place of the file
3177 name.
3178 Otherwise this option does not always reflect the current file type.
3179 This option is normally set when the file type is detected. To enable
3180 this use the ":filetype on" command. |:filetype|
3181 Setting this option to a different value is most useful in a modeline,
3182 for a file for which the file type is not automatically recognized.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003183 Example, for in an IDL file:
3184 /* vim: set filetype=idl : */ ~
3185 |FileType| |filetypes|
3186 When a dot appears in the value then this separates two filetype
3187 names. Example:
3188 /* vim: set filetype=c.doxygen : */ ~
3189 This will use the "c" filetype first, then the "doxygen" filetype.
3190 This works both for filetype plugins and for syntax files. More than
3191 one dot may appear.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003192 This option is not copied to another buffer, independent of the 's' or
3193 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003194 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003195
3196 *'fillchars'* *'fcs'*
3197'fillchars' 'fcs' string (default "vert:|,fold:-")
3198 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003199 {not available when compiled without the |+folding|
3200 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003201 Characters to fill the statuslines and vertical separators.
3202 It is a comma separated list of items:
3203
3204 item default Used for ~
3205 stl:c ' ' or '^' statusline of the current window
Bram Moolenaar38a55632016-02-15 22:07:32 +01003206 stlnc:c ' ' or '=' statusline of the non-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003207 vert:c '|' vertical separators |:vsplit|
3208 fold:c '-' filling 'foldtext'
3209 diff:c '-' deleted lines of the 'diff' option
3210
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003211 Any one that is omitted will fall back to the default. For "stl" and
Bram Moolenaar38a55632016-02-15 22:07:32 +01003212 "stlnc" the space will be used when there is highlighting, '^' or '='
Bram Moolenaar071d4272004-06-13 20:20:40 +00003213 otherwise.
3214
3215 Example: >
Bram Moolenaar38a55632016-02-15 22:07:32 +01003216 :set fillchars=stl:^,stlnc:=,vert:\|,fold:-,diff:-
Bram Moolenaar071d4272004-06-13 20:20:40 +00003217< This is similar to the default, except that these characters will also
3218 be used when there is highlighting.
3219
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003220 for "stl" and "stlnc" only single-byte values are supported.
3221
Bram Moolenaar071d4272004-06-13 20:20:40 +00003222 The highlighting used for these items:
3223 item highlight group ~
3224 stl:c StatusLine |hl-StatusLine|
3225 stlnc:c StatusLineNC |hl-StatusLineNC|
3226 vert:c VertSplit |hl-VertSplit|
3227 fold:c Folded |hl-Folded|
3228 diff:c DiffDelete |hl-DiffDelete|
3229
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003230 *'fixendofline'* *'fixeol'* *'nofixendofline'* *'nofixeol'*
3231'fixendofline' 'fixeol' boolean (default on)
3232 local to buffer
Bram Moolenaar34d72d42015-07-17 14:18:08 +02003233 When writing a file and this option is on, <EOL> at the end of file
3234 will be restored if missing. Turn this option off if you want to
3235 preserve the situation from the original file.
3236 When the 'binary' option is set the value of this option doesn't
3237 matter.
3238 See the 'endofline' option.
3239
Bram Moolenaar071d4272004-06-13 20:20:40 +00003240 *'fkmap'* *'fk'* *'nofkmap'* *'nofk'*
3241'fkmap' 'fk' boolean (default off) *E198*
3242 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003243 {only available when compiled with the |+rightleft|
3244 feature}
Bram Moolenaar14184a32019-02-16 15:10:30 +01003245 This option was for using Farsi, which has been removed. See
3246 |farsi.txt|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003247
3248 *'foldclose'* *'fcl'*
3249'foldclose' 'fcl' string (default "")
3250 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003251 {not available when compiled without the |+folding|
3252 feature}
3253 When set to "all", a fold is closed when the cursor isn't in it and
3254 its level is higher than 'foldlevel'. Useful if you want folds to
3255 automatically close when moving out of them.
3256
3257 *'foldcolumn'* *'fdc'*
3258'foldcolumn' 'fdc' number (default 0)
3259 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003260 {not available when compiled without the |+folding|
3261 feature}
3262 When non-zero, a column with the specified width is shown at the side
3263 of the window which indicates open and closed folds. The maximum
3264 value is 12.
3265 See |folding|.
3266
3267 *'foldenable'* *'fen'* *'nofoldenable'* *'nofen'*
3268'foldenable' 'fen' boolean (default on)
3269 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003270 {not available when compiled without the |+folding|
3271 feature}
3272 When off, all folds are open. This option can be used to quickly
3273 switch between showing all text unfolded and viewing the text with
3274 folds (including manually opened or closed folds). It can be toggled
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003275 with the |zi| command. The 'foldcolumn' will remain blank when
Bram Moolenaar071d4272004-06-13 20:20:40 +00003276 'foldenable' is off.
3277 This option is set by commands that create a new fold or close a fold.
3278 See |folding|.
3279
3280 *'foldexpr'* *'fde'*
3281'foldexpr' 'fde' string (default: "0")
3282 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003283 {not available when compiled without the |+folding|
Bram Moolenaardb84e452010-08-15 13:50:43 +02003284 or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003285 The expression used for when 'foldmethod' is "expr". It is evaluated
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003286 for each line to obtain its fold level. See |fold-expr|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00003287
Bram Moolenaar30b65812012-07-12 22:01:11 +02003288 The expression will be evaluated in the |sandbox| if set from a
3289 modeline, see |sandbox-option|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003290 This option can't be set from a |modeline| when the 'diff' option is
Bram Moolenaar110289e2019-05-23 15:38:06 +02003291 on or the 'modelineexpr' option is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003292
3293 It is not allowed to change text or jump to another window while
3294 evaluating 'foldexpr' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003295
3296 *'foldignore'* *'fdi'*
3297'foldignore' 'fdi' string (default: "#")
3298 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003299 {not available when compiled without the |+folding|
3300 feature}
3301 Used only when 'foldmethod' is "indent". Lines starting with
3302 characters in 'foldignore' will get their fold level from surrounding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003303 lines. White space is skipped before checking for this character.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003304 The default "#" works well for C programs. See |fold-indent|.
3305
3306 *'foldlevel'* *'fdl'*
3307'foldlevel' 'fdl' number (default: 0)
3308 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003309 {not available when compiled without the |+folding|
3310 feature}
3311 Sets the fold level: Folds with a higher level will be closed.
3312 Setting this option to zero will close all folds. Higher numbers will
3313 close fewer folds.
3314 This option is set by commands like |zm|, |zM| and |zR|.
3315 See |fold-foldlevel|.
3316
3317 *'foldlevelstart'* *'fdls'*
3318'foldlevelstart' 'fdls' number (default: -1)
3319 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003320 {not available when compiled without the |+folding|
3321 feature}
3322 Sets 'foldlevel' when starting to edit another buffer in a window.
3323 Useful to always start editing with all folds closed (value zero),
3324 some folds closed (one) or no folds closed (99).
3325 This is done before reading any modeline, thus a setting in a modeline
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003326 overrules this option. Starting to edit a file for |diff-mode| also
Bram Moolenaar071d4272004-06-13 20:20:40 +00003327 ignores this option and closes all folds.
3328 It is also done before BufReadPre autocommands, to allow an autocmd to
3329 overrule the 'foldlevel' value for specific files.
3330 When the value is negative, it is not used.
3331
3332 *'foldmarker'* *'fmr'* *E536*
3333'foldmarker' 'fmr' string (default: "{{{,}}}")
3334 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003335 {not available when compiled without the |+folding|
3336 feature}
3337 The start and end marker used when 'foldmethod' is "marker". There
3338 must be one comma, which separates the start and end marker. The
3339 marker is a literal string (a regular expression would be too slow).
3340 See |fold-marker|.
3341
3342 *'foldmethod'* *'fdm'*
3343'foldmethod' 'fdm' string (default: "manual")
3344 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003345 {not available when compiled without the |+folding|
3346 feature}
3347 The kind of folding used for the current window. Possible values:
3348 |fold-manual| manual Folds are created manually.
3349 |fold-indent| indent Lines with equal indent form a fold.
3350 |fold-expr| expr 'foldexpr' gives the fold level of a line.
3351 |fold-marker| marker Markers are used to specify folds.
3352 |fold-syntax| syntax Syntax highlighting items specify folds.
3353 |fold-diff| diff Fold text that is not changed.
3354
3355 *'foldminlines'* *'fml'*
3356'foldminlines' 'fml' number (default: 1)
3357 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003358 {not available when compiled without the |+folding|
3359 feature}
Bram Moolenaar00654022011-02-25 14:42:19 +01003360 Sets the number of screen lines above which a fold can be displayed
3361 closed. Also for manually closed folds. With the default value of
3362 one a fold can only be closed if it takes up two or more screen lines.
3363 Set to zero to be able to close folds of just one screen line.
Bram Moolenaar446beb42011-05-10 17:18:44 +02003364 Note that this only has an effect on what is displayed. After using
Bram Moolenaar071d4272004-06-13 20:20:40 +00003365 "zc" to close a fold, which is displayed open because it's smaller
3366 than 'foldminlines', a following "zc" may close a containing fold.
3367
3368 *'foldnestmax'* *'fdn'*
3369'foldnestmax' 'fdn' number (default: 20)
3370 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003371 {not available when compiled without the |+folding|
3372 feature}
3373 Sets the maximum nesting of folds for the "indent" and "syntax"
3374 methods. This avoids that too many folds will be created. Using more
3375 than 20 doesn't work, because the internal limit is 20.
3376
3377 *'foldopen'* *'fdo'*
3378'foldopen' 'fdo' string (default: "block,hor,mark,percent,quickfix,
3379 search,tag,undo")
3380 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003381 {not available when compiled without the |+folding|
3382 feature}
3383 Specifies for which type of commands folds will be opened, if the
3384 command moves the cursor into a closed fold. It is a comma separated
3385 list of items.
Bram Moolenaar05365702010-10-27 18:34:44 +02003386 NOTE: When the command is part of a mapping this option is not used.
3387 Add the |zv| command to the mapping to get the same effect.
3388 (rationale: the mapping may want to control opening folds itself)
3389
Bram Moolenaar071d4272004-06-13 20:20:40 +00003390 item commands ~
3391 all any
3392 block "(", "{", "[[", "[{", etc.
3393 hor horizontal movements: "l", "w", "fx", etc.
3394 insert any command in Insert mode
3395 jump far jumps: "G", "gg", etc.
3396 mark jumping to a mark: "'m", CTRL-O, etc.
3397 percent "%"
3398 quickfix ":cn", ":crew", ":make", etc.
3399 search search for a pattern: "/", "n", "*", "gd", etc.
3400 (not for a search pattern in a ":" command)
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003401 Also for |[s| and |]s|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003402 tag jumping to a tag: ":ta", CTRL-T, etc.
3403 undo undo or redo: "u" and CTRL-R
Bram Moolenaar071d4272004-06-13 20:20:40 +00003404 When a movement command is used for an operator (e.g., "dl" or "y%")
3405 this option is not used. This means the operator will include the
3406 whole closed fold.
3407 Note that vertical movements are not here, because it would make it
3408 very difficult to move onto a closed fold.
3409 In insert mode the folds containing the cursor will always be open
3410 when text is inserted.
3411 To close folds you can re-apply 'foldlevel' with the |zx| command or
3412 set the 'foldclose' option to "all".
3413
3414 *'foldtext'* *'fdt'*
3415'foldtext' 'fdt' string (default: "foldtext()")
3416 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00003417 {not available when compiled without the |+folding|
3418 feature}
3419 An expression which is used to specify the text displayed for a closed
3420 fold. See |fold-foldtext|.
3421
Bram Moolenaar30b65812012-07-12 22:01:11 +02003422 The expression will be evaluated in the |sandbox| if set from a
3423 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003424 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00003425
3426 It is not allowed to change text or jump to another window while
3427 evaluating 'foldtext' |textlock|.
3428
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003429 *'formatexpr'* *'fex'*
3430'formatexpr' 'fex' string (default "")
3431 local to buffer
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003432 {not available when compiled without the |+eval|
3433 feature}
3434 Expression which is evaluated to format a range of lines for the |gq|
3435 operator or automatic formatting (see 'formatoptions'). When this
3436 option is empty 'formatprg' is used.
3437
3438 The |v:lnum| variable holds the first line to be formatted.
3439 The |v:count| variable holds the number of lines to be formatted.
3440 The |v:char| variable holds the character that is going to be
3441 inserted if the expression is being evaluated due to
3442 automatic formatting. This can be empty. Don't insert
3443 it yet!
3444
3445 Example: >
3446 :set formatexpr=mylang#Format()
3447< This will invoke the mylang#Format() function in the
3448 autoload/mylang.vim file in 'runtimepath'. |autoload|
3449
3450 The expression is also evaluated when 'textwidth' is set and adding
3451 text beyond that limit. This happens under the same conditions as
3452 when internal formatting is used. Make sure the cursor is kept in the
3453 same spot relative to the text then! The |mode()| function will
3454 return "i" or "R" in this situation.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01003455
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003456 When the expression evaluates to non-zero Vim will fall back to using
3457 the internal format mechanism.
3458
3459 The expression will be evaluated in the |sandbox| when set from a
3460 modeline, see |sandbox-option|. That stops the option from working,
3461 since changing the buffer text is not allowed.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003462 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar036986f2017-03-16 17:41:02 +01003463 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaarc95a3022016-06-12 23:01:46 +02003464
Bram Moolenaar86b68352004-12-27 21:59:20 +00003465 *'formatlistpat'* *'flp'*
3466'formatlistpat' 'flp' string (default: "^\s*\d\+[\]:.)}\t ]\s*")
3467 local to buffer
Bram Moolenaar86b68352004-12-27 21:59:20 +00003468 A pattern that is used to recognize a list header. This is used for
3469 the "n" flag in 'formatoptions'.
3470 The pattern must match exactly the text that will be the indent for
Bram Moolenaar677ee682005-01-27 14:41:15 +00003471 the line below it. You can use |/\ze| to mark the end of the match
Bram Moolenaar86b68352004-12-27 21:59:20 +00003472 while still checking more characters. There must be a character
3473 following the pattern, when it matches the whole line it is handled
3474 like there is no match.
3475 The default recognizes a number, followed by an optional punctuation
3476 character and white space.
3477
Bram Moolenaar6c60f472019-04-28 16:00:35 +02003478 *'formatoptions'* *'fo'*
3479'formatoptions' 'fo' string (Vim default: "tcq", Vi default: "vt")
3480 local to buffer
3481 This is a sequence of letters which describes how automatic
3482 formatting is to be done. See |fo-table|. When the 'paste' option is
3483 on, no formatting is done (like 'formatoptions' is empty). Commas can
3484 be inserted for readability.
3485 To avoid problems with flags that are added in the future, use the
3486 "+=" and "-=" feature of ":set" |add-option-flags|.
3487 NOTE: This option is set to the Vi default value when 'compatible' is
3488 set and to the Vim default value when 'compatible' is reset.
3489
Bram Moolenaar071d4272004-06-13 20:20:40 +00003490 *'formatprg'* *'fp'*
3491'formatprg' 'fp' string (default "")
Bram Moolenaar9be7c042017-01-14 14:28:30 +01003492 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003493 The name of an external program that will be used to format the lines
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003494 selected with the |gq| operator. The program must take the input on
Bram Moolenaar071d4272004-06-13 20:20:40 +00003495 stdin and produce the output on stdout. The Unix program "fmt" is
Bram Moolenaara5792f52005-11-23 21:25:05 +00003496 such a program.
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00003497 If the 'formatexpr' option is not empty it will be used instead.
3498 Otherwise, if 'formatprg' option is an empty string, the internal
3499 format function will be used |C-indenting|.
Bram Moolenaara5792f52005-11-23 21:25:05 +00003500 Environment variables are expanded |:set_env|. See |option-backslash|
3501 about including spaces and backslashes.
Bram Moolenaar30b65812012-07-12 22:01:11 +02003502 This option cannot be set from a |modeline| or in the |sandbox|, for
3503 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003504
Bram Moolenaard94464e2015-11-02 15:28:18 +01003505 *'fsync'* *'fs'* *'nofsync'* *'nofs'*
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003506'fsync' 'fs' boolean (default on)
3507 global
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003508 When on, the library function fsync() will be called after writing a
3509 file. This will flush a file to disk, ensuring that it is safely
3510 written even on filesystems which do metadata-only journaling. This
3511 will force the harddrive to spin up on Linux systems running in laptop
3512 mode, so it may be undesirable in some situations. Be warned that
3513 turning this off increases the chances of data loss after a crash. On
3514 systems without an fsync() implementation, this variable is always
3515 off.
3516 Also see 'swapsync' for controlling fsync() on swap files.
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003517 'fsync' also applies to |writefile()|, unless a flag is used to
3518 overrule it.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003519 This option cannot be set from a |modeline| or in the |sandbox|, for
3520 security reasons.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00003521
Bram Moolenaar071d4272004-06-13 20:20:40 +00003522 *'gdefault'* *'gd'* *'nogdefault'* *'nogd'*
3523'gdefault' 'gd' boolean (default off)
3524 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003525 When on, the ":substitute" flag 'g' is default on. This means that
3526 all matches in a line are substituted instead of one. When a 'g' flag
3527 is given to a ":substitute" command, this will toggle the substitution
3528 of all or one match. See |complex-change|.
3529
3530 command 'gdefault' on 'gdefault' off ~
3531 :s/// subst. all subst. one
3532 :s///g subst. one subst. all
3533 :s///gg subst. all subst. one
3534
3535 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar21020352017-06-13 17:21:04 +02003536 DEPRECATED: Setting this option may break plugins that are not aware
3537 of this option. Also, many users get confused that adding the /g flag
3538 has the opposite effect of that it normally does.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003539
3540 *'grepformat'* *'gfm'*
Bram Moolenaar6e932462014-09-09 18:48:09 +02003541'grepformat' 'gfm' string (default "%f:%l:%m,%f:%l%m,%f %l%m")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003542 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003543 Format to recognize for the ":grep" command output.
3544 This is a scanf-like string that uses the same format as the
3545 'errorformat' option: see |errorformat|.
3546
3547 *'grepprg'* *'gp'*
3548'grepprg' 'gp' string (default "grep -n ",
3549 Unix: "grep -n $* /dev/null",
3550 Win32: "findstr /n" or "grep -n",
3551 VMS: "SEARCH/NUMBERS ")
3552 global or local to buffer |global-local|
Bram Moolenaar582fd852005-03-28 20:58:01 +00003553 Program to use for the |:grep| command. This option may contain '%'
Bram Moolenaar071d4272004-06-13 20:20:40 +00003554 and '#' characters, which are expanded like when used in a command-
3555 line. The placeholder "$*" is allowed to specify where the arguments
3556 will be included. Environment variables are expanded |:set_env|. See
3557 |option-backslash| about including spaces and backslashes.
3558 When your "grep" accepts the "-H" argument, use this to make ":grep"
3559 also work well with a single file: >
3560 :set grepprg=grep\ -nH
Bram Moolenaar7c626922005-02-07 22:01:03 +00003561< Special value: When 'grepprg' is set to "internal" the |:grep| command
Bram Moolenaara6557602006-02-04 22:43:20 +00003562 works like |:vimgrep|, |:lgrep| like |:lvimgrep|, |:grepadd| like
3563 |:vimgrepadd| and |:lgrepadd| like |:lvimgrepadd|.
Bram Moolenaar86b68352004-12-27 21:59:20 +00003564 See also the section |:make_makeprg|, since most of the comments there
Bram Moolenaar071d4272004-06-13 20:20:40 +00003565 apply equally to 'grepprg'.
3566 For Win32, the default is "findstr /n" if "findstr.exe" can be found,
3567 otherwise it's "grep -n".
3568 This option cannot be set from a |modeline| or in the |sandbox|, for
3569 security reasons.
3570
3571 *'guicursor'* *'gcr'* *E545* *E546* *E548* *E549*
3572'guicursor' 'gcr' string (default "n-v-c:block-Cursor/lCursor,
3573 ve:ver35-Cursor,
3574 o:hor50-Cursor,
3575 i-ci:ver25-Cursor/lCursor,
3576 r-cr:hor20-Cursor/lCursor,
3577 sm:block-Cursor
3578 -blinkwait175-blinkoff150-blinkon175",
3579 for MS-DOS and Win32 console:
3580 "n-v-c:block,o:hor50,i-ci:hor15,
3581 r-cr:hor30,sm:block")
3582 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003583 {only available when compiled with GUI enabled, and
3584 for MS-DOS and Win32 console}
3585 This option tells Vim what the cursor should look like in different
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003586 modes. It fully works in the GUI. In an MSDOS or Win32 console, only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003587 the height of the cursor can be changed. This can be done by
3588 specifying a block cursor, or a percentage for a vertical or
3589 horizontal cursor.
Bram Moolenaar1e7813a2015-03-31 18:31:03 +02003590 For a console the 't_SI', 't_SR', and 't_EI' escape sequences are
3591 used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003592
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003593 The option is a comma separated list of parts. Each part consist of a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003594 mode-list and an argument-list:
3595 mode-list:argument-list,mode-list:argument-list,..
3596 The mode-list is a dash separated list of these modes:
3597 n Normal mode
3598 v Visual mode
3599 ve Visual mode with 'selection' "exclusive" (same as 'v',
3600 if not specified)
3601 o Operator-pending mode
3602 i Insert mode
3603 r Replace mode
3604 c Command-line Normal (append) mode
3605 ci Command-line Insert mode
3606 cr Command-line Replace mode
3607 sm showmatch in Insert mode
3608 a all modes
3609 The argument-list is a dash separated list of these arguments:
3610 hor{N} horizontal bar, {N} percent of the character height
3611 ver{N} vertical bar, {N} percent of the character width
3612 block block cursor, fills the whole character
3613 [only one of the above three should be present]
3614 blinkwait{N} *cursor-blinking*
3615 blinkon{N}
3616 blinkoff{N}
3617 blink times for cursor: blinkwait is the delay before
3618 the cursor starts blinking, blinkon is the time that
3619 the cursor is shown and blinkoff is the time that the
3620 cursor is not shown. The times are in msec. When one
3621 of the numbers is zero, there is no blinking. The
3622 default is: "blinkwait700-blinkon400-blinkoff250".
3623 These numbers are used for a missing entry. This
3624 means that blinking is enabled by default. To switch
3625 blinking off you can use "blinkon0". The cursor only
3626 blinks when Vim is waiting for input, not while
3627 executing a command.
3628 To make the cursor blink in an xterm, see
3629 |xterm-blink|.
3630 {group-name}
3631 a highlight group name, that sets the color and font
3632 for the cursor
3633 {group-name}/{group-name}
3634 Two highlight group names, the first is used when
3635 no language mappings are used, the other when they
3636 are. |language-mapping|
3637
3638 Examples of parts:
3639 n-c-v:block-nCursor in Normal, Command-line and Visual mode, use a
3640 block cursor with colors from the "nCursor"
3641 highlight group
3642 i-ci:ver30-iCursor-blinkwait300-blinkon200-blinkoff150
3643 In Insert and Command-line Insert mode, use a
3644 30% vertical bar cursor with colors from the
3645 "iCursor" highlight group. Blink a bit
3646 faster.
3647
3648 The 'a' mode is different. It will set the given argument-list for
3649 all modes. It does not reset anything to defaults. This can be used
3650 to do a common setting for all modes. For example, to switch off
3651 blinking: "a:blinkon0"
3652
3653 Examples of cursor highlighting: >
3654 :highlight Cursor gui=reverse guifg=NONE guibg=NONE
3655 :highlight Cursor gui=NONE guifg=bg guibg=fg
3656<
3657 *'guifont'* *'gfn'*
Bram Moolenaar251e1912011-06-19 05:09:16 +02003658 *E235* *E596*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003659'guifont' 'gfn' string (default "")
3660 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003661 {only available when compiled with GUI enabled}
3662 This is a list of fonts which will be used for the GUI version of Vim.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003663 In its simplest form the value is just one font name.
3664 See |gui-font| for the details.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003665
3666 *'guifontset'* *'gfs'*
3667 *E250* *E252* *E234* *E597* *E598*
3668'guifontset' 'gfs' string (default "")
3669 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003670 {only available when compiled with GUI enabled and
3671 with the |+xfontset| feature}
Bram Moolenaar3df01732017-02-17 22:47:16 +01003672 {not available in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003673 When not empty, specifies two (or more) fonts to be used. The first
3674 one for normal English, the second one for your special language. See
3675 |xfontset|.
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003676
Bram Moolenaar071d4272004-06-13 20:20:40 +00003677 *'guifontwide'* *'gfw'* *E231* *E533* *E534*
3678'guifontwide' 'gfw' string (default "")
3679 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003680 {only available when compiled with GUI enabled}
3681 When not empty, specifies a comma-separated list of fonts to be used
3682 for double-width characters. The first font that can be loaded is
Bram Moolenaarf720d0a2019-04-28 14:02:47 +02003683 used. See |gui-fontwide|.
Bram Moolenaar0f272122013-01-23 18:37:40 +01003684
Bram Moolenaar071d4272004-06-13 20:20:40 +00003685 *'guiheadroom'* *'ghr'*
3686'guiheadroom' 'ghr' number (default 50)
3687 global
Bram Moolenaar110289e2019-05-23 15:38:06 +02003688 {only for GTK and X11 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003689 The number of pixels subtracted from the screen height when fitting
3690 the GUI window on the screen. Set this before the GUI is started,
3691 e.g., in your |gvimrc| file. When zero, the whole screen height will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003692 be used by the window. When positive, the specified number of pixel
Bram Moolenaar071d4272004-06-13 20:20:40 +00003693 lines will be left for window decorations and other items on the
3694 screen. Set it to a negative value to allow windows taller than the
3695 screen.
3696
3697 *'guioptions'* *'go'*
Bram Moolenaar2c64ca12018-10-19 16:22:31 +02003698'guioptions' 'go' string (default "egmrLtT" (MS-Windows,
3699 "t" is removed in |defaults.vim|),
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02003700 "aegimrLtT" (GTK, Motif and Athena),
3701 )
Bram Moolenaar071d4272004-06-13 20:20:40 +00003702 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003703 {only available when compiled with GUI enabled}
Bram Moolenaared203462004-06-16 11:19:22 +00003704 This option only has an effect in the GUI version of Vim. It is a
Bram Moolenaar071d4272004-06-13 20:20:40 +00003705 sequence of letters which describes what components and options of the
3706 GUI should be used.
3707 To avoid problems with flags that are added in the future, use the
3708 "+=" and "-=" feature of ":set" |add-option-flags|.
3709
Bram Moolenaar13568252018-03-16 20:46:58 +01003710 Valid characters are as follows:
3711 *'go-!'*
3712 '!' External commands are executed in a terminal window. Without
3713 this flag the MS-Windows GUI will open a console window to
3714 execute the command. The Unix GUI will simulate a dumb
3715 terminal to list the command output.
3716 The terminal window will be positioned at the bottom, and grow
3717 upwards as needed.
Bram Moolenaarba3ff532018-11-04 14:45:49 +01003718 *'go-a'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003719 'a' Autoselect: If present, then whenever VISUAL mode is started,
3720 or the Visual area extended, Vim tries to become the owner of
3721 the windowing system's global selection. This means that the
3722 Visually highlighted text is available for pasting into other
3723 applications as well as into Vim itself. When the Visual mode
3724 ends, possibly due to an operation on the text, or when an
3725 application wants to paste the selection, the highlighted text
3726 is automatically yanked into the "* selection register.
3727 Thus the selection is still available for pasting into other
3728 applications after the VISUAL mode has ended.
3729 If not present, then Vim won't become the owner of the
3730 windowing system's global selection unless explicitly told to
3731 by a yank or delete operation for the "* register.
3732 The same applies to the modeless selection.
Bram Moolenaarc0885aa2012-07-10 16:49:23 +02003733 *'go-P'*
3734 'P' Like autoselect but using the "+ register instead of the "*
Bram Moolenaar3848e002016-03-19 18:42:29 +01003735 register.
Bram Moolenaar02467872007-05-06 13:22:01 +00003736 *'go-A'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003737 'A' Autoselect for the modeless selection. Like 'a', but only
Bram Moolenaar071d4272004-06-13 20:20:40 +00003738 applies to the modeless selection.
3739
3740 'guioptions' autoselect Visual autoselect modeless ~
3741 "" - -
3742 "a" yes yes
3743 "A" - yes
3744 "aA" yes yes
3745
Bram Moolenaar02467872007-05-06 13:22:01 +00003746 *'go-c'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003747 'c' Use console dialogs instead of popup dialogs for simple
3748 choices.
Bram Moolenaar50bf7ce2019-09-15 13:17:00 +02003749 *'go-d'*
3750 'd' Use dark theme variant if available. Currently only works for
3751 GTK+ GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003752 *'go-e'*
Bram Moolenaare224ffa2006-03-01 00:01:28 +00003753 'e' Add tab pages when indicated with 'showtabline'.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003754 'guitablabel' can be used to change the text in the labels.
3755 When 'e' is missing a non-GUI tab pages line may be used.
Bram Moolenaard68071d2006-05-02 22:08:30 +00003756 The GUI tabs are only supported on some systems, currently
Bram Moolenaar446cb832008-06-24 21:56:24 +00003757 GTK, Motif, Mac OS/X and MS-Windows.
Bram Moolenaar02467872007-05-06 13:22:01 +00003758 *'go-f'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003759 'f' Foreground: Don't use fork() to detach the GUI from the shell
3760 where it was started. Use this for programs that wait for the
3761 editor to finish (e.g., an e-mail program). Alternatively you
3762 can use "gvim -f" or ":gui -f" to start the GUI in the
3763 foreground. |gui-fork|
3764 Note: Set this option in the vimrc file. The forking may have
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003765 happened already when the |gvimrc| file is read.
Bram Moolenaar02467872007-05-06 13:22:01 +00003766 *'go-i'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003767 'i' Use a Vim icon. For GTK with KDE it is used in the left-upper
3768 corner of the window. It's black&white on non-GTK, because of
3769 limitations of X11. For a color icon, see |X11-icon|.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003770 *'go-m'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003771 'm' Menu bar is present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003772 *'go-M'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003773 'M' The system menu "$VIMRUNTIME/menu.vim" is not sourced. Note
Bram Moolenaar071d4272004-06-13 20:20:40 +00003774 that this flag must be added in the .vimrc file, before
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003775 switching on syntax or filetype recognition (when the |gvimrc|
Bram Moolenaar071d4272004-06-13 20:20:40 +00003776 file is sourced the system menu has already been loaded; the
Bram Moolenaar01164a62017-11-02 22:58:42 +01003777 `:syntax on` and `:filetype on` commands load the menu too).
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003778 *'go-g'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003779 'g' Grey menu items: Make menu items that are not active grey. If
3780 'g' is not included inactive menu items are not shown at all.
3781 Exception: Athena will always use grey menu items.
Bram Moolenaar02467872007-05-06 13:22:01 +00003782 *'go-t'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003783 't' Include tearoff menu items. Currently only works for Win32,
3784 GTK+, and Motif 1.2 GUI.
Bram Moolenaar02467872007-05-06 13:22:01 +00003785 *'go-T'*
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00003786 'T' Include Toolbar. Currently only in Win32, GTK+, Motif, Photon
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00003787 and Athena GUIs.
Bram Moolenaar02467872007-05-06 13:22:01 +00003788 *'go-r'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003789 'r' Right-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003790 *'go-R'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003791 'R' Right-hand scrollbar is present when there is a vertically
3792 split window.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003793 *'go-l'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003794 'l' Left-hand scrollbar is always present.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003795 *'go-L'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003796 'L' Left-hand scrollbar is present when there is a vertically
3797 split window.
Bram Moolenaar02467872007-05-06 13:22:01 +00003798 *'go-b'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003799 'b' Bottom (horizontal) scrollbar is present. Its size depends on
3800 the longest visible line, or on the cursor line if the 'h'
3801 flag is included. |gui-horiz-scroll|
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003802 *'go-h'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003803 'h' Limit horizontal scrollbar size to the length of the cursor
3804 line. Reduces computations. |gui-horiz-scroll|
3805
3806 And yes, you may even have scrollbars on the left AND the right if
3807 you really want to :-). See |gui-scrollbars| for more information.
3808
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003809 *'go-v'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003810 'v' Use a vertical button layout for dialogs. When not included,
3811 a horizontal layout is preferred, but when it doesn't fit a
3812 vertical layout is used anyway.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003813 *'go-p'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00003814 'p' Use Pointer callbacks for X11 GUI. This is required for some
3815 window managers. If the cursor is not blinking or hollow at
3816 the right moment, try adding this flag. This must be done
Bram Moolenaar910f66f2006-04-05 20:41:53 +00003817 before starting the GUI. Set it in your |gvimrc|. Adding or
Bram Moolenaar071d4272004-06-13 20:20:40 +00003818 removing it after the GUI has started has no effect.
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02003819 *'go-F'*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003820 'F' Add a footer. Only for Motif. See |gui-footer|.
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003821 *'go-k'*
3822 'k' Keep the GUI window size when adding/removing a scrollbar, or
3823 toolbar, tabline, etc. Instead, the behavior is similar to
3824 when the window is maximized and will adjust 'lines' and
3825 'columns' to fit to the window. Without the 'k' flag Vim will
Bram Moolenaar51b0f372017-11-18 18:52:04 +01003826 try to keep 'lines' and 'columns' the same when adding and
Bram Moolenaar8ac44152017-11-09 18:33:29 +01003827 removing GUI components.
Bram Moolenaar02467872007-05-06 13:22:01 +00003828
Bram Moolenaar071d4272004-06-13 20:20:40 +00003829 *'guipty'* *'noguipty'*
3830'guipty' boolean (default on)
3831 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003832 {only available when compiled with GUI enabled}
3833 Only in the GUI: If on, an attempt is made to open a pseudo-tty for
3834 I/O to/from shell commands. See |gui-pty|.
3835
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003836 *'guitablabel'* *'gtl'*
3837'guitablabel' 'gtl' string (default empty)
3838 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003839 {only available when compiled with GUI enabled}
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003840 When nonempty describes the text to use in a label of the GUI tab
Bram Moolenaard68071d2006-05-02 22:08:30 +00003841 pages line. When empty and when the result is empty Vim will use a
3842 default label. See |setting-guitablabel| for more info.
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003843
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003844 The format of this option is like that of 'statusline'.
Bram Moolenaar57657d82006-04-21 22:12:41 +00003845 'guitabtooltip' is used for the tooltip, see below.
Bram Moolenaar51628222016-12-01 23:03:28 +01003846 The expression will be evaluated in the |sandbox| when set from a
3847 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02003848 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00003849
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00003850 Only used when the GUI tab pages line is displayed. 'e' must be
3851 present in 'guioptions'. For the non-GUI tab pages line 'tabline' is
3852 used.
3853
Bram Moolenaar57657d82006-04-21 22:12:41 +00003854 *'guitabtooltip'* *'gtt'*
3855'guitabtooltip' 'gtt' string (default empty)
3856 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02003857 {only available when compiled with GUI enabled}
Bram Moolenaar57657d82006-04-21 22:12:41 +00003858 When nonempty describes the text to use in a tooltip for the GUI tab
3859 pages line. When empty Vim will use a default tooltip.
3860 This option is otherwise just like 'guitablabel' above.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01003861 You can include a line break. Simplest method is to use |:let|: >
3862 :let &guitabtooltip = "line one\nline two"
3863<
Bram Moolenaar57657d82006-04-21 22:12:41 +00003864
Bram Moolenaar071d4272004-06-13 20:20:40 +00003865 *'helpfile'* *'hf'*
3866'helpfile' 'hf' string (default (MSDOS) "$VIMRUNTIME\doc\help.txt"
3867 (others) "$VIMRUNTIME/doc/help.txt")
3868 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003869 Name of the main help file. All distributed help files should be
3870 placed together in one directory. Additionally, all "doc" directories
3871 in 'runtimepath' will be used.
3872 Environment variables are expanded |:set_env|. For example:
3873 "$VIMRUNTIME/doc/help.txt". If $VIMRUNTIME is not set, $VIM is also
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003874 tried. Also see |$VIMRUNTIME| and |option-backslash| about including
Bram Moolenaar071d4272004-06-13 20:20:40 +00003875 spaces and backslashes.
3876 This option cannot be set from a |modeline| or in the |sandbox|, for
3877 security reasons.
3878
3879 *'helpheight'* *'hh'*
3880'helpheight' 'hh' number (default 20)
3881 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003882 Minimal initial height of the help window when it is opened with the
3883 ":help" command. The initial height of the help window is half of the
3884 current window, or (when the 'ea' option is on) the same as other
3885 windows. When the height is less than 'helpheight', the height is
3886 set to 'helpheight'. Set to zero to disable.
3887
3888 *'helplang'* *'hlg'*
3889'helplang' 'hlg' string (default: messages language or empty)
3890 global
3891 {only available when compiled with the |+multi_lang|
3892 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00003893 Comma separated list of languages. Vim will use the first language
3894 for which the desired help can be found. The English help will always
3895 be used as a last resort. You can add "en" to prefer English over
3896 another language, but that will only find tags that exist in that
3897 language and not in the English help.
3898 Example: >
3899 :set helplang=de,it
3900< This will first search German, then Italian and finally English help
3901 files.
3902 When using |CTRL-]| and ":help!" in a non-English help file Vim will
3903 try to find the tag in the current language before using this option.
3904 See |help-translated|.
3905
3906 *'hidden'* *'hid'* *'nohidden'* *'nohid'*
3907'hidden' 'hid' boolean (default off)
3908 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003909 When off a buffer is unloaded when it is |abandon|ed. When on a
3910 buffer becomes hidden when it is |abandon|ed. If the buffer is still
3911 displayed in another window, it does not become hidden, of course.
3912 The commands that move through the buffer list sometimes make a buffer
3913 hidden although the 'hidden' option is off: When the buffer is
3914 modified, 'autowrite' is off or writing is not possible, and the '!'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003915 flag was used. See also |windows.txt|.
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00003916 To only make one buffer hidden use the 'bufhidden' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003917 This option is set for one command with ":hide {command}" |:hide|.
3918 WARNING: It's easy to forget that you have changes in hidden buffers.
3919 Think twice when using ":q!" or ":qa!".
3920
3921 *'highlight'* *'hl'*
3922'highlight' 'hl' string (default (as a single string):
Bram Moolenaar58b85342016-08-14 19:54:54 +02003923 "8:SpecialKey,~:EndOfBuffer,@:NonText,
3924 d:Directory,e:ErrorMsg,i:IncSearch,
3925 l:Search,m:MoreMsg,M:ModeMsg,n:LineNr,
3926 N:CursorLineNr,r:Question,s:StatusLine,
3927 S:StatusLineNC,c:VertSplit,t:Title,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003928 v:Visual,V:VisualNOS,w:WarningMsg,
3929 W:WildMenu,f:Folded,F:FoldColumn,
3930 A:DiffAdd,C:DiffChange,D:DiffDelete,
3931 T:DiffText,>:SignColumn,-:Conceal,
Bram Moolenaarc8c88492018-12-27 23:59:26 +01003932 B:SpellBad,P:SpellCap,R:SpellRare,
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003933 L:SpellLocal,+:Pmenu,=:PmenuSel,
Bram Moolenaar21020352017-06-13 17:21:04 +02003934 x:PmenuSbar,X:PmenuThumb,*:TabLine,
3935 #:TabLineSel,_:TabLineFill,!:CursorColumn,
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02003936 .:CursorLine,o:ColorColumn,q:QuickFixLine,
Bram Moolenaarc572da52017-08-27 16:52:01 +02003937 z:StatusLineTerm,Z:StatusLineTermNC")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003938 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00003939 This option can be used to set highlighting mode for various
3940 occasions. It is a comma separated list of character pairs. The
3941 first character in a pair gives the occasion, the second the mode to
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00003942 use for that occasion. The occasions are:
Bram Moolenaar071d4272004-06-13 20:20:40 +00003943 |hl-SpecialKey| 8 Meta and special keys listed with ":map"
Bram Moolenaar58b85342016-08-14 19:54:54 +02003944 |hl-EndOfBuffer| ~ lines after the last line in the buffer
3945 |hl-NonText| @ '@' at the end of the window and
Bram Moolenaar071d4272004-06-13 20:20:40 +00003946 characters from 'showbreak'
3947 |hl-Directory| d directories in CTRL-D listing and other special
3948 things in listings
3949 |hl-ErrorMsg| e error messages
3950 h (obsolete, ignored)
3951 |hl-IncSearch| i 'incsearch' highlighting
3952 |hl-Search| l last search pattern highlighting (see 'hlsearch')
3953 |hl-MoreMsg| m |more-prompt|
3954 |hl-ModeMsg| M Mode (e.g., "-- INSERT --")
Bram Moolenaar64486672010-05-16 15:46:46 +02003955 |hl-LineNr| n line number for ":number" and ":#" commands, and
3956 when 'number' or 'relativenumber' option is set.
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01003957 |hl-CursorLineNr| N like n for when 'cursorline' or 'relativenumber' is
3958 set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00003959 |hl-Question| r |hit-enter| prompt and yes/no questions
3960 |hl-StatusLine| s status line of current window |status-line|
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01003961 |hl-StatusLineNC| S status lines of not-current windows
Bram Moolenaar071d4272004-06-13 20:20:40 +00003962 |hl-Title| t Titles for output from ":set all", ":autocmd" etc.
3963 |hl-VertSplit| c column used to separate vertically split windows
3964 |hl-Visual| v Visual mode
3965 |hl-VisualNOS| V Visual mode when Vim does is "Not Owning the
3966 Selection" Only X11 Gui's |gui-x11| and
3967 |xterm-clipboard|.
3968 |hl-WarningMsg| w warning messages
3969 |hl-WildMenu| W wildcard matches displayed for 'wildmenu'
3970 |hl-Folded| f line used for closed folds
3971 |hl-FoldColumn| F 'foldcolumn'
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00003972 |hl-DiffAdd| A added line in diff mode
3973 |hl-DiffChange| C changed line in diff mode
3974 |hl-DiffDelete| D deleted line in diff mode
3975 |hl-DiffText| T inserted text in diff mode
Bram Moolenaar071d4272004-06-13 20:20:40 +00003976 |hl-SignColumn| > column used for |signs|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003977 |hl-Conceal| - the placeholders used for concealed characters
3978 (see 'conceallevel')
Bram Moolenaar217ad922005-03-20 22:37:15 +00003979 |hl-SpellBad| B misspelled word |spell|
Bram Moolenaar9855d6b2010-07-18 14:34:51 +02003980 |hl-SpellCap| P word that should start with capital |spell|
Bram Moolenaar217ad922005-03-20 22:37:15 +00003981 |hl-SpellRare| R rare word |spell|
3982 |hl-SpellLocal| L word from other region |spell|
Bram Moolenaar9d87a372018-12-18 21:41:50 +01003983 |hl-Pmenu| + popup menu normal line
3984 |hl-PmenuSel| = popup menu selected line
3985 |hl-PmenuSbar| x popup menu scrollbar
3986 |hl-PmenuThumb| X popup menu scrollbar thumb
Bram Moolenaar071d4272004-06-13 20:20:40 +00003987
3988 The display modes are:
3989 r reverse (termcap entry "mr" and "me")
3990 i italic (termcap entry "ZH" and "ZR")
3991 b bold (termcap entry "md" and "me")
3992 s standout (termcap entry "so" and "se")
3993 u underline (termcap entry "us" and "ue")
Bram Moolenaare2cc9702005-03-15 22:43:58 +00003994 c undercurl (termcap entry "Cs" and "Ce")
Bram Moolenaarcf4b00c2017-09-02 18:33:56 +02003995 t strikethrough (termcap entry "Ts" and "Te")
Bram Moolenaar071d4272004-06-13 20:20:40 +00003996 n no highlighting
3997 - no highlighting
3998 : use a highlight group
3999 The default is used for occasions that are not included.
4000 If you want to change what the display modes do, see |dos-colors|
4001 for an example.
4002 When using the ':' display mode, this must be followed by the name of
4003 a highlight group. A highlight group can be used to define any type
4004 of highlighting, including using color. See |:highlight| on how to
4005 define one. The default uses a different group for each occasion.
4006 See |highlight-default| for the default highlight groups.
4007
Bram Moolenaar071d4272004-06-13 20:20:40 +00004008 *'history'* *'hi'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004009'history' 'hi' number (Vim default: 50, Vi default: 0,
4010 set to 200 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004011 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004012 A history of ":" commands, and a history of previous search patterns
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004013 is remembered. This option decides how many entries may be stored in
Bram Moolenaar071d4272004-06-13 20:20:40 +00004014 each of these histories (see |cmdline-editing|).
Bram Moolenaar78159bb2014-06-25 11:48:54 +02004015 The maximum value is 10000.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004016 NOTE: This option is set to the Vi default value when 'compatible' is
4017 set and to the Vim default value when 'compatible' is reset.
4018
4019 *'hkmap'* *'hk'* *'nohkmap'* *'nohk'*
4020'hkmap' 'hk' boolean (default off)
4021 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004022 {only available when compiled with the |+rightleft|
4023 feature}
4024 When on, the keyboard is mapped for the Hebrew character set.
4025 Normally you would set 'allowrevins' and use CTRL-_ in insert mode to
4026 toggle this option. See |rileft.txt|.
4027 NOTE: This option is reset when 'compatible' is set.
4028
4029 *'hkmapp'* *'hkp'* *'nohkmapp'* *'nohkp'*
4030'hkmapp' 'hkp' boolean (default off)
4031 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004032 {only available when compiled with the |+rightleft|
4033 feature}
4034 When on, phonetic keyboard mapping is used. 'hkmap' must also be on.
4035 This is useful if you have a non-Hebrew keyboard.
4036 See |rileft.txt|.
4037 NOTE: This option is reset when 'compatible' is set.
4038
Bram Moolenaar036986f2017-03-16 17:41:02 +01004039 *'hlsearch'* *'hls'* *'nohlsearch'* *'nohls'*
4040'hlsearch' 'hls' boolean (default off)
4041 global
Bram Moolenaar036986f2017-03-16 17:41:02 +01004042 {not available when compiled without the
4043 |+extra_search| feature}
4044 When there is a previous search pattern, highlight all its matches.
4045 The type of highlighting used can be set with the 'l' occasion in the
4046 'highlight' option. This uses the "Search" highlight group by
4047 default. Note that only the matching text is highlighted, any offsets
4048 are not applied.
4049 See also: 'incsearch' and |:match|.
4050 When you get bored looking at the highlighted matches, you can turn it
4051 off with |:nohlsearch|. This does not change the option value, as
4052 soon as you use a search command, the highlighting comes back.
4053 'redrawtime' specifies the maximum time spent on finding matches.
4054 When the search pattern can match an end-of-line, Vim will try to
4055 highlight all of the matched text. However, this depends on where the
4056 search starts. This will be the first line in the window or the first
4057 line below a closed fold. A match in a previous line which is not
4058 drawn may not continue in a newly drawn line.
4059 You can specify whether the highlight status is restored on startup
4060 with the 'h' flag in 'viminfo' |viminfo-h|.
4061 NOTE: This option is reset when 'compatible' is set.
4062
Bram Moolenaar071d4272004-06-13 20:20:40 +00004063 *'icon'* *'noicon'*
4064'icon' boolean (default off, on when title can be restored)
4065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004066 {not available when compiled without the |+title|
4067 feature}
4068 When on, the icon text of the window will be set to the value of
4069 'iconstring' (if it is not empty), or to the name of the file
4070 currently being edited. Only the last part of the name is used.
4071 Overridden by the 'iconstring' option.
4072 Only works if the terminal supports setting window icons (currently
4073 only X11 GUI and terminals with a non-empty 't_IS' option - these are
4074 Unix xterm and iris-ansi by default, where 't_IS' is taken from the
4075 builtin termcap).
4076 When Vim was compiled with HAVE_X11 defined, the original icon will be
Bram Moolenaar582fd852005-03-28 20:58:01 +00004077 restored if possible |X11|. See |X11-icon| for changing the icon on
Bram Moolenaar071d4272004-06-13 20:20:40 +00004078 X11.
Bram Moolenaar3a991dd2014-10-02 01:41:41 +02004079 For MS-Windows the icon can be changed, see |windows-icon|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004080
4081 *'iconstring'*
4082'iconstring' string (default "")
4083 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004084 {not available when compiled without the |+title|
4085 feature}
4086 When this option is not empty, it will be used for the icon text of
4087 the window. This happens only when the 'icon' option is on.
4088 Only works if the terminal supports setting window icon text
4089 (currently only X11 GUI and terminals with a non-empty 't_IS' option).
4090 Does not work for MS Windows.
4091 When Vim was compiled with HAVE_X11 defined, the original icon will be
4092 restored if possible |X11|.
4093 When this option contains printf-style '%' items, they will be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004094 expanded according to the rules used for 'statusline'. See
Bram Moolenaar071d4272004-06-13 20:20:40 +00004095 'titlestring' for example settings.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004096 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004097 {not available when compiled without the |+statusline| feature}
4098
4099 *'ignorecase'* *'ic'* *'noignorecase'* *'noic'*
4100'ignorecase' 'ic' boolean (default off)
4101 global
4102 Ignore case in search patterns. Also used when searching in the tags
4103 file.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01004104 Also see 'smartcase' and 'tagcase'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004105 Can be overruled by using "\c" or "\C" in the pattern, see
4106 |/ignorecase|.
4107
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004108 *'imactivatefunc'* *'imaf'*
4109'imactivatefunc' 'imaf' string (default "")
4110 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004111 This option specifies a function that will be called to
Bram Moolenaar2877d332017-11-26 14:56:16 +01004112 activate or deactivate the Input Method.
4113 It is not used in the GUI.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004114 The expression will be evaluated in the |sandbox| when set from a
4115 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004116
4117 Example: >
4118 function ImActivateFunc(active)
4119 if a:active
4120 ... do something
4121 else
4122 ... do something
4123 endif
4124 " return value is not used
4125 endfunction
4126 set imactivatefunc=ImActivateFunc
4127<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004128 *'imactivatekey'* *'imak'*
4129'imactivatekey' 'imak' string (default "")
4130 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004131 {only available when compiled with |+xim| and
Bram Moolenaar67c53842010-05-22 18:28:27 +02004132 |+GUI_GTK|} *E599*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004133 Specifies the key that your Input Method in X-Windows uses for
4134 activation. When this is specified correctly, vim can fully control
4135 IM with 'imcmdline', 'iminsert' and 'imsearch'.
4136 You can't use this option to change the activation key, the option
4137 tells Vim what the key is.
4138 Format:
4139 [MODIFIER_FLAG-]KEY_STRING
4140
4141 These characters can be used for MODIFIER_FLAG (case is ignored):
4142 S Shift key
4143 L Lock key
4144 C Control key
4145 1 Mod1 key
4146 2 Mod2 key
4147 3 Mod3 key
4148 4 Mod4 key
4149 5 Mod5 key
4150 Combinations are allowed, for example "S-C-space" or "SC-space" are
4151 both shift+ctrl+space.
4152 See <X11/keysymdef.h> and XStringToKeysym for KEY_STRING.
4153
4154 Example: >
4155 :set imactivatekey=S-space
4156< "S-space" means shift+space. This is the activation key for kinput2 +
4157 canna (Japanese), and ami (Korean).
4158
4159 *'imcmdline'* *'imc'* *'noimcmdline'* *'noimc'*
4160'imcmdline' 'imc' boolean (default off)
4161 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004162 When set the Input Method is always on when starting to edit a command
4163 line, unless entering a search pattern (see 'imsearch' for that).
4164 Setting this option is useful when your input method allows entering
4165 English characters directly, e.g., when it's used to type accented
4166 characters with dead keys.
4167
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004168 *'imdisable'* *'imd'* *'noimdisable'* *'noimd'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004169'imdisable' 'imd' boolean (default off, on for some systems (SGI))
4170 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004171 When set the Input Method is never used. This is useful to disable
4172 the IM when it doesn't work properly.
4173 Currently this option is on by default for SGI/IRIX machines. This
4174 may change in later releases.
4175
4176 *'iminsert'* *'imi'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004177'iminsert' 'imi' number (default 0)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004178 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004179 Specifies whether :lmap or an Input Method (IM) is to be used in
4180 Insert mode. Valid values:
4181 0 :lmap is off and IM is off
4182 1 :lmap is ON and IM is off
4183 2 :lmap is off and IM is ON
Bram Moolenaar071d4272004-06-13 20:20:40 +00004184 To always reset the option to zero when leaving Insert mode with <Esc>
4185 this can be used: >
4186 :inoremap <ESC> <ESC>:set iminsert=0<CR>
4187< This makes :lmap and IM turn off automatically when leaving Insert
4188 mode.
4189 Note that this option changes when using CTRL-^ in Insert mode
4190 |i_CTRL-^|.
4191 The value is set to 1 when setting 'keymap' to a valid keymap name.
4192 It is also used for the argument of commands like "r" and "f".
4193 The value 0 may not work correctly with Athena and Motif with some XIM
4194 methods. Use 'imdisable' to disable XIM then.
4195
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004196 You can set 'imactivatefunc' and 'imstatusfunc' to handle IME/XIM
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004197 via external command if Vim is not compiled with the |+xim|,
Bram Moolenaar6315a9a2017-11-25 15:20:02 +01004198 |+multi_byte_ime| or |global-ime|.
4199
Bram Moolenaar071d4272004-06-13 20:20:40 +00004200 *'imsearch'* *'ims'*
Bram Moolenaar4cf56bb2017-09-16 15:50:32 +02004201'imsearch' 'ims' number (default -1)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004202 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004203 Specifies whether :lmap or an Input Method (IM) is to be used when
4204 entering a search pattern. Valid values:
4205 -1 the value of 'iminsert' is used, makes it look like
4206 'iminsert' is also used when typing a search pattern
4207 0 :lmap is off and IM is off
4208 1 :lmap is ON and IM is off
4209 2 :lmap is off and IM is ON
4210 Note that this option changes when using CTRL-^ in Command-line mode
4211 |c_CTRL-^|.
4212 The value is set to 1 when it is not -1 and setting the 'keymap'
4213 option to a valid keymap name.
4214 The value 0 may not work correctly with Athena and Motif with some XIM
4215 methods. Use 'imdisable' to disable XIM then.
4216
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004217 *'imstatusfunc'* *'imsf'*
4218'imstatusfunc' 'imsf' string (default "")
4219 global
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004220 This option specifies a function that is called to obtain the status
4221 of Input Method. It must return a positive number when IME is active.
Bram Moolenaar2877d332017-11-26 14:56:16 +01004222 It is not used in the GUI.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004223
4224 Example: >
4225 function ImStatusFunc()
4226 let is_active = ...do something
4227 return is_active ? 1 : 0
4228 endfunction
4229 set imstatusfunc=ImStatusFunc
4230<
4231 NOTE: This function is invoked very often. Keep it fast.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004232 The expression will be evaluated in the |sandbox| when set from a
4233 modeline, see |sandbox-option|.
Bram Moolenaarabab85a2013-06-26 19:18:05 +02004234
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004235 *'imstyle'* *'imst'*
4236'imstyle' 'imst' number (default 1)
4237 global
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004238 {only available when compiled with |+xim| and
4239 |+GUI_GTK|}
Bram Moolenaar37c64c72017-09-19 22:06:03 +02004240 This option specifies the input style of Input Method:
4241 0 use on-the-spot style
4242 1 over-the-spot style
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004243 See: |xim-input-style|
4244
Bram Moolenaar24a98a02017-09-27 22:23:55 +02004245 For a long time on-the-spot style had been used in the GTK version of
4246 vim, however, it is known that it causes troubles when using mappings,
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004247 |single-repeat|, etc. Therefore over-the-spot style becomes the
4248 default now. This should work fine for most people, however if you
4249 have any problem with it, try using on-the-spot style.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004250 The expression will be evaluated in the |sandbox| when set from a
4251 modeline, see |sandbox-option|.
Bram Moolenaar5c6dbcb2017-08-30 22:00:20 +02004252
Bram Moolenaar071d4272004-06-13 20:20:40 +00004253 *'include'* *'inc'*
4254'include' 'inc' string (default "^\s*#\s*include")
4255 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004256 {not available when compiled without the
4257 |+find_in_path| feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004258 Pattern to be used to find an include command. It is a search
Bram Moolenaar071d4272004-06-13 20:20:40 +00004259 pattern, just like for the "/" command (See |pattern|). The default
4260 value is for C programs. This option is used for the commands "[i",
Bram Moolenaar1e015462005-09-25 22:16:38 +00004261 "]I", "[d", etc.
4262 Normally the 'isfname' option is used to recognize the file name that
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004263 comes after the matched pattern. But if "\zs" appears in the pattern
4264 then the text matched from "\zs" to the end, or until "\ze" if it
4265 appears, is used as the file name. Use this to include characters
4266 that are not in 'isfname', such as a space. You can then use
4267 'includeexpr' to process the matched text.
Bram Moolenaar1e015462005-09-25 22:16:38 +00004268 See |option-backslash| about including spaces and backslashes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004269
4270 *'includeexpr'* *'inex'*
4271'includeexpr' 'inex' string (default "")
4272 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004273 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004274 |+find_in_path| or |+eval| features}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004275 Expression to be used to transform the string found with the 'include'
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004276 option to a file name. Mostly useful to change "." to "/" for Java: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004277 :set includeexpr=substitute(v:fname,'\\.','/','g')
4278< The "v:fname" variable will be set to the file name that was detected.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004279
Bram Moolenaar071d4272004-06-13 20:20:40 +00004280 Also used for the |gf| command if an unmodified file name can't be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004281 found. Allows doing "gf" on the name after an 'include' statement.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004282 Also used for |<cfile>|.
4283
Bram Moolenaar30b65812012-07-12 22:01:11 +02004284 The expression will be evaluated in the |sandbox| when set from a
4285 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004286 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004287
4288 It is not allowed to change text or jump to another window while
4289 evaluating 'includeexpr' |textlock|.
4290
Bram Moolenaar071d4272004-06-13 20:20:40 +00004291 *'incsearch'* *'is'* *'noincsearch'* *'nois'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004292'incsearch' 'is' boolean (default off, set in |defaults.vim| if the
4293 +reltime feature is supported)
Bram Moolenaar071d4272004-06-13 20:20:40 +00004294 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004295 {not available when compiled without the
Bram Moolenaardb84e452010-08-15 13:50:43 +02004296 |+extra_search| features}
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004297 While typing a search command, show where the pattern, as it was typed
4298 so far, matches. The matched string is highlighted. If the pattern
4299 is invalid or not found, nothing is shown. The screen will be updated
4300 often, this is only useful on fast terminals.
Bram Moolenaarfc65cab2018-08-28 22:58:02 +02004301 Also applies to the pattern in commands: >
4302 :global
4303 :lvimgrep
4304 :lvimgrepadd
4305 :smagic
4306 :snomagic
4307 :sort
4308 :substitute
4309 :vglobal
4310 :vimgrep
4311 :vimgrepadd
4312< Note that the match will be shown, but the cursor will return to its
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004313 original position when no match is found and when pressing <Esc>. You
4314 still need to finish the search command with <Enter> to move the
4315 cursor to the match.
Bram Moolenaardc083282016-10-11 08:57:33 +02004316 You can use the CTRL-G and CTRL-T keys to move to the next and
4317 previous match. |c_CTRL-G| |c_CTRL-T|
Bram Moolenaar91a4e822008-01-19 14:59:58 +00004318 When compiled with the |+reltime| feature Vim only searches for about
4319 half a second. With a complicated pattern and/or a lot of text the
4320 match may not be found. This is to avoid that Vim hangs while you
4321 are typing the pattern.
Bram Moolenaar21cf8232004-07-16 20:18:37 +00004322 The highlighting can be set with the 'i' flag in 'highlight'.
Bram Moolenaar2f058492017-11-30 20:27:52 +01004323 When 'hlsearch' is on, all matched strings are highlighted too while
4324 typing a search command. See also: 'hlsearch'.
Bram Moolenaard473c8c2018-08-11 18:00:22 +02004325 If you don't want to turn 'hlsearch' on, but want to highlight all
4326 matches while searching, you can turn on and off 'hlsearch' with
4327 autocmd. Example: >
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004328 augroup vimrc-incsearch-highlight
4329 autocmd!
Bram Moolenaarf8f8b2e2017-11-02 19:08:48 +01004330 autocmd CmdlineEnter /,\? :set hlsearch
4331 autocmd CmdlineLeave /,\? :set nohlsearch
Bram Moolenaar2e51d9a2017-10-29 16:40:30 +01004332 augroup END
4333<
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004334 CTRL-L can be used to add one character from after the current match
Bram Moolenaara9dc3752010-07-11 20:46:53 +02004335 to the command line. If 'ignorecase' and 'smartcase' are set and the
4336 command line has no uppercase characters, the added character is
4337 converted to lowercase.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00004338 CTRL-R CTRL-W can be used to add the word at the end of the current
4339 match, excluding the characters that were already typed.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004340 NOTE: This option is reset when 'compatible' is set.
4341
4342 *'indentexpr'* *'inde'*
4343'indentexpr' 'inde' string (default "")
4344 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004345 {not available when compiled without the |+cindent|
4346 or |+eval| features}
4347 Expression which is evaluated to obtain the proper indent for a line.
4348 It is used when a new line is created, for the |=| operator and
4349 in Insert mode as specified with the 'indentkeys' option.
4350 When this option is not empty, it overrules the 'cindent' and
Bram Moolenaar20f90cf2011-05-19 12:22:51 +02004351 'smartindent' indenting. When 'lisp' is set, this option is
4352 overridden by the Lisp indentation algorithm.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004353 When 'paste' is set this option is not used for indenting.
4354 The expression is evaluated with |v:lnum| set to the line number for
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00004355 which the indent is to be computed. The cursor is also in this line
Bram Moolenaar071d4272004-06-13 20:20:40 +00004356 when the expression is evaluated (but it may be moved around).
4357 The expression must return the number of spaces worth of indent. It
4358 can return "-1" to keep the current indent (this means 'autoindent' is
4359 used for the indent).
4360 Functions useful for computing the indent are |indent()|, |cindent()|
4361 and |lispindent()|.
4362 The evaluation of the expression must not have side effects! It must
4363 not change the text, jump to another window, etc. Afterwards the
4364 cursor position is always restored, thus the cursor may be moved.
4365 Normally this option would be set to call a function: >
4366 :set indentexpr=GetMyIndent()
4367< Error messages will be suppressed, unless the 'debug' option contains
4368 "msg".
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004369 See |indent-expression|.
Bram Moolenaar036986f2017-03-16 17:41:02 +01004370 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004371
Bram Moolenaar30b65812012-07-12 22:01:11 +02004372 The expression will be evaluated in the |sandbox| when set from a
4373 modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02004374 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00004375
4376 It is not allowed to change text or jump to another window while
4377 evaluating 'indentexpr' |textlock|.
4378
4379
Bram Moolenaar071d4272004-06-13 20:20:40 +00004380 *'indentkeys'* *'indk'*
Bram Moolenaarce655742019-01-31 14:12:57 +01004381'indentkeys' 'indk' string (default "0{,0},0),0],:,0#,!^F,o,O,e")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004382 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004383 {not available when compiled without the |+cindent|
4384 feature}
4385 A list of keys that, when typed in Insert mode, cause reindenting of
4386 the current line. Only happens if 'indentexpr' isn't empty.
4387 The format is identical to 'cinkeys', see |indentkeys-format|.
4388 See |C-indenting| and |indent-expression|.
4389
4390 *'infercase'* *'inf'* *'noinfercase'* *'noinf'*
4391'infercase' 'inf' boolean (default off)
4392 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004393 When doing keyword completion in insert mode |ins-completion|, and
Bram Moolenaar446cb832008-06-24 21:56:24 +00004394 'ignorecase' is also on, the case of the match is adjusted depending
4395 on the typed text. If the typed text contains a lowercase letter
4396 where the match has an upper case letter, the completed part is made
4397 lowercase. If the typed text has no lowercase letters and the match
4398 has a lowercase letter where the typed text has an uppercase letter,
4399 and there is a letter before it, the completed part is made uppercase.
4400 With 'noinfercase' the match is used as-is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004401
4402 *'insertmode'* *'im'* *'noinsertmode'* *'noim'*
4403'insertmode' 'im' boolean (default off)
4404 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004405 Makes Vim work in a way that Insert mode is the default mode. Useful
4406 if you want to use Vim as a modeless editor. Used for |evim|.
4407 These Insert mode commands will be useful:
4408 - Use the cursor keys to move around.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004409 - Use CTRL-O to execute one Normal mode command |i_CTRL-O|. When
Bram Moolenaar071d4272004-06-13 20:20:40 +00004410 this is a mapping, it is executed as if 'insertmode' was off.
4411 Normal mode remains active until the mapping is finished.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004412 - Use CTRL-L to execute a number of Normal mode commands, then use
Bram Moolenaar488c6512005-08-11 20:09:58 +00004413 <Esc> to get back to Insert mode. Note that CTRL-L moves the cursor
4414 left, like <Esc> does when 'insertmode' isn't set. |i_CTRL-L|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004415
4416 These items change when 'insertmode' is set:
4417 - when starting to edit of a file, Vim goes to Insert mode.
4418 - <Esc> in Insert mode is a no-op and beeps.
4419 - <Esc> in Normal mode makes Vim go to Insert mode.
4420 - CTRL-L in Insert mode is a command, it is not inserted.
4421 - CTRL-Z in Insert mode suspends Vim, see |CTRL-Z|. *i_CTRL-Z*
4422 However, when <Esc> is used inside a mapping, it behaves like
4423 'insertmode' was not set. This was done to be able to use the same
4424 mappings with 'insertmode' set or not set.
4425 When executing commands with |:normal| 'insertmode' is not used.
4426
4427 NOTE: This option is reset when 'compatible' is set.
4428
4429 *'isfname'* *'isf'*
4430'isfname' 'isf' string (default for MS-DOS, Win32 and OS/2:
4431 "@,48-57,/,\,.,-,_,+,,,#,$,%,{,},[,],:,@-@,!,~,="
4432 for AMIGA: "@,48-57,/,.,-,_,+,,,$,:"
4433 for VMS: "@,48-57,/,.,-,_,+,,,#,$,%,<,>,[,],:,;,~"
4434 for OS/390: "@,240-249,/,.,-,_,+,,,#,$,%,~,="
4435 otherwise: "@,48-57,/,.,-,_,+,,,#,$,%,~,=")
4436 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004437 The characters specified by this option are included in file names and
4438 path names. Filenames are used for commands like "gf", "[i" and in
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004439 the tags file. It is also used for "\f" in a |pattern|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004440 Multi-byte characters 256 and above are always included, only the
4441 characters up to 255 are specified with this option.
4442 For UTF-8 the characters 0xa0 to 0xff are included as well.
Bram Moolenaar446cb832008-06-24 21:56:24 +00004443 Think twice before adding white space to this option. Although a
4444 space may appear inside a file name, the effect will be that Vim
4445 doesn't know where a file name starts or ends when doing completion.
4446 It most likely works better without a space in 'isfname'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004447
4448 Note that on systems using a backslash as path separator, Vim tries to
4449 do its best to make it work as you would expect. That is a bit
4450 tricky, since Vi originally used the backslash to escape special
4451 characters. Vim will not remove a backslash in front of a normal file
4452 name character on these systems, but it will on Unix and alikes. The
4453 '&' and '^' are not included by default, because these are special for
4454 cmd.exe.
4455
4456 The format of this option is a list of parts, separated with commas.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004457 Each part can be a single character number or a range. A range is two
4458 character numbers with '-' in between. A character number can be a
Bram Moolenaar071d4272004-06-13 20:20:40 +00004459 decimal number between 0 and 255 or the ASCII character itself (does
4460 not work for digits). Example:
4461 "_,-,128-140,#-43" (include '_' and '-' and the range
4462 128 to 140 and '#' to 43)
4463 If a part starts with '^', the following character number or range
4464 will be excluded from the option. The option is interpreted from left
4465 to right. Put the excluded character after the range where it is
4466 included. To include '^' itself use it as the last character of the
4467 option or the end of a range. Example:
4468 "^a-z,#,^" (exclude 'a' to 'z', include '#' and '^')
4469 If the character is '@', all characters where isalpha() returns TRUE
4470 are included. Normally these are the characters a to z and A to Z,
4471 plus accented characters. To include '@' itself use "@-@". Examples:
4472 "@,^a-z" All alphabetic characters, excluding lower
Bram Moolenaar446cb832008-06-24 21:56:24 +00004473 case ASCII letters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004474 "a-z,A-Z,@-@" All letters plus the '@' character.
4475 A comma can be included by using it where a character number is
4476 expected. Example:
4477 "48-57,,,_" Digits, comma and underscore.
4478 A comma can be excluded by prepending a '^'. Example:
4479 " -~,^,,9" All characters from space to '~', excluding
4480 comma, plus <Tab>.
4481 See |option-backslash| about including spaces and backslashes.
4482
4483 *'isident'* *'isi'*
4484'isident' 'isi' string (default for MS-DOS, Win32 and OS/2:
4485 "@,48-57,_,128-167,224-235"
4486 otherwise: "@,48-57,_,192-255")
4487 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004488 The characters given by this option are included in identifiers.
4489 Identifiers are used in recognizing environment variables and after a
4490 match of the 'define' option. It is also used for "\i" in a
Bram Moolenaar582fd852005-03-28 20:58:01 +00004491 |pattern|. See 'isfname' for a description of the format of this
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004492 option. For '@' only characters up to 255 are used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004493 Careful: If you change this option, it might break expanding
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004494 environment variables. E.g., when '/' is included and Vim tries to
Bram Moolenaar071d4272004-06-13 20:20:40 +00004495 expand "$HOME/.viminfo". Maybe you should change 'iskeyword' instead.
4496
4497 *'iskeyword'* *'isk'*
4498'iskeyword' 'isk' string (Vim default for MS-DOS and Win32:
4499 "@,48-57,_,128-167,224-235"
4500 otherwise: "@,48-57,_,192-255"
4501 Vi default: "@,48-57,_")
4502 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004503 Keywords are used in searching and recognizing with many commands:
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004504 "w", "*", "[i", etc. It is also used for "\k" in a |pattern|. See
Bram Moolenaar95bafa22018-10-02 13:26:25 +02004505 'isfname' for a description of the format of this option. For '@'
4506 characters above 255 check the "word" character class.
4507 For C programs you could use "a-z,A-Z,48-57,_,.,-,>".
Bram Moolenaar071d4272004-06-13 20:20:40 +00004508 For a help file it is set to all non-blank printable characters except
4509 '*', '"' and '|' (so that CTRL-] on a command finds the help for that
4510 command).
4511 When the 'lisp' option is on the '-' character is always included.
Bram Moolenaarb8060fe2016-01-19 22:29:28 +01004512 This option also influences syntax highlighting, unless the syntax
4513 uses |:syn-iskeyword|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004514 NOTE: This option is set to the Vi default value when 'compatible' is
4515 set and to the Vim default value when 'compatible' is reset.
4516
4517 *'isprint'* *'isp'*
4518'isprint' 'isp' string (default for MS-DOS, Win32, OS/2 and Macintosh:
4519 "@,~-255"; otherwise: "@,161-255")
4520 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004521 The characters given by this option are displayed directly on the
4522 screen. It is also used for "\p" in a |pattern|. The characters from
4523 space (ASCII 32) to '~' (ASCII 126) are always displayed directly,
4524 even when they are not included in 'isprint' or excluded. See
4525 'isfname' for a description of the format of this option.
4526
4527 Non-printable characters are displayed with two characters:
4528 0 - 31 "^@" - "^_"
4529 32 - 126 always single characters
4530 127 "^?"
4531 128 - 159 "~@" - "~_"
4532 160 - 254 "| " - "|~"
4533 255 "~?"
4534 When 'encoding' is a Unicode one, illegal bytes from 128 to 255 are
4535 displayed as <xx>, with the hexadecimal value of the byte.
4536 When 'display' contains "uhex" all unprintable characters are
4537 displayed as <xx>.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004538 The SpecialKey highlighting will be used for unprintable characters.
4539 |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004540
4541 Multi-byte characters 256 and above are always included, only the
4542 characters up to 255 are specified with this option. When a character
4543 is printable but it is not available in the current font, a
4544 replacement character will be shown.
4545 Unprintable and zero-width Unicode characters are displayed as <xxxx>.
4546 There is no option to specify these characters.
4547
4548 *'joinspaces'* *'js'* *'nojoinspaces'* *'nojs'*
4549'joinspaces' 'js' boolean (default on)
4550 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004551 Insert two spaces after a '.', '?' and '!' with a join command.
4552 When 'cpoptions' includes the 'j' flag, only do this after a '.'.
4553 Otherwise only one space is inserted.
4554 NOTE: This option is set when 'compatible' is set.
4555
4556 *'key'*
4557'key' string (default "")
4558 local to buffer
Bram Moolenaar996343d2010-07-04 22:20:21 +02004559 {only available when compiled with the |+cryptv|
4560 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00004561 The key that is used for encrypting and decrypting the current buffer.
Bram Moolenaar40e6a712010-05-16 22:32:54 +02004562 See |encryption| and 'cryptmethod'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004563 Careful: Do not set the key value by hand, someone might see the typed
4564 key. Use the |:X| command. But you can make 'key' empty: >
4565 :set key=
4566< It is not possible to get the value of this option with ":set key" or
4567 "echo &key". This is to avoid showing it to someone who shouldn't
4568 know. It also means you cannot see it yourself once you have set it,
4569 be careful not to make a typing error!
Bram Moolenaard58e9292011-02-09 17:07:58 +01004570 You can use "&key" in an expression to detect whether encryption is
4571 enabled. When 'key' is set it returns "*****" (five stars).
Bram Moolenaar071d4272004-06-13 20:20:40 +00004572
4573 *'keymap'* *'kmp'* *E544*
4574'keymap' 'kmp' string (default "")
4575 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004576 {only available when compiled with the |+keymap|
4577 feature}
4578 Name of a keyboard mapping. See |mbyte-keymap|.
4579 Setting this option to a valid keymap name has the side effect of
4580 setting 'iminsert' to one, so that the keymap becomes effective.
4581 'imsearch' is also set to one, unless it was -1
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004582 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004583
4584 *'keymodel'* *'km'*
4585'keymodel' 'km' string (default "")
4586 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004587 List of comma separated words, which enable special things that keys
4588 can do. These values can be used:
4589 startsel Using a shifted special key starts selection (either
4590 Select mode or Visual mode, depending on "key" being
4591 present in 'selectmode').
4592 stopsel Using a not-shifted special key stops selection.
4593 Special keys in this context are the cursor keys, <End>, <Home>,
4594 <PageUp> and <PageDown>.
4595 The 'keymodel' option is set by the |:behave| command.
4596
4597 *'keywordprg'* *'kp'*
4598'keywordprg' 'kp' string (default "man" or "man -s", DOS: ":help",
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004599 VMS: "help")
Bram Moolenaar071d4272004-06-13 20:20:40 +00004600 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004601 Program to use for the |K| command. Environment variables are
4602 expanded |:set_env|. ":help" may be used to access the Vim internal
4603 help. (Note that previously setting the global option to the empty
4604 value did this, which is now deprecated.)
Bram Moolenaar2ff8b642016-05-24 10:46:45 +02004605 When the first character is ":", the command is invoked as a Vim
4606 Ex command prefixed with [count].
4607 When "man", "man -s" or an Ex command is used, Vim will automatically
4608 translate a count for the "K" command and pass it as the first
4609 argument. For "man -s" the "-s" is removed when there is no count.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004610 See |option-backslash| about including spaces and backslashes.
4611 Example: >
4612 :set keywordprg=man\ -s
4613< This option cannot be set from a |modeline| or in the |sandbox|, for
4614 security reasons.
4615
4616 *'langmap'* *'lmap'* *E357* *E358*
4617'langmap' 'lmap' string (default "")
4618 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004619 {only available when compiled with the |+langmap|
4620 feature}
4621 This option allows switching your keyboard into a special language
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004622 mode. When you are typing text in Insert mode the characters are
Bram Moolenaarfa735342016-01-03 22:14:44 +01004623 inserted directly. When in Normal mode the 'langmap' option takes
Bram Moolenaar071d4272004-06-13 20:20:40 +00004624 care of translating these special characters to the original meaning
4625 of the key. This means you don't have to change the keyboard mode to
4626 be able to execute Normal mode commands.
4627 This is the opposite of the 'keymap' option, where characters are
4628 mapped in Insert mode.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004629 Also consider resetting 'langremap' to avoid 'langmap' applies to
Bram Moolenaarc2299672014-11-13 14:25:38 +01004630 characters resulting from a mapping.
Bram Moolenaare968e362014-05-13 20:23:24 +02004631 This option cannot be set from a |modeline| or in the |sandbox|, for
4632 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004633
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00004634 Example (for Greek, in UTF-8): *greek* >
4635 :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 +00004636< Example (exchanges meaning of z and y for commands): >
4637 :set langmap=zy,yz,ZY,YZ
4638<
4639 The 'langmap' option is a list of parts, separated with commas. Each
4640 part can be in one of two forms:
4641 1. A list of pairs. Each pair is a "from" character immediately
4642 followed by the "to" character. Examples: "aA", "aAbBcC".
4643 2. A list of "from" characters, a semi-colon and a list of "to"
4644 characters. Example: "abc;ABC"
4645 Example: "aA,fgh;FGH,cCdDeE"
4646 Special characters need to be preceded with a backslash. These are
4647 ";", ',' and backslash itself.
4648
4649 This will allow you to activate vim actions without having to switch
4650 back and forth between the languages. Your language characters will
4651 be understood as normal vim English characters (according to the
4652 langmap mappings) in the following cases:
4653 o Normal/Visual mode (commands, buffer/register names, user mappings)
4654 o Insert/Replace Mode: Register names after CTRL-R
4655 o Insert/Replace Mode: Mappings
4656 Characters entered in Command-line mode will NOT be affected by
4657 this option. Note that this option can be changed at any time
4658 allowing to switch between mappings for different languages/encodings.
4659 Use a mapping to avoid having to type it each time!
4660
4661 *'langmenu'* *'lm'*
4662'langmenu' 'lm' string (default "")
4663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004664 {only available when compiled with the |+menu| and
4665 |+multi_lang| features}
4666 Language to use for menu translation. Tells which file is loaded
4667 from the "lang" directory in 'runtimepath': >
4668 "lang/menu_" . &langmenu . ".vim"
4669< (without the spaces). For example, to always use the Dutch menus, no
4670 matter what $LANG is set to: >
4671 :set langmenu=nl_NL.ISO_8859-1
4672< When 'langmenu' is empty, |v:lang| is used.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00004673 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004674 If your $LANG is set to a non-English language but you do want to use
4675 the English menus: >
4676 :set langmenu=none
4677< This option must be set before loading menus, switching on filetype
4678 detection or syntax highlighting. Once the menus are defined setting
4679 this option has no effect. But you could do this: >
4680 :source $VIMRUNTIME/delmenu.vim
4681 :set langmenu=de_DE.ISO_8859-1
4682 :source $VIMRUNTIME/menu.vim
4683< Warning: This deletes all menus that you defined yourself!
4684
Bram Moolenaard94464e2015-11-02 15:28:18 +01004685 *'langnoremap'* *'lnr'* *'nolangnoremap'* *'nolnr'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02004686'langnoremap' 'lnr' boolean (default off, set in |defaults.vim|)
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004687 global
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004688 {only available when compiled with the |+langmap|
4689 feature}
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004690 This is just like 'langremap' but with the value inverted. It only
4691 exists for backwards compatibility. When setting 'langremap' then
4692 'langnoremap' is set to the inverted value, and the other way around.
4693
4694 *'langremap'* *'lrm'* *'nolangremap'* *'nolrm'*
4695'langremap' 'lrm' boolean (default on, reset in |defaults.vim|)
4696 global
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004697 {only available when compiled with the |+langmap|
4698 feature}
4699 When off, setting 'langmap' does not apply to characters resulting from
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004700 a mapping. This basically means, if you noticed that setting
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02004701 'langmap' disables some of your mappings, try resetting this option.
4702 This option defaults to on for backwards compatibility. Set it off if
Bram Moolenaar4391cf92014-11-05 17:44:52 +01004703 that works for you to avoid mappings to break.
4704
Bram Moolenaar071d4272004-06-13 20:20:40 +00004705 *'laststatus'* *'ls'*
4706'laststatus' 'ls' number (default 1)
4707 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004708 The value of this option influences when the last window will have a
4709 status line:
4710 0: never
4711 1: only if there are at least two windows
4712 2: always
4713 The screen looks nicer with a status line if you have several
4714 windows, but it takes another screen line. |status-line|
4715
4716 *'lazyredraw'* *'lz'* *'nolazyredraw'* *'nolz'*
4717'lazyredraw' 'lz' boolean (default off)
4718 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004719 When this option is set, the screen will not be redrawn while
4720 executing macros, registers and other commands that have not been
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004721 typed. Also, updating the window title is postponed. To force an
Bram Moolenaar071d4272004-06-13 20:20:40 +00004722 update use |:redraw|.
4723
4724 *'linebreak'* *'lbr'* *'nolinebreak'* *'nolbr'*
4725'linebreak' 'lbr' boolean (default off)
4726 local to window
Bram Moolenaardb84e452010-08-15 13:50:43 +02004727 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004728 feature}
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004729 If on, Vim will wrap long lines at a character in 'breakat' rather
Bram Moolenaar071d4272004-06-13 20:20:40 +00004730 than at the last character that fits on the screen. Unlike
4731 'wrapmargin' and 'textwidth', this does not insert <EOL>s in the file,
Bram Moolenaar946e27a2014-06-25 18:50:27 +02004732 it only affects the way the file is displayed, not its contents.
4733 If 'breakindent' is set, line is visually indented. Then, the value
4734 of 'showbreak' is used to put in front of wrapped lines. This option
Bram Moolenaar86b17e92014-07-02 20:00:47 +02004735 is not used when the 'wrap' option is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004736 Note that <Tab> characters after an <EOL> are mostly not displayed
4737 with the right amount of white space.
4738
4739 *'lines'* *E593*
4740'lines' number (default 24 or terminal height)
4741 global
4742 Number of lines of the Vim window.
4743 Normally you don't need to set this. It is done automatically by the
Bram Moolenaar7c626922005-02-07 22:01:03 +00004744 terminal initialization code. Also see |posix-screen-size|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004745 When Vim is running in the GUI or in a resizable window, setting this
4746 option will cause the window size to be changed. When you only want
4747 to use the size for the GUI, put the command in your |gvimrc| file.
4748 Vim limits the number of lines to what fits on the screen. You can
4749 use this command to get the tallest window possible: >
4750 :set lines=999
Bram Moolenaarf4d11452005-12-02 00:46:37 +00004751< Minimum value is 2, maximum value is 1000.
Bram Moolenaardc1f1642016-08-16 18:33:43 +02004752 If you get fewer lines than expected, check the 'guiheadroom' option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004753 When you set this option and Vim is unable to change the physical
4754 number of lines of the display, the display may be messed up.
4755
4756 *'linespace'* *'lsp'*
4757'linespace' 'lsp' number (default 0, 1 for Win32 GUI)
4758 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004759 {only in the GUI}
4760 Number of pixel lines inserted between characters. Useful if the font
4761 uses the full character cell height, making lines touch each other.
4762 When non-zero there is room for underlining.
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00004763 With some fonts there can be too much room between lines (to have
4764 space for ascents and descents). Then it makes sense to set
4765 'linespace' to a negative value. This may cause display problems
4766 though!
Bram Moolenaar071d4272004-06-13 20:20:40 +00004767
4768 *'lisp'* *'nolisp'*
4769'lisp' boolean (default off)
4770 local to buffer
4771 {not available when compiled without the |+lispindent|
4772 feature}
4773 Lisp mode: When <Enter> is typed in insert mode set the indent for
4774 the next line to Lisp standards (well, sort of). Also happens with
4775 "cc" or "S". 'autoindent' must also be on for this to work. The 'p'
4776 flag in 'cpoptions' changes the method of indenting: Vi compatible or
4777 better. Also see 'lispwords'.
4778 The '-' character is included in keyword characters. Redefines the
4779 "=" operator to use this same indentation algorithm rather than
4780 calling an external program if 'equalprg' is empty.
4781 This option is not used when 'paste' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004782
4783 *'lispwords'* *'lw'*
4784'lispwords' 'lw' string (default is very long)
Bram Moolenaaraf6c1312014-03-12 18:55:58 +01004785 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004786 {not available when compiled without the |+lispindent|
4787 feature}
4788 Comma separated list of words that influence the Lisp indenting.
4789 |'lisp'|
4790
4791 *'list'* *'nolist'*
4792'list' boolean (default off)
4793 local to window
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004794 List mode: Show tabs as CTRL-I is displayed, display $ after end of
4795 line. Useful to see the difference between tabs and spaces and for
4796 trailing blanks. Further changed by the 'listchars' option.
4797
4798 The cursor is displayed at the start of the space a Tab character
4799 occupies, not at the end as usual in Normal mode. To get this cursor
4800 position while displaying Tabs with spaces, use: >
Bram Moolenaardd007ed2013-07-09 15:44:17 +02004801 :set list lcs=tab:\ \
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01004802<
4803 Note that list mode will also affect formatting (set with 'textwidth'
4804 or 'wrapmargin') when 'cpoptions' includes 'L'. See 'listchars' for
Bram Moolenaar071d4272004-06-13 20:20:40 +00004805 changing the way tabs are displayed.
4806
4807 *'listchars'* *'lcs'*
4808'listchars' 'lcs' string (default "eol:$")
4809 global
Bram Moolenaarf9d5ca12010-08-01 16:13:51 +02004810 Strings to use in 'list' mode and for the |:list| command. It is a
4811 comma separated list of string settings.
Bram Moolenaar79278362015-04-21 18:33:48 +02004812 *lcs-eol*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004813 eol:c Character to show at the end of each line. When
4814 omitted, there is no extra character at the end of the
4815 line.
Bram Moolenaar79278362015-04-21 18:33:48 +02004816 *lcs-tab*
Bram Moolenaar83a52172019-01-16 22:41:54 +01004817 tab:xy[z] Two or three characters to be used to show a tab.
4818 The third character is optional.
4819
4820 tab:xy The 'x' is always used, then 'y' as many times as will
4821 fit. Thus "tab:>-" displays:
4822 >
4823 >-
4824 >--
4825 etc.
4826
4827 tab:xyz The 'z' is always used, then 'x' is prepended, and
4828 then 'y' is used as many times as will fit. Thus
4829 "tab:<->" displays:
4830 >
4831 <>
4832 <->
4833 <-->
4834 etc.
4835
4836 When "tab:" is omitted, a tab is shown as ^I.
Bram Moolenaar79278362015-04-21 18:33:48 +02004837 *lcs-space*
4838 space:c Character to show for a space. When omitted, spaces
4839 are left blank.
4840 *lcs-trail*
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004841 trail:c Character to show for trailing spaces. When omitted,
Bram Moolenaar79278362015-04-21 18:33:48 +02004842 trailing spaces are blank. Overrides the "space"
4843 setting for trailing spaces.
4844 *lcs-extends*
Bram Moolenaar071d4272004-06-13 20:20:40 +00004845 extends:c Character to show in the last column, when 'wrap' is
4846 off and the line continues beyond the right of the
4847 screen.
Bram Moolenaar79278362015-04-21 18:33:48 +02004848 *lcs-precedes*
Bram Moolenaarbffba7f2019-09-20 17:00:17 +02004849 precedes:c Character to show in the first visible column of the
4850 physical line, when there is text preceding the
4851 character visible in the first column.
Bram Moolenaar79278362015-04-21 18:33:48 +02004852 *lcs-conceal*
Bram Moolenaar860cae12010-06-05 23:22:07 +02004853 conceal:c Character to show in place of concealed text, when
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02004854 'conceallevel' is set to 1.
Bram Moolenaar79278362015-04-21 18:33:48 +02004855 *lcs-nbsp*
Bram Moolenaar73284b92015-05-04 17:28:22 +02004856 nbsp:c Character to show for a non-breakable space character
4857 (0xA0 (160 decimal) and U+202F). Left blank when
4858 omitted.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004859
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00004860 The characters ':' and ',' should not be used. UTF-8 characters can
Bram Moolenaar071d4272004-06-13 20:20:40 +00004861 be used when 'encoding' is "utf-8", otherwise only printable
Bram Moolenaar910f66f2006-04-05 20:41:53 +00004862 characters are allowed. All characters must be single width.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004863
4864 Examples: >
4865 :set lcs=tab:>-,trail:-
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00004866 :set lcs=tab:>-,eol:<,nbsp:%
Bram Moolenaar071d4272004-06-13 20:20:40 +00004867 :set lcs=extends:>,precedes:<
4868< The "NonText" highlighting will be used for "eol", "extends" and
Bram Moolenaar79278362015-04-21 18:33:48 +02004869 "precedes". "SpecialKey" for "nbsp", "space", "tab" and "trail".
Bram Moolenaar02467872007-05-06 13:22:01 +00004870 |hl-NonText| |hl-SpecialKey|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004871
4872 *'lpl'* *'nolpl'* *'loadplugins'* *'noloadplugins'*
4873'loadplugins' 'lpl' boolean (default on)
4874 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004875 When on the plugin scripts are loaded when starting up |load-plugins|.
4876 This option can be reset in your |vimrc| file to disable the loading
4877 of plugins.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02004878 Note that using the "-u NONE", "-u DEFAULTS" and "--noplugin" command
4879 line arguments reset this option. See |-u| and |--noplugin|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004880
Bram Moolenaard94464e2015-11-02 15:28:18 +01004881 *'luadll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01004882'luadll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01004883 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01004884 {only available when compiled with the |+lua/dyn|
4885 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01004886 Specifies the name of the Lua shared library. The default is
4887 DYNAMIC_LUA_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02004888 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01004889 This option cannot be set from a |modeline| or in the |sandbox|, for
4890 security reasons.
4891
Bram Moolenaarf9393ef2006-04-24 19:47:27 +00004892 *'macatsui'* *'nomacatsui'*
4893'macatsui' boolean (default on)
4894 global
4895 {only available in Mac GUI version}
4896 This is a workaround for when drawing doesn't work properly. When set
4897 and compiled with multi-byte support ATSUI text drawing is used. When
4898 not set ATSUI text drawing is not used. Switch this option off when
4899 you experience drawing problems. In a future version the problems may
4900 be solved and this option becomes obsolete. Therefore use this method
4901 to unset it: >
4902 if exists('&macatsui')
4903 set nomacatsui
4904 endif
Bram Moolenaar02467872007-05-06 13:22:01 +00004905< Another option to check if you have drawing problems is
4906 'termencoding'.
4907
Bram Moolenaar071d4272004-06-13 20:20:40 +00004908 *'magic'* *'nomagic'*
4909'magic' boolean (default on)
4910 global
4911 Changes the special characters that can be used in search patterns.
4912 See |pattern|.
Bram Moolenaar64d8e252016-09-06 22:12:34 +02004913 WARNING: Switching this option off most likely breaks plugins! That
4914 is because many patterns assume it's on and will fail when it's off.
4915 Only switch it off when working with old Vi scripts. In any other
4916 situation write patterns that work when 'magic' is on. Include "\M"
4917 when you want to |/\M|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00004918
4919 *'makeef'* *'mef'*
4920'makeef' 'mef' string (default: "")
4921 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004922 {not available when compiled without the |+quickfix|
4923 feature}
4924 Name of the errorfile for the |:make| command (see |:make_makeprg|)
4925 and the |:grep| command.
4926 When it is empty, an internally generated temp file will be used.
4927 When "##" is included, it is replaced by a number to make the name
4928 unique. This makes sure that the ":make" command doesn't overwrite an
4929 existing file.
4930 NOT used for the ":cf" command. See 'errorfile' for that.
4931 Environment variables are expanded |:set_env|.
4932 See |option-backslash| about including spaces and backslashes.
4933 This option cannot be set from a |modeline| or in the |sandbox|, for
4934 security reasons.
4935
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004936 *'makeencoding'* *'menc'*
4937'makeencoding' 'menc' string (default "")
4938 global or local to buffer |global-local|
Bram Moolenaar2c7292d2017-03-05 17:43:31 +01004939 Encoding used for reading the output of external commands. When empty,
4940 encoding is not converted.
4941 This is used for `:make`, `:lmake`, `:grep`, `:lgrep`, `:grepadd`,
4942 `:lgrepadd`, `:cfile`, `:cgetfile`, `:caddfile`, `:lfile`, `:lgetfile`,
4943 and `:laddfile`.
4944
4945 This would be mostly useful when you use MS-Windows and set 'encoding'
4946 to "utf-8". If |+iconv| is enabled and GNU libiconv is used, setting
4947 'makeencoding' to "char" has the same effect as setting to the system
4948 locale encoding. Example: >
4949 :set encoding=utf-8
4950 :set makeencoding=char " system locale is used
4951<
Bram Moolenaar071d4272004-06-13 20:20:40 +00004952 *'makeprg'* *'mp'*
4953'makeprg' 'mp' string (default "make", VMS: "MMS")
4954 global or local to buffer |global-local|
Bram Moolenaar02467872007-05-06 13:22:01 +00004955 Program to use for the ":make" command. See |:make_makeprg|.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01004956 This option may contain '%' and '#' characters (see |:_%| and |:_#|),
4957 which are expanded to the current and alternate file name. Use |::S|
Bram Moolenaar26df0922014-02-23 23:39:13 +01004958 to escape file names in case they contain special characters.
Bram Moolenaar02467872007-05-06 13:22:01 +00004959 Environment variables are expanded |:set_env|. See |option-backslash|
4960 about including spaces and backslashes.
4961 Note that a '|' must be escaped twice: once for ":set" and once for
4962 the interpretation of a command. When you use a filter called
4963 "myfilter" do it like this: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004964 :set makeprg=gmake\ \\\|\ myfilter
4965< The placeholder "$*" can be given (even multiple times) to specify
4966 where the arguments will be included, for example: >
4967 :set makeprg=latex\ \\\\nonstopmode\ \\\\input\\{$*}
4968< This option cannot be set from a |modeline| or in the |sandbox|, for
4969 security reasons.
4970
4971 *'matchpairs'* *'mps'*
4972'matchpairs' 'mps' string (default "(:),{:},[:]")
4973 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00004974 Characters that form pairs. The |%| command jumps from one to the
Bram Moolenaara3e6bc92013-01-30 14:18:00 +01004975 other.
4976 Only character pairs are allowed that are different, thus you cannot
4977 jump between two double quotes.
4978 The characters must be separated by a colon.
Bram Moolenaar02467872007-05-06 13:22:01 +00004979 The pairs must be separated by a comma. Example for including '<' and
4980 '>' (HTML): >
Bram Moolenaar071d4272004-06-13 20:20:40 +00004981 :set mps+=<:>
4982
4983< A more exotic example, to jump between the '=' and ';' in an
4984 assignment, useful for languages like C and Java: >
4985 :au FileType c,cpp,java set mps+==:;
4986
4987< For a more advanced way of using "%", see the matchit.vim plugin in
Bram Moolenaar01164a62017-11-02 22:58:42 +01004988 the $VIMRUNTIME/pack/dist/opt/matchit directory. |add-local-help|
Bram Moolenaar071d4272004-06-13 20:20:40 +00004989
4990 *'matchtime'* *'mat'*
4991'matchtime' 'mat' number (default 5)
4992 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00004993 Tenths of a second to show the matching paren, when 'showmatch' is
4994 set. Note that this is not in milliseconds, like other options that
4995 set a time. This is to be compatible with Nvi.
4996
Bram Moolenaar362e1a32006-03-06 23:29:24 +00004997 *'maxcombine'* *'mco'*
4998'maxcombine' 'mco' number (default 2)
4999 global
Bram Moolenaar362e1a32006-03-06 23:29:24 +00005000 The maximum number of combining characters supported for displaying.
5001 Only used when 'encoding' is "utf-8".
5002 The default is OK for most languages. Hebrew may require 4.
5003 Maximum value is 6.
5004 Even when this option is set to 2 you can still edit text with more
5005 combining characters, you just can't see them. Use |g8| or |ga|.
5006 See |mbyte-combining|.
5007
Bram Moolenaar071d4272004-06-13 20:20:40 +00005008 *'maxfuncdepth'* *'mfd'*
5009'maxfuncdepth' 'mfd' number (default 100)
5010 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02005011 {not available when compiled without the |+eval|
Bram Moolenaar02467872007-05-06 13:22:01 +00005012 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005013 Maximum depth of function calls for user functions. This normally
5014 catches endless recursion. When using a recursive function with
5015 more depth, set 'maxfuncdepth' to a bigger number. But this will use
5016 more memory, there is the danger of failing when memory is exhausted.
Bram Moolenaarbc2eada2017-01-02 21:27:47 +01005017 Increasing this limit above 200 also changes the maximum for Ex
Bram Moolenaar0b0f0992018-05-22 21:41:30 +02005018 command recursion, see |E169|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005019 See also |:function|.
5020
5021 *'maxmapdepth'* *'mmd'* *E223*
5022'maxmapdepth' 'mmd' number (default 1000)
5023 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005024 Maximum number of times a mapping is done without resulting in a
5025 character to be used. This normally catches endless mappings, like
5026 ":map x y" with ":map y x". It still does not catch ":map g wg",
5027 because the 'w' is used before the next mapping is done. See also
5028 |key-mapping|.
5029
5030 *'maxmem'* *'mm'*
5031'maxmem' 'mm' number (default between 256 to 5120 (system
5032 dependent) or half the amount of memory
5033 available)
5034 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005035 Maximum amount of memory (in Kbyte) to use for one buffer. When this
5036 limit is reached allocating extra memory for a buffer will cause
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005037 other memory to be freed.
5038 The maximum usable value is about 2000000. Use this to work without a
5039 limit.
5040 The value is ignored when 'swapfile' is off.
5041 Also see 'maxmemtot'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005042
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005043 *'maxmempattern'* *'mmp'*
5044'maxmempattern' 'mmp' number (default 1000)
5045 global
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005046 Maximum amount of memory (in Kbyte) to use for pattern matching.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005047 The maximum value is about 2000000. Use this to work without a limit.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005048 *E363*
Bram Moolenaar02467872007-05-06 13:22:01 +00005049 When Vim runs into the limit it gives an error message and mostly
5050 behaves like CTRL-C was typed.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005051 Running into the limit often means that the pattern is very
5052 inefficient or too complex. This may already happen with the pattern
5053 "\(.\)*" on a very long line. ".*" works much better.
Bram Moolenaarfd358112018-07-07 23:21:31 +02005054 Might also happen on redraw, when syntax rules try to match a complex
5055 text structure.
5056 Vim may run out of memory before hitting the 'maxmempattern' limit, in
5057 which case you get an "Out of memory" error instead.
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00005058
Bram Moolenaar071d4272004-06-13 20:20:40 +00005059 *'maxmemtot'* *'mmt'*
5060'maxmemtot' 'mmt' number (default between 2048 and 10240 (system
5061 dependent) or half the amount of memory
5062 available)
5063 global
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005064 Maximum amount of memory in Kbyte to use for all buffers together.
5065 The maximum usable value is about 2000000 (2 Gbyte). Use this to work
Bram Moolenaarfa735342016-01-03 22:14:44 +01005066 without a limit.
5067 On 64 bit machines higher values might work. But hey, do you really
5068 need more than 2 Gbyte for text editing? Keep in mind that text is
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005069 stored in the swap file, one can edit files > 2 Gbyte anyway. We do
Bram Moolenaarfa735342016-01-03 22:14:44 +01005070 need the memory to store undo info.
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005071 Buffers with 'swapfile' off still count to the total amount of memory
5072 used.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01005073 Also see 'maxmem'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005074
5075 *'menuitems'* *'mis'*
5076'menuitems' 'mis' number (default 25)
5077 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005078 {not available when compiled without the |+menu|
5079 feature}
5080 Maximum number of items to use in a menu. Used for menus that are
5081 generated from a list of items, e.g., the Buffers menu. Changing this
5082 option has no direct effect, the menu must be refreshed first.
5083
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005084 *'mkspellmem'* *'msm'*
5085'mkspellmem' 'msm' string (default "460000,2000,500")
5086 global
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00005087 {not available when compiled without the |+syntax|
5088 feature}
5089 Parameters for |:mkspell|. This tunes when to start compressing the
5090 word tree. Compression can be slow when there are many words, but
5091 it's needed to avoid running out of memory. The amount of memory used
5092 per word depends very much on how similar the words are, that's why
5093 this tuning is complicated.
5094
5095 There are three numbers, separated by commas:
5096 {start},{inc},{added}
5097
5098 For most languages the uncompressed word tree fits in memory. {start}
5099 gives the amount of memory in Kbyte that can be used before any
5100 compression is done. It should be a bit smaller than the amount of
5101 memory that is available to Vim.
5102
5103 When going over the {start} limit the {inc} number specifies the
5104 amount of memory in Kbyte that can be allocated before another
5105 compression is done. A low number means compression is done after
5106 less words are added, which is slow. A high number means more memory
5107 will be allocated.
5108
5109 After doing compression, {added} times 1024 words can be added before
5110 the {inc} limit is ignored and compression is done when any extra
5111 amount of memory is needed. A low number means there is a smaller
5112 chance of hitting the {inc} limit, less memory is used but it's
5113 slower.
5114
5115 The languages for which these numbers are important are Italian and
5116 Hungarian. The default works for when you have about 512 Mbyte. If
5117 you have 1 Gbyte you could use: >
5118 :set mkspellmem=900000,3000,800
5119< If you have less than 512 Mbyte |:mkspell| may fail for some
5120 languages, no matter what you set 'mkspellmem' to.
5121
Bram Moolenaar07607392019-05-26 19:20:43 +02005122 This option cannot be set from a |modeline| or in the |sandbox|.
5123
Bram Moolenaar071d4272004-06-13 20:20:40 +00005124 *'modeline'* *'ml'* *'nomodeline'* *'noml'*
Bram Moolenaar8243a792007-05-01 17:05:03 +00005125'modeline' 'ml' boolean (Vim default: on (off for root),
5126 Vi default: off)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005127 local to buffer
Bram Moolenaar110289e2019-05-23 15:38:06 +02005128 If 'modeline' is on 'modelines' gives the number of lines that is
5129 checked for set commands. If 'modeline' is off or 'modelines' is zero
5130 no lines are checked. See |modeline|.
5131
5132 *'modelineexpr'* *'mle'* *'nomodelineexpr'* *'nomle'*
5133'modelineexpr' 'mle' boolean (default: off)
5134 global
5135 When on allow some options that are an expression to be set in the
5136 modeline. Check the option for whether it is affected by
5137 'modelineexpr'. Also see |modeline|.
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02005138 This option cannot be set from a |modeline| or in the |sandbox|, for
5139 security reasons.
Bram Moolenaar110289e2019-05-23 15:38:06 +02005140
Bram Moolenaar071d4272004-06-13 20:20:40 +00005141 *'modelines'* *'mls'*
5142'modelines' 'mls' number (default 5)
5143 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005144 If 'modeline' is on 'modelines' gives the number of lines that is
5145 checked for set commands. If 'modeline' is off or 'modelines' is zero
5146 no lines are checked. See |modeline|.
5147 NOTE: 'modeline' is set to the Vi default value when 'compatible' is
5148 set and to the Vim default value when 'compatible' is reset.
5149
5150 *'modifiable'* *'ma'* *'nomodifiable'* *'noma'*
Bram Moolenaar110289e2019-05-23 15:38:06 +02005151 *E21*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005152'modifiable' 'ma' boolean (default on)
5153 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005154 When off the buffer contents cannot be changed. The 'fileformat' and
5155 'fileencoding' options also can't be changed.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005156 Can be reset on startup with the |-M| command line argument.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005157
5158 *'modified'* *'mod'* *'nomodified'* *'nomod'*
5159'modified' 'mod' boolean (default off)
5160 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005161 When on, the buffer is considered to be modified. This option is set
5162 when:
5163 1. A change was made to the text since it was last written. Using the
5164 |undo| command to go back to the original text will reset the
5165 option. But undoing changes that were made before writing the
5166 buffer will set the option again, since the text is different from
5167 when it was written.
5168 2. 'fileformat' or 'fileencoding' is different from its original
5169 value. The original value is set when the buffer is read or
5170 written. A ":set nomodified" command also resets the original
5171 values to the current values and the 'modified' option will be
5172 reset.
Bram Moolenaar4f3f6682016-03-26 23:01:59 +01005173 Similarly for 'eol' and 'bomb'.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02005174 This option is not set when a change is made to the buffer as the
5175 result of a BufNewFile, BufRead/BufReadPost, BufWritePost,
5176 FileAppendPost or VimLeave autocommand event. See |gzip-example| for
5177 an explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005178 When 'buftype' is "nowrite" or "nofile" this option may be set, but
5179 will be ignored.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01005180 Note that the text may actually be the same, e.g. 'modified' is set
5181 when using "rA" on an "A".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005182
5183 *'more'* *'nomore'*
5184'more' boolean (Vim default: on, Vi default: off)
5185 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005186 When on, listings pause when the whole screen is filled. You will get
5187 the |more-prompt|. When this option is off there are no pauses, the
5188 listing continues until finished.
5189 NOTE: This option is set to the Vi default value when 'compatible' is
5190 set and to the Vim default value when 'compatible' is reset.
5191
5192 *'mouse'* *E538*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005193'mouse' string (default "", "a" for GUI, MS-DOS and Win32,
5194 set to "a" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005195 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005196 Enable the use of the mouse. Only works for certain terminals
Bram Moolenaar446cb832008-06-24 21:56:24 +00005197 (xterm, MS-DOS, Win32 |win32-mouse|, QNX pterm, *BSD console with
5198 sysmouse and Linux console with gpm). For using the mouse in the
5199 GUI, see |gui-mouse|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005200 The mouse can be enabled for different modes:
Bram Moolenaar7f2e9d72017-11-11 20:58:53 +01005201 n Normal mode and Terminal modes
Bram Moolenaar071d4272004-06-13 20:20:40 +00005202 v Visual mode
5203 i Insert mode
5204 c Command-line mode
5205 h all previous modes when editing a help file
5206 a all previous modes
5207 r for |hit-enter| and |more-prompt| prompt
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005208 Normally you would enable the mouse in all five modes with: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00005209 :set mouse=a
5210< When the mouse is not enabled, the GUI will still use the mouse for
5211 modeless selection. This doesn't move the text cursor.
5212
5213 See |mouse-using|. Also see |'clipboard'|.
5214
5215 Note: When enabling the mouse in a terminal, copy/paste will use the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005216 "* register if there is access to an X-server. The xterm handling of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005217 the mouse buttons can still be used by keeping the shift key pressed.
5218 Also see the 'clipboard' option.
5219
5220 *'mousefocus'* *'mousef'* *'nomousefocus'* *'nomousef'*
5221'mousefocus' 'mousef' boolean (default off)
5222 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005223 {only works in the GUI}
5224 The window that the mouse pointer is on is automatically activated.
5225 When changing the window layout or window focus in another way, the
5226 mouse pointer is moved to the window with keyboard focus. Off is the
5227 default because it makes using the pull down menus a little goofy, as
5228 a pointer transit may activate a window unintentionally.
5229
5230 *'mousehide'* *'mh'* *'nomousehide'* *'nomh'*
5231'mousehide' 'mh' boolean (default on)
5232 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005233 {only works in the GUI}
5234 When on, the mouse pointer is hidden when characters are typed.
5235 The mouse pointer is restored when the mouse is moved.
5236
5237 *'mousemodel'* *'mousem'*
5238'mousemodel' 'mousem' string (default "extend", "popup" for MS-DOS and Win32)
5239 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005240 Sets the model to use for the mouse. The name mostly specifies what
5241 the right mouse button is used for:
5242 extend Right mouse button extends a selection. This works
5243 like in an xterm.
5244 popup Right mouse button pops up a menu. The shifted left
5245 mouse button extends a selection. This works like
Bram Moolenaar582fd852005-03-28 20:58:01 +00005246 with Microsoft Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005247 popup_setpos Like "popup", but the cursor will be moved to the
5248 position where the mouse was clicked, and thus the
5249 selected operation will act upon the clicked object.
5250 If clicking inside a selection, that selection will
Bram Moolenaar582fd852005-03-28 20:58:01 +00005251 be acted upon, i.e. no cursor move. This implies of
Bram Moolenaar071d4272004-06-13 20:20:40 +00005252 course, that right clicking outside a selection will
5253 end Visual mode.
5254 Overview of what button does what for each model:
5255 mouse extend popup(_setpos) ~
5256 left click place cursor place cursor
5257 left drag start selection start selection
5258 shift-left search word extend selection
5259 right click extend selection popup menu (place cursor)
5260 right drag extend selection -
5261 middle click paste paste
5262
5263 In the "popup" model the right mouse button produces a pop-up menu.
5264 You need to define this first, see |popup-menu|.
5265
5266 Note that you can further refine the meaning of buttons with mappings.
5267 See |gui-mouse-mapping|. But mappings are NOT used for modeless
5268 selection (because that's handled in the GUI code directly).
5269
5270 The 'mousemodel' option is set by the |:behave| command.
5271
5272 *'mouseshape'* *'mouses'* *E547*
Bram Moolenaarf6b40102019-02-22 15:24:03 +01005273'mouseshape' 'mouses' string (default "i-r:beam,s:updown,sd:udsizing,
5274 vs:leftright,vd:lrsizing,m:no,
5275 ml:up-arrow,v:rightup-arrow")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005276 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005277 {only available when compiled with the |+mouseshape|
5278 feature}
5279 This option tells Vim what the mouse pointer should look like in
5280 different modes. The option is a comma separated list of parts, much
5281 like used for 'guicursor'. Each part consist of a mode/location-list
5282 and an argument-list:
5283 mode-list:shape,mode-list:shape,..
5284 The mode-list is a dash separated list of these modes/locations:
5285 In a normal window: ~
5286 n Normal mode
5287 v Visual mode
5288 ve Visual mode with 'selection' "exclusive" (same as 'v',
5289 if not specified)
5290 o Operator-pending mode
5291 i Insert mode
5292 r Replace mode
5293
5294 Others: ~
5295 c appending to the command-line
5296 ci inserting in the command-line
5297 cr replacing in the command-line
5298 m at the 'Hit ENTER' or 'More' prompts
5299 ml idem, but cursor in the last line
5300 e any mode, pointer below last window
5301 s any mode, pointer on a status line
5302 sd any mode, while dragging a status line
5303 vs any mode, pointer on a vertical separator line
5304 vd any mode, while dragging a vertical separator line
5305 a everywhere
5306
5307 The shape is one of the following:
5308 avail name looks like ~
5309 w x arrow Normal mouse pointer
5310 w x blank no pointer at all (use with care!)
5311 w x beam I-beam
5312 w x updown up-down sizing arrows
5313 w x leftright left-right sizing arrows
5314 w x busy The system's usual busy pointer
5315 w x no The system's usual 'no input' pointer
5316 x udsizing indicates up-down resizing
5317 x lrsizing indicates left-right resizing
5318 x crosshair like a big thin +
5319 x hand1 black hand
5320 x hand2 white hand
5321 x pencil what you write with
5322 x question big ?
5323 x rightup-arrow arrow pointing right-up
5324 w x up-arrow arrow pointing up
5325 x <number> any X11 pointer number (see X11/cursorfont.h)
5326
5327 The "avail" column contains a 'w' if the shape is available for Win32,
5328 x for X11.
5329 Any modes not specified or shapes not available use the normal mouse
5330 pointer.
5331
5332 Example: >
5333 :set mouseshape=s:udsizing,m:no
5334< will make the mouse turn to a sizing arrow over the status lines and
5335 indicate no input when the hit-enter prompt is displayed (since
5336 clicking the mouse has no effect in this state.)
5337
5338 *'mousetime'* *'mouset'*
5339'mousetime' 'mouset' number (default 500)
5340 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005341 Only for GUI, MS-DOS, Win32 and Unix with xterm. Defines the maximum
5342 time in msec between two mouse clicks for the second click to be
5343 recognized as a multi click.
5344
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005345 *'mzschemedll'*
5346'mzschemedll' string (default depends on the build)
5347 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005348 {only available when compiled with the |+mzscheme/dyn|
5349 feature}
5350 Specifies the name of the MzScheme shared library. The default is
5351 DYNAMIC_MZSCH_DLL which was specified at compile time.
5352 Environment variables are expanded |:set_env|.
Bram Moolenaarb0d45e72017-11-05 18:19:24 +01005353 The value must be set in the |vimrc| script or earlier. In the
Bram Moolenaar01164a62017-11-02 22:58:42 +01005354 startup, before the |load-plugins| step.
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005355 This option cannot be set from a |modeline| or in the |sandbox|, for
5356 security reasons.
5357
5358 *'mzschemegcdll'*
5359'mzschemegcdll' string (default depends on the build)
5360 global
Bram Moolenaar0ab35b22017-10-08 17:41:37 +02005361 {only available when compiled with the |+mzscheme/dyn|
5362 feature}
5363 Specifies the name of the MzScheme GC shared library. The default is
5364 DYNAMIC_MZGC_DLL which was specified at compile time.
5365 The value can be equal to 'mzschemedll' if it includes the GC code.
5366 Environment variables are expanded |:set_env|.
5367 This option cannot be set from a |modeline| or in the |sandbox|, for
5368 security reasons.
5369
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005370 *'mzquantum'* *'mzq'*
5371'mzquantum' 'mzq' number (default 100)
5372 global
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005373 {not available when compiled without the |+mzscheme|
5374 feature}
5375 The number of milliseconds between polls for MzScheme threads.
5376 Negative or zero value means no thread scheduling.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005377 NOTE: This option is set to the Vim default value when 'compatible'
5378 is reset.
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005379
Bram Moolenaar071d4272004-06-13 20:20:40 +00005380 *'nrformats'* *'nf'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02005381'nrformats' 'nf' string (default "bin,octal,hex",
5382 set to "bin,hex" in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005383 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005384 This defines what bases Vim will consider for numbers when using the
5385 CTRL-A and CTRL-X commands for adding to and subtracting from a number
5386 respectively; see |CTRL-A| for more info on these commands.
Bram Moolenaar4770d092006-01-12 23:22:24 +00005387 alpha If included, single alphabetical characters will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005388 incremented or decremented. This is useful for a list with a
Bram Moolenaar3848e002016-03-19 18:42:29 +01005389 letter index a), b), etc. *octal-nrformats*
Bram Moolenaar4770d092006-01-12 23:22:24 +00005390 octal If included, numbers that start with a zero will be considered
Bram Moolenaar071d4272004-06-13 20:20:40 +00005391 to be octal. Example: Using CTRL-A on "007" results in "010".
Bram Moolenaar4770d092006-01-12 23:22:24 +00005392 hex If included, numbers starting with "0x" or "0X" will be
Bram Moolenaar071d4272004-06-13 20:20:40 +00005393 considered to be hexadecimal. Example: Using CTRL-X on
5394 "0x100" results in "0x0ff".
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005395 bin If included, numbers starting with "0b" or "0B" will be
5396 considered to be binary. Example: Using CTRL-X on
5397 "0b1000" subtracts one, resulting in "0b0111".
Bram Moolenaar071d4272004-06-13 20:20:40 +00005398 Numbers which simply begin with a digit in the range 1-9 are always
5399 considered decimal. This also happens for numbers that are not
5400 recognized as octal or hex.
5401
5402 *'number'* *'nu'* *'nonumber'* *'nonu'*
5403'number' 'nu' boolean (default off)
5404 local to window
5405 Print the line number in front of each line. When the 'n' option is
5406 excluded from 'cpoptions' a wrapped line will not use the column of
5407 line numbers (this is the default when 'compatible' isn't set).
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005408 The 'numberwidth' option can be used to set the room used for the line
5409 number.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005410 When a long, wrapped line doesn't start with the first character, '-'
5411 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005412 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5413 the number.
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005414 *number_relativenumber*
5415 The 'relativenumber' option changes the displayed number to be
5416 relative to the cursor. Together with 'number' there are these
5417 four combinations (cursor in line 3):
5418
Bram Moolenaar3848e002016-03-19 18:42:29 +01005419 'nonu' 'nu' 'nonu' 'nu'
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005420 'nornu' 'nornu' 'rnu' 'rnu'
5421
5422 |apple | 1 apple | 2 apple | 2 apple
5423 |pear | 2 pear | 1 pear | 1 pear
5424 |nobody | 3 nobody | 0 nobody |3 nobody
5425 |there | 4 there | 1 there | 1 there
Bram Moolenaar071d4272004-06-13 20:20:40 +00005426
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005427 *'numberwidth'* *'nuw'*
5428'numberwidth' 'nuw' number (Vim default: 4 Vi default: 8)
5429 local to window
Bram Moolenaar325b7a22004-07-05 15:58:32 +00005430 {only available when compiled with the |+linebreak|
5431 feature}
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005432 Minimal number of columns to use for the line number. Only relevant
Bram Moolenaar64486672010-05-16 15:46:46 +02005433 when the 'number' or 'relativenumber' option is set or printing lines
5434 with a line number. Since one space is always between the number and
5435 the text, there is one less character for the number itself.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005436 The value is the minimum width. A bigger width is used when needed to
Bram Moolenaar64486672010-05-16 15:46:46 +02005437 fit the highest line number in the buffer respectively the number of
5438 rows in the window, depending on whether 'number' or 'relativenumber'
5439 is set. Thus with the Vim default of 4 there is room for a line number
5440 up to 999. When the buffer has 1000 lines five columns will be used.
Bram Moolenaarf8a07122019-07-01 22:06:07 +02005441 The minimum value is 1, the maximum value is 20.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005442 NOTE: This option is set to the Vi default value when 'compatible' is
5443 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar592e0a22004-07-03 16:05:59 +00005444
Bram Moolenaarf75a9632005-09-13 21:20:47 +00005445 *'omnifunc'* *'ofu'*
5446'omnifunc' 'ofu' string (default: empty)
Bram Moolenaare344bea2005-09-01 20:46:49 +00005447 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02005448 {not available when compiled without the |+eval|
Bram Moolenaare2c453d2019-08-21 14:37:09 +02005449 feature}
Bram Moolenaarc7486e02005-12-29 22:48:26 +00005450 This option specifies a function to be used for Insert mode omni
5451 completion with CTRL-X CTRL-O. |i_CTRL-X_CTRL-O|
Bram Moolenaar280f1262006-01-30 00:14:18 +00005452 See |complete-functions| for an explanation of how the function is
5453 invoked and what it should return.
Bram Moolenaar043545e2006-10-10 16:44:07 +00005454 This option is usually set by a filetype plugin:
Bram Moolenaar9c102382006-05-03 21:26:49 +00005455 |:filetype-plugin-on|
Bram Moolenaar30b65812012-07-12 22:01:11 +02005456 This option cannot be set from a |modeline| or in the |sandbox|, for
5457 security reasons.
Bram Moolenaare344bea2005-09-01 20:46:49 +00005458
5459
Bram Moolenaar02467872007-05-06 13:22:01 +00005460 *'opendevice'* *'odev'* *'noopendevice'* *'noodev'*
Bram Moolenaar043545e2006-10-10 16:44:07 +00005461'opendevice' 'odev' boolean (default off)
5462 global
Bram Moolenaar043545e2006-10-10 16:44:07 +00005463 {only for MS-DOS, MS-Windows and OS/2}
5464 Enable reading and writing from devices. This may get Vim stuck on a
5465 device that can be opened but doesn't actually do the I/O. Therefore
5466 it is off by default.
5467 Note that on MS-Windows editing "aux.h", "lpt1.txt" and the like also
5468 result in editing a device.
5469
5470
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005471 *'operatorfunc'* *'opfunc'*
5472'operatorfunc' 'opfunc' string (default: empty)
5473 global
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00005474 This option specifies a function to be called by the |g@| operator.
5475 See |:map-operator| for more info and an example.
5476
5477 This option cannot be set from a |modeline| or in the |sandbox|, for
5478 security reasons.
5479
5480
Bram Moolenaar251e1912011-06-19 05:09:16 +02005481 *'osfiletype'* *'oft'*
5482'osfiletype' 'oft' string (default: "")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005483 local to buffer
Bram Moolenaar251e1912011-06-19 05:09:16 +02005484 This option was supported on RISC OS, which has been removed.
5485
Bram Moolenaar071d4272004-06-13 20:20:40 +00005486
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005487 *'packpath'* *'pp'*
5488'packpath' 'pp' string (default: see 'runtimepath')
Bram Moolenaarf6fee0e2016-02-21 23:02:49 +01005489 Directories used to find packages. See |packages|.
5490
5491
Bram Moolenaar071d4272004-06-13 20:20:40 +00005492 *'paragraphs'* *'para'*
Bram Moolenaar57e48462008-03-12 16:38:55 +00005493'paragraphs' 'para' string (default "IPLPPPQPP TPHPLIPpLpItpplpipbp")
Bram Moolenaar071d4272004-06-13 20:20:40 +00005494 global
5495 Specifies the nroff macros that separate paragraphs. These are pairs
5496 of two letters (see |object-motions|).
5497
5498 *'paste'* *'nopaste'*
5499'paste' boolean (default off)
5500 global
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005501 Put Vim in Paste mode. This is useful if you want to cut or copy
5502 some text from one window and paste it in Vim. This will avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00005503 unexpected effects.
5504 Setting this option is useful when using Vim in a terminal, where Vim
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005505 cannot distinguish between typed text and pasted text. In the GUI, Vim
Bram Moolenaar071d4272004-06-13 20:20:40 +00005506 knows about pasting and will mostly do the right thing without 'paste'
5507 being set. The same is true for a terminal where Vim handles the
5508 mouse clicks itself.
Bram Moolenaar2ce06f62005-01-31 19:19:04 +00005509 This option is reset when starting the GUI. Thus if you set it in
5510 your .vimrc it will work in a terminal, but not in the GUI. Setting
5511 'paste' in the GUI has side effects: e.g., the Paste toolbar button
5512 will no longer work in Insert mode, because it uses a mapping.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005513 When the 'paste' option is switched on (also when it was already on):
5514 - mapping in Insert mode and Command-line mode is disabled
5515 - abbreviations are disabled
Bram Moolenaar071d4272004-06-13 20:20:40 +00005516 - 'autoindent' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005517 - 'expandtab' is reset
5518 - 'formatoptions' is used like it is empty
Bram Moolenaar071d4272004-06-13 20:20:40 +00005519 - 'revins' is reset
5520 - 'ruler' is reset
5521 - 'showmatch' is reset
Bram Moolenaarca635012015-09-25 20:34:21 +02005522 - 'smartindent' is reset
5523 - 'smarttab' is reset
5524 - 'softtabstop' is set to 0
5525 - 'textwidth' is set to 0
5526 - 'wrapmargin' is set to 0
Bram Moolenaar071d4272004-06-13 20:20:40 +00005527 These options keep their value, but their effect is disabled:
Bram Moolenaar071d4272004-06-13 20:20:40 +00005528 - 'cindent'
Bram Moolenaarca635012015-09-25 20:34:21 +02005529 - 'indentexpr'
5530 - 'lisp'
Bram Moolenaar071d4272004-06-13 20:20:40 +00005531 NOTE: When you start editing another file while the 'paste' option is
5532 on, settings from the modelines or autocommands may change the
5533 settings again, causing trouble when pasting text. You might want to
5534 set the 'paste' option again.
5535 When the 'paste' option is reset the mentioned options are restored to
5536 the value before the moment 'paste' was switched from off to on.
5537 Resetting 'paste' before ever setting it does not have any effect.
5538 Since mapping doesn't work while 'paste' is active, you need to use
5539 the 'pastetoggle' option to toggle the 'paste' option with some key.
5540
5541 *'pastetoggle'* *'pt'*
5542'pastetoggle' 'pt' string (default "")
5543 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005544 When non-empty, specifies the key sequence that toggles the 'paste'
5545 option. This is like specifying a mapping: >
5546 :map {keys} :set invpaste<CR>
5547< Where {keys} is the value of 'pastetoggle'.
5548 The difference is that it will work even when 'paste' is set.
5549 'pastetoggle' works in Insert mode and Normal mode, but not in
5550 Command-line mode.
5551 Mappings are checked first, thus overrule 'pastetoggle'. However,
5552 when 'paste' is on mappings are ignored in Insert mode, thus you can do
5553 this: >
5554 :map <F10> :set paste<CR>
5555 :map <F11> :set nopaste<CR>
5556 :imap <F10> <C-O>:set paste<CR>
5557 :imap <F11> <nop>
5558 :set pastetoggle=<F11>
5559< This will make <F10> start paste mode and <F11> stop paste mode.
5560 Note that typing <F10> in paste mode inserts "<F10>", since in paste
5561 mode everything is inserted literally, except the 'pastetoggle' key
5562 sequence.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005563 When the value has several bytes 'ttimeoutlen' applies.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005564
5565 *'pex'* *'patchexpr'*
5566'patchexpr' 'pex' string (default "")
5567 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005568 {not available when compiled without the |+diff|
5569 feature}
5570 Expression which is evaluated to apply a patch to a file and generate
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005571 the resulting new version of the file. See |diff-patchexpr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005572
Bram Moolenaardbc28022014-07-26 13:40:44 +02005573 *'patchmode'* *'pm'* *E205* *E206*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005574'patchmode' 'pm' string (default "")
5575 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005576 When non-empty the oldest version of a file is kept. This can be used
5577 to keep the original version of a file if you are changing files in a
5578 source distribution. Only the first time that a file is written a
5579 copy of the original file will be kept. The name of the copy is the
5580 name of the original file with the string in the 'patchmode' option
5581 appended. This option should start with a dot. Use a string like
Bram Moolenaardf980db2017-12-24 13:22:00 +01005582 ".orig" or ".org". 'backupdir' must not be empty for this to work
5583 (Detail: The backup file is renamed to the patchmode file after the
5584 new file has been successfully written, that's why it must be possible
5585 to write a backup file). If there was no file to be backed up, an
5586 empty file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005587 When the 'backupskip' pattern matches, a patchmode file is not made.
5588 Using 'patchmode' for compressed files appends the extension at the
5589 end (e.g., "file.gz.orig"), thus the resulting name isn't always
5590 recognized as a compressed file.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005591 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005592
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01005593 *'path'* *'pa'* *E343* *E345* *E347* *E854*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005594'path' 'pa' string (default on Unix: ".,/usr/include,,"
5595 on OS/2: ".,/emx/include,,"
5596 other systems: ".,,")
5597 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00005598 This is a list of directories which will be searched when using the
Bram Moolenaarc236c162008-07-13 17:41:49 +00005599 |gf|, [f, ]f, ^Wf, |:find|, |:sfind|, |:tabfind| and other commands,
5600 provided that the file being searched for has a relative path (not
5601 starting with "/", "./" or "../"). The directories in the 'path'
5602 option may be relative or absolute.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005603 - Use commas to separate directory names: >
5604 :set path=.,/usr/local/include,/usr/include
5605< - Spaces can also be used to separate directory names (for backwards
5606 compatibility with version 3.0). To have a space in a directory
5607 name, precede it with an extra backslash, and escape the space: >
5608 :set path=.,/dir/with\\\ space
5609< - To include a comma in a directory name precede it with an extra
5610 backslash: >
5611 :set path=.,/dir/with\\,comma
5612< - To search relative to the directory of the current file, use: >
5613 :set path=.
5614< - To search in the current directory use an empty string between two
5615 commas: >
5616 :set path=,,
5617< - A directory name may end in a ':' or '/'.
5618 - Environment variables are expanded |:set_env|.
5619 - When using |netrw.vim| URLs can be used. For example, adding
5620 "http://www.vim.org" will make ":find index.html" work.
Bram Moolenaarc236c162008-07-13 17:41:49 +00005621 - Search upwards and downwards in a directory tree using "*", "**" and
5622 ";". See |file-searching| for info and syntax.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005623 {not available when compiled without the |+path_extra| feature}
5624 - Careful with '\' characters, type two to get one in the option: >
5625 :set path=.,c:\\include
5626< Or just use '/' instead: >
5627 :set path=.,c:/include
5628< Don't forget "." or files won't even be found in the same directory as
5629 the file!
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005630 The maximum length is limited. How much depends on the system, mostly
Bram Moolenaar071d4272004-06-13 20:20:40 +00005631 it is something like 256 or 1024 characters.
5632 You can check if all the include files are found, using the value of
5633 'path', see |:checkpath|.
5634 The use of |:set+=| and |:set-=| is preferred when adding or removing
5635 directories from the list. This avoids problems when a future version
5636 uses another default. To remove the current directory use: >
5637 :set path-=
5638< To add the current directory use: >
5639 :set path+=
5640< To use an environment variable, you probably need to replace the
5641 separator. Here is an example to append $INCL, in which directory
5642 names are separated with a semi-colon: >
5643 :let &path = &path . "," . substitute($INCL, ';', ',', 'g')
5644< Replace the ';' with a ':' or whatever separator is used. Note that
5645 this doesn't work when $INCL contains a comma or white space.
5646
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005647 *'perldll'*
5648'perldll' string (default depends on the build)
5649 global
Bram Moolenaar37c64c72017-09-19 22:06:03 +02005650 {only available when compiled with the |+perl/dyn|
5651 feature}
5652 Specifies the name of the Perl shared library. The default is
5653 DYNAMIC_PERL_DLL, which was specified at compile time.
5654 Environment variables are expanded |:set_env|.
5655 This option cannot be set from a |modeline| or in the |sandbox|, for
5656 security reasons.
5657
Bram Moolenaar071d4272004-06-13 20:20:40 +00005658 *'preserveindent'* *'pi'* *'nopreserveindent'* *'nopi'*
5659'preserveindent' 'pi' boolean (default off)
5660 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00005661 When changing the indent of the current line, preserve as much of the
5662 indent structure as possible. Normally the indent is replaced by a
5663 series of tabs followed by spaces as required (unless |'expandtab'| is
5664 enabled, in which case only spaces are used). Enabling this option
5665 means the indent will preserve as many existing characters as possible
5666 for indenting, and only add additional tabs or spaces as required.
Bram Moolenaar446cb832008-06-24 21:56:24 +00005667 'expandtab' does not apply to the preserved white space, a Tab remains
5668 a Tab.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005669 NOTE: When using ">>" multiple times the resulting indent is a mix of
5670 tabs and spaces. You might not like this.
Bram Moolenaar036986f2017-03-16 17:41:02 +01005671 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005672 Also see 'copyindent'.
5673 Use |:retab| to clean up white space.
5674
5675 *'previewheight'* *'pvh'*
5676'previewheight' 'pvh' number (default 12)
5677 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005678 {not available when compiled without the |+quickfix|
5679 feature}
Bram Moolenaar071d4272004-06-13 20:20:40 +00005680 Default height for a preview window. Used for |:ptag| and associated
Bram Moolenaar79648732019-07-18 21:43:07 +02005681 commands. Used for |CTRL-W_}| when no count is given. Not used when
5682 'previewpopup' is set.
5683
5684 *'previewpopup'* *'pvp'*
5685'previewpopup' 'pvp' string (default empty)
5686 global
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005687 {not available when compiled without the |+textprop|
5688 or |+quickfix| feature}
Bram Moolenaar79648732019-07-18 21:43:07 +02005689 When not empty a popup window is used for commands that would open a
5690 preview window. See |preview-popup|.
Bram Moolenaar576a4a62019-08-18 15:25:17 +02005691 Not used for the insert completion info, add "popup" to
5692 'completeopt' for that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005693
5694 *'previewwindow'* *'nopreviewwindow'*
5695 *'pvw'* *'nopvw'* *E590*
5696'previewwindow' 'pvw' boolean (default off)
5697 local to window
Bram Moolenaar62a0cb42019-08-18 16:35:23 +02005698 {not available when compiled without the |+quickfix|
5699 feature}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00005700 Identifies the preview window. Only one window can have this option
Bram Moolenaar071d4272004-06-13 20:20:40 +00005701 set. It's normally not set directly, but by using one of the commands
5702 |:ptag|, |:pedit|, etc.
5703
5704 *'printdevice'* *'pdev'*
5705'printdevice' 'pdev' string (default empty)
5706 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005707 {only available when compiled with the |+printer|
5708 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005709 The name of the printer to be used for |:hardcopy|.
5710 See |pdev-option|.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00005711 This option cannot be set from a |modeline| or in the |sandbox|, for
5712 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005713
Bram Moolenaar8299df92004-07-10 09:47:34 +00005714 *'printencoding'* *'penc'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005715'printencoding' 'penc' string (default empty, except for some systems)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005716 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005717 {only available when compiled with the |+printer|
5718 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005719 Sets the character encoding used when printing.
5720 See |penc-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005721
5722 *'printexpr'* *'pexpr'*
Bram Moolenaar95bafa22018-10-02 13:26:25 +02005723'printexpr' 'pexpr' string (default: see below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00005724 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005725 {only available when compiled with the |+printer|
5726 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005727 Expression used to print the PostScript produced with |:hardcopy|.
5728 See |pexpr-option|.
Bram Moolenaar51628222016-12-01 23:03:28 +01005729 This option cannot be set from a |modeline| or in the |sandbox|, for
5730 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005731
Bram Moolenaar8299df92004-07-10 09:47:34 +00005732 *'printfont'* *'pfn'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00005733'printfont' 'pfn' string (default "courier")
5734 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005735 {only available when compiled with the |+printer|
5736 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005737 The name of the font that will be used for |:hardcopy|.
5738 See |pfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005739
5740 *'printheader'* *'pheader'*
5741'printheader' 'pheader' string (default "%<%f%h%m%=Page %N")
5742 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005743 {only available when compiled with the |+printer|
5744 feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005745 The format of the header produced in |:hardcopy| output.
5746 See |pheader-option|.
5747
5748 *'printmbcharset'* *'pmbcs'*
5749'printmbcharset' 'pmbcs' string (default "")
5750 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005751 {only available when compiled with the |+printer|
5752 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005753 The CJK character set to be used for CJK output from |:hardcopy|.
5754 See |pmbcs-option|.
5755
5756 *'printmbfont'* *'pmbfn'*
5757'printmbfont' 'pmbfn' string (default "")
5758 global
Bram Moolenaar4c92e752019-02-17 21:18:32 +01005759 {only available when compiled with the |+printer|
5760 and |+postscript| features}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005761 List of font names to be used for CJK output from |:hardcopy|.
5762 See |pmbfn-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005763
5764 *'printoptions'* *'popt'*
5765'printoptions' 'popt' string (default "")
5766 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00005767 {only available when compiled with |+printer| feature}
Bram Moolenaar8299df92004-07-10 09:47:34 +00005768 List of items that control the format of the output of |:hardcopy|.
5769 See |popt-option|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005770
Bram Moolenaar26a60b42005-02-22 08:49:11 +00005771 *'prompt'* *'noprompt'*
5772'prompt' boolean (default on)
5773 global
5774 When on a ":" prompt is used in Ex mode.
5775
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005776 *'pumheight'* *'ph'*
5777'pumheight' 'ph' number (default 0)
5778 global
Bram Moolenaar06a89a52006-04-29 22:01:03 +00005779 Determines the maximum number of items to show in the popup menu for
5780 Insert mode completion. When zero as much space as available is used.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005781 |ins-completion-menu|.
5782
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005783 *'pumwidth'* *'pw'*
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005784'pumwidth' 'pw' number (default 15)
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005785 global
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005786 Determines the minimum width to use for the popup menu for Insert mode
Bram Moolenaarcafafb32018-02-22 21:07:09 +01005787 completion. |ins-completion-menu|.
Bram Moolenaara8f04aa2018-02-10 15:36:55 +01005788
Bram Moolenaard94464e2015-11-02 15:28:18 +01005789 *'pythondll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01005790'pythondll' string (default depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01005791 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01005792 {only available when compiled with the |+python/dyn|
5793 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005794 Specifies the name of the Python 2.x shared library. The default is
5795 DYNAMIC_PYTHON_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005796 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01005797 This option cannot be set from a |modeline| or in the |sandbox|, for
5798 security reasons.
Bram Moolenaar7d47b6e2006-03-15 22:59:18 +00005799
Bram Moolenaar94073162018-01-31 21:49:05 +01005800 *'pythonhome'*
5801'pythonhome' string (default "")
5802 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005803 {only available when compiled with the |+python/dyn|
5804 feature}
5805 Specifies the name of the Python 2.x home directory. When 'pythonhome'
5806 and the PYTHONHOME environment variable are not set, PYTHON_HOME,
5807 which was specified at compile time, will be used for the Python 2.x
5808 home directory.
5809 Environment variables are expanded |:set_env|.
5810 This option cannot be set from a |modeline| or in the |sandbox|, for
5811 security reasons.
5812
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005813 *'pythonthreedll'*
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005814'pythonthreedll' string (default depends on the build)
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005815 global
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005816 {only available when compiled with the |+python3/dyn|
5817 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01005818 Specifies the name of the Python 3 shared library. The default is
5819 DYNAMIC_PYTHON3_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02005820 Environment variables are expanded |:set_env|.
Bram Moolenaarb4ff5182015-11-10 21:15:48 +01005821 This option cannot be set from a |modeline| or in the |sandbox|, for
5822 security reasons.
5823
Bram Moolenaar94073162018-01-31 21:49:05 +01005824 *'pythonthreehome'*
5825'pythonthreehome' string (default "")
5826 global
Bram Moolenaar94073162018-01-31 21:49:05 +01005827 {only available when compiled with the |+python3/dyn|
5828 feature}
5829 Specifies the name of the Python 3 home directory. When
5830 'pythonthreehome' and the PYTHONHOME environment variable are not set,
5831 PYTHON3_HOME, which was specified at compile time, will be used for
5832 the Python 3 home directory.
5833 Environment variables are expanded |:set_env|.
5834 This option cannot be set from a |modeline| or in the |sandbox|, for
5835 security reasons.
5836
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005837 *'pyxversion'* *'pyx'*
5838'pyxversion' 'pyx' number (default depends on the build)
5839 global
Bram Moolenaarf42dd3c2017-01-28 16:06:38 +01005840 {only available when compiled with the |+python| or
5841 the |+python3| feature}
5842 Specifies the python version used for pyx* functions and commands
5843 |python_x|. The default value is as follows:
5844
5845 Compiled with Default ~
5846 |+python| and |+python3| 0
5847 only |+python| 2
5848 only |+python3| 3
5849
5850 Available values are 0, 2 and 3.
5851 If 'pyxversion' is 0, it is set to 2 or 3 after the first execution of
5852 any python2/3 commands or functions. E.g. `:py` sets to 2, and `:py3`
5853 sets to 3. `:pyx` sets it to 3 if Python 3 is available, otherwise sets
5854 to 2 if Python 2 is available.
5855 See also: |has-pythonx|
5856
5857 If Vim is compiled with only |+python| or |+python3| setting
5858 'pyxversion' has no effect. The pyx* functions and commands are
5859 always the same as the compiled version.
5860
5861 This option cannot be set from a |modeline| or in the |sandbox|, for
5862 security reasons.
5863
Bram Moolenaar677ee682005-01-27 14:41:15 +00005864 *'quoteescape'* *'qe'*
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005865'quoteescape' 'qe' string (default "\")
5866 local to buffer
Bram Moolenaarcfbc5ee2004-07-02 15:38:35 +00005867 The characters that are used to escape quotes in a string. Used for
5868 objects like a', a" and a` |a'|.
5869 When one of the characters in this option is found inside a string,
5870 the following character will be skipped. The default value makes the
5871 text "foo\"bar\\" considered to be one string.
5872
Bram Moolenaar071d4272004-06-13 20:20:40 +00005873 *'readonly'* *'ro'* *'noreadonly'* *'noro'*
5874'readonly' 'ro' boolean (default off)
5875 local to buffer
5876 If on, writes fail unless you use a '!'. Protects you from
5877 accidentally overwriting a file. Default on when Vim is started
5878 in read-only mode ("vim -R") or when the executable is called "view".
Bram Moolenaar4399ef42005-02-12 14:29:27 +00005879 When using ":w!" the 'readonly' option is reset for the current
5880 buffer, unless the 'Z' flag is in 'cpoptions'.
Bram Moolenaar6c60f472019-04-28 16:00:35 +02005881 When using the ":view" command the 'readonly' option is set for the
5882 newly edited buffer.
Bram Moolenaar369b6f52017-01-17 12:22:32 +01005883 See 'modifiable' for disallowing changes to the buffer.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005884
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005885 *'redrawtime'* *'rdt'*
5886'redrawtime' 'rdt' number (default 2000)
5887 global
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005888 {only available when compiled with the |+reltime|
5889 feature}
5890 The time in milliseconds for redrawing the display. This applies to
Bram Moolenaar15142e22018-04-30 22:19:58 +02005891 searching for patterns for 'hlsearch', |:match| highlighting and syntax
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005892 highlighting.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005893 When redrawing takes more than this many milliseconds no further
Bram Moolenaar06f1ed22017-06-18 22:41:03 +02005894 matches will be highlighted.
5895 For syntax highlighting the time applies per window. When over the
5896 limit syntax highlighting is disabled until |CTRL-L| is used.
5897 This is used to avoid that Vim hangs when using a very complicated
5898 pattern.
Bram Moolenaar91a4e822008-01-19 14:59:58 +00005899
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02005900 *'regexpengine'* *'re'*
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005901'regexpengine' 're' number (default 0)
5902 global
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005903 This selects the default regexp engine. |two-engines|
5904 The possible values are:
5905 0 automatic selection
5906 1 old engine
5907 2 NFA engine
5908 Note that when using the NFA engine and the pattern contains something
5909 that is not supported the pattern will not match. This is only useful
5910 for debugging the regexp engine.
Bram Moolenaarfda37292014-11-05 14:27:36 +01005911 Using automatic selection enables Vim to switch the engine, if the
5912 default engine becomes too costly. E.g., when the NFA engine uses too
5913 many states. This should prevent Vim from hanging on a combination of
5914 a complex pattern with long text.
Bram Moolenaare6ae6222013-05-21 21:01:10 +02005915
Bram Moolenaar64486672010-05-16 15:46:46 +02005916 *'relativenumber'* *'rnu'* *'norelativenumber'* *'nornu'*
5917'relativenumber' 'rnu' boolean (default off)
5918 local to window
Bram Moolenaar64486672010-05-16 15:46:46 +02005919 Show the line number relative to the line with the cursor in front of
Bram Moolenaar06b5d512010-05-22 15:37:44 +02005920 each line. Relative line numbers help you use the |count| you can
Bram Moolenaar64486672010-05-16 15:46:46 +02005921 precede some vertical motion commands (e.g. j k + -) with, without
5922 having to calculate it yourself. Especially useful in combination with
5923 other commands (e.g. y d c < > gq gw =).
5924 When the 'n' option is excluded from 'cpoptions' a wrapped
5925 line will not use the column of line numbers (this is the default when
5926 'compatible' isn't set).
5927 The 'numberwidth' option can be used to set the room used for the line
5928 number.
5929 When a long, wrapped line doesn't start with the first character, '-'
5930 characters are put before the number.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02005931 See |hl-LineNr| and |hl-CursorLineNr| for the highlighting used for
5932 the number.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01005933
Bram Moolenaar203d04d2013-06-06 21:36:40 +02005934 The number in front of the cursor line also depends on the value of
5935 'number', see |number_relativenumber| for all combinations of the two
5936 options.
Bram Moolenaar64486672010-05-16 15:46:46 +02005937
Bram Moolenaar071d4272004-06-13 20:20:40 +00005938 *'remap'* *'noremap'*
5939'remap' boolean (default on)
5940 global
5941 Allows for mappings to work recursively. If you do not want this for
5942 a single entry, use the :noremap[!] command.
Bram Moolenaara3227e22006-03-08 21:32:40 +00005943 NOTE: To avoid portability problems with Vim scripts, always keep
5944 this option at the default "on". Only switch it off when working with
5945 old Vi scripts.
Bram Moolenaar071d4272004-06-13 20:20:40 +00005946
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005947 *'renderoptions'* *'rop'*
5948'renderoptions' 'rop' string (default: empty)
5949 global
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005950 {only available when compiled with GUI and DIRECTX on
5951 MS-Windows}
5952 Select a text renderer and set its options. The options depend on the
5953 renderer.
5954
5955 Syntax: >
5956 set rop=type:{renderer}(,{name}:{value})*
5957<
5958 Currently, only one optional renderer is available.
5959
5960 render behavior ~
5961 directx Vim will draw text using DirectX (DirectWrite). It makes
5962 drawn glyphs more beautiful than default GDI.
5963 It requires 'encoding' is "utf-8", and only works on
5964 MS-Windows Vista or newer version.
5965
5966 Options:
5967 name meaning type value ~
5968 gamma gamma float 1.0 - 2.2 (maybe)
5969 contrast enhancedContrast float (unknown)
5970 level clearTypeLevel float (unknown)
5971 geom pixelGeometry int 0 - 2 (see below)
5972 renmode renderingMode int 0 - 6 (see below)
5973 taamode textAntialiasMode int 0 - 3 (see below)
Bram Moolenaara338adc2018-01-31 20:51:47 +01005974 scrlines Scroll Lines int (deprecated)
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005975
Bram Moolenaar92467d32017-12-05 13:22:16 +01005976 See this URL for detail (except for scrlines):
5977 https://msdn.microsoft.com/en-us/library/dd368190.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005978
5979 For geom: structure of a device pixel.
5980 0 - DWRITE_PIXEL_GEOMETRY_FLAT
5981 1 - DWRITE_PIXEL_GEOMETRY_RGB
5982 2 - DWRITE_PIXEL_GEOMETRY_BGR
5983
5984 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005985 https://msdn.microsoft.com/en-us/library/dd368114.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005986
5987 For renmode: method of rendering glyphs.
5988 0 - DWRITE_RENDERING_MODE_DEFAULT
5989 1 - DWRITE_RENDERING_MODE_ALIASED
5990 2 - DWRITE_RENDERING_MODE_GDI_CLASSIC
5991 3 - DWRITE_RENDERING_MODE_GDI_NATURAL
5992 4 - DWRITE_RENDERING_MODE_NATURAL
5993 5 - DWRITE_RENDERING_MODE_NATURAL_SYMMETRIC
5994 6 - DWRITE_RENDERING_MODE_OUTLINE
5995
5996 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01005997 https://msdn.microsoft.com/en-us/library/dd368118.aspx
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02005998
5999 For taamode: antialiasing mode used for drawing text.
6000 0 - D2D1_TEXT_ANTIALIAS_MODE_DEFAULT
6001 1 - D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE
6002 2 - D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE
6003 3 - D2D1_TEXT_ANTIALIAS_MODE_ALIASED
6004
6005 See this URL for detail:
Bram Moolenaar92467d32017-12-05 13:22:16 +01006006 https://msdn.microsoft.com/en-us/library/dd368170.aspx
6007
Bram Moolenaara338adc2018-01-31 20:51:47 +01006008 For scrlines:
6009 This was used for optimizing scrolling behavior, however this
6010 is now deprecated. If specified, it is simply ignored.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006011
6012 Example: >
6013 set encoding=utf-8
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006014 set gfn=Ricty_Diminished:h12
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006015 set rop=type:directx
6016<
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006017 If select a raster font (Courier, Terminal or FixedSys which
6018 have ".fon" extension in file name) to 'guifont', it will be
Bram Moolenaar92467d32017-12-05 13:22:16 +01006019 drawn by GDI as a fallback.
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006020
6021 NOTE: It is known that some fonts and options combination
6022 causes trouble on drawing glyphs.
6023
Bram Moolenaar92467d32017-12-05 13:22:16 +01006024 - 'renmode:5' and 'renmode:6' will not work with some
Bram Moolenaard7ccc4d2017-11-26 14:29:32 +01006025 special made fonts (True-Type fonts which includes only
6026 bitmap glyphs).
6027 - 'taamode:3' will not work with some vector fonts.
6028
6029 NOTE: With this option, you can display colored emoji
6030 (emoticon) in Windows 8.1 or later. To display colored emoji,
6031 there are some conditions which you should notice.
6032
6033 - If your font includes non-colored emoji already, it will
6034 be used.
6035 - If your font doesn't have emoji, the system chooses an
6036 alternative symbol font. On Windows 10, "Segoe UI Emoji"
6037 will be used.
6038 - When this alternative font didn't have fixed width glyph,
6039 emoji might be rendered beyond the bounding box of drawing
6040 cell.
Bram Moolenaarb5a7a8b2014-08-06 14:52:30 +02006041
6042 Other render types are currently not supported.
6043
Bram Moolenaar071d4272004-06-13 20:20:40 +00006044 *'report'*
6045'report' number (default 2)
6046 global
6047 Threshold for reporting number of lines changed. When the number of
6048 changed lines is more than 'report' a message will be given for most
6049 ":" commands. If you want it always, set 'report' to 0.
6050 For the ":substitute" command the number of substitutions is used
6051 instead of the number of lines.
6052
6053 *'restorescreen'* *'rs'* *'norestorescreen'* *'nors'*
6054'restorescreen' 'rs' boolean (default on)
6055 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006056 {only in Windows 95/NT console version}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006057 When set, the screen contents is restored when exiting Vim. This also
6058 happens when executing external commands.
6059
6060 For non-Windows Vim: You can set or reset the 't_ti' and 't_te'
6061 options in your .vimrc. To disable restoring:
6062 set t_ti= t_te=
6063 To enable restoring (for an xterm):
6064 set t_ti=^[7^[[r^[[?47h t_te=^[[?47l^[8
6065 (Where ^[ is an <Esc>, type CTRL-V <Esc> to insert it)
6066
6067 *'revins'* *'ri'* *'norevins'* *'nori'*
6068'revins' 'ri' boolean (default off)
6069 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006070 {only available when compiled with the |+rightleft|
6071 feature}
6072 Inserting characters in Insert mode will work backwards. See "typing
6073 backwards" |ins-reverse|. This option can be toggled with the CTRL-_
6074 command in Insert mode, when 'allowrevins' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006075 NOTE: This option is reset when 'compatible' is set.
6076 This option is reset when 'paste' is set and restored when 'paste' is
6077 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006078
6079 *'rightleft'* *'rl'* *'norightleft'* *'norl'*
6080'rightleft' 'rl' boolean (default off)
6081 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006082 {only available when compiled with the |+rightleft|
6083 feature}
6084 When on, display orientation becomes right-to-left, i.e., characters
6085 that are stored in the file appear from the right to the left.
6086 Using this option, it is possible to edit files for languages that
6087 are written from the right to the left such as Hebrew and Arabic.
6088 This option is per window, so it is possible to edit mixed files
6089 simultaneously, or to view the same file in both ways (this is
6090 useful whenever you have a mixed text file with both right-to-left
6091 and left-to-right strings so that both sets are displayed properly
6092 in different windows). Also see |rileft.txt|.
6093
Bram Moolenaar607cc1e2010-07-18 18:47:44 +02006094 *'rightleftcmd'* *'rlc'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00006095'rightleftcmd' 'rlc' string (default "search")
6096 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006097 {only available when compiled with the |+rightleft|
6098 feature}
6099 Each word in this option enables the command line editing to work in
6100 right-to-left mode for a group of commands:
6101
6102 search "/" and "?" commands
6103
6104 This is useful for languages such as Hebrew, Arabic and Farsi.
6105 The 'rightleft' option must be set for 'rightleftcmd' to take effect.
6106
Bram Moolenaard94464e2015-11-02 15:28:18 +01006107 *'rubydll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01006108'rubydll' string (default: depends on the build)
Bram Moolenaard94464e2015-11-02 15:28:18 +01006109 global
Bram Moolenaard94464e2015-11-02 15:28:18 +01006110 {only available when compiled with the |+ruby/dyn|
6111 feature}
Bram Moolenaar25e4fcd2016-01-09 14:57:47 +01006112 Specifies the name of the Ruby shared library. The default is
6113 DYNAMIC_RUBY_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02006114 Environment variables are expanded |:set_env|.
Bram Moolenaard94464e2015-11-02 15:28:18 +01006115 This option cannot be set from a |modeline| or in the |sandbox|, for
6116 security reasons.
6117
Bram Moolenaar071d4272004-06-13 20:20:40 +00006118 *'ruler'* *'ru'* *'noruler'* *'noru'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006119'ruler' 'ru' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006121 {not available when compiled without the
6122 |+cmdline_info| feature}
6123 Show the line and column number of the cursor position, separated by a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006124 comma. When there is room, the relative position of the displayed
Bram Moolenaar071d4272004-06-13 20:20:40 +00006125 text in the file is shown on the far right:
6126 Top first line is visible
6127 Bot last line is visible
6128 All first and last line are visible
6129 45% relative position in the file
6130 If 'rulerformat' is set, it will determine the contents of the ruler.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006131 Each window has its own ruler. If a window has a status line, the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006132 ruler is shown there. Otherwise it is shown in the last line of the
Bram Moolenaar582fd852005-03-28 20:58:01 +00006133 screen. If the statusline is given by 'statusline' (i.e. not empty),
Bram Moolenaar071d4272004-06-13 20:20:40 +00006134 this option takes precedence over 'ruler' and 'rulerformat'
6135 If the number of characters displayed is different from the number of
6136 bytes in the text (e.g., for a TAB or a multi-byte character), both
6137 the text column (byte number) and the screen column are shown,
6138 separated with a dash.
6139 For an empty line "0-1" is shown.
6140 For an empty buffer the line number will also be zero: "0,0-1".
Bram Moolenaarca635012015-09-25 20:34:21 +02006141 This option is reset when 'paste' is set and restored when 'paste' is
6142 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006143 If you don't want to see the ruler all the time but want to know where
6144 you are, use "g CTRL-G" |g_CTRL-G|.
6145 NOTE: This option is reset when 'compatible' is set.
6146
6147 *'rulerformat'* *'ruf'*
6148'rulerformat' 'ruf' string (default empty)
6149 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006150 {not available when compiled without the |+statusline|
6151 feature}
6152 When this option is not empty, it determines the content of the ruler
6153 string, as displayed for the 'ruler' option.
Bram Moolenaara23ccb82006-02-27 00:08:02 +00006154 The format of this option is like that of 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02006155 This option cannot be set in a modeline when 'modelineexpr' is off.
6156
Bram Moolenaar071d4272004-06-13 20:20:40 +00006157 The default ruler width is 17 characters. To make the ruler 15
6158 characters wide, put "%15(" at the start and "%)" at the end.
6159 Example: >
6160 :set rulerformat=%15(%c%V\ %p%%%)
6161<
6162 *'runtimepath'* *'rtp'* *vimfiles*
6163'runtimepath' 'rtp' string (default:
6164 Unix: "$HOME/.vim,
6165 $VIM/vimfiles,
6166 $VIMRUNTIME,
6167 $VIM/vimfiles/after,
6168 $HOME/.vim/after"
6169 Amiga: "home:vimfiles,
6170 $VIM/vimfiles,
6171 $VIMRUNTIME,
6172 $VIM/vimfiles/after,
6173 home:vimfiles/after"
6174 PC, OS/2: "$HOME/vimfiles,
6175 $VIM/vimfiles,
6176 $VIMRUNTIME,
6177 $VIM/vimfiles/after,
6178 $HOME/vimfiles/after"
6179 Macintosh: "$VIM:vimfiles,
6180 $VIMRUNTIME,
6181 $VIM:vimfiles:after"
6182 RISC-OS: "Choices:vimfiles,
6183 $VIMRUNTIME,
6184 Choices:vimfiles/after"
6185 VMS: "sys$login:vimfiles,
6186 $VIM/vimfiles,
6187 $VIMRUNTIME,
6188 $VIM/vimfiles/after,
Bram Moolenaar582fd852005-03-28 20:58:01 +00006189 sys$login:vimfiles/after")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006190 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006191 This is a list of directories which will be searched for runtime
6192 files:
6193 filetype.vim filetypes by file name |new-filetype|
6194 scripts.vim filetypes by file contents |new-filetype-scripts|
Bram Moolenaar4399ef42005-02-12 14:29:27 +00006195 autoload/ automatically loaded scripts |autoload-functions|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006196 colors/ color scheme files |:colorscheme|
6197 compiler/ compiler files |:compiler|
6198 doc/ documentation |write-local-help|
6199 ftplugin/ filetype plugins |write-filetype-plugin|
6200 indent/ indent scripts |indent-expression|
6201 keymap/ key mapping files |mbyte-keymap|
6202 lang/ menu translations |:menutrans|
6203 menu.vim GUI menus |menu.vim|
Bram Moolenaar26852122016-05-24 20:02:38 +02006204 pack/ packages |:packadd|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006205 plugin/ plugin scripts |write-plugin|
6206 print/ files for printing |postscript-print-encoding|
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006207 spell/ spell checking files |spell|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006208 syntax/ syntax files |mysyntaxfile|
6209 tutor/ files for vimtutor |tutor|
6210
6211 And any other file searched for with the |:runtime| command.
6212
6213 The defaults for most systems are setup to search five locations:
6214 1. In your home directory, for your personal preferences.
6215 2. In a system-wide Vim directory, for preferences from the system
6216 administrator.
6217 3. In $VIMRUNTIME, for files distributed with Vim.
6218 *after-directory*
6219 4. In the "after" directory in the system-wide Vim directory. This is
6220 for the system administrator to overrule or add to the distributed
6221 defaults (rarely needed)
6222 5. In the "after" directory in your home directory. This is for
6223 personal preferences to overrule or add to the distributed defaults
6224 or system-wide settings (rarely needed).
6225
Bram Moolenaard0796902016-09-16 20:02:31 +02006226 More entries are added when using |packages|. If it gets very long
6227 then `:set rtp` will be truncated, use `:echo &rtp` to see the full
6228 string.
Bram Moolenaar26852122016-05-24 20:02:38 +02006229
Bram Moolenaar071d4272004-06-13 20:20:40 +00006230 Note that, unlike 'path', no wildcards like "**" are allowed. Normal
6231 wildcards are allowed, but can significantly slow down searching for
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006232 runtime files. For speed, use as few items as possible and avoid
Bram Moolenaar071d4272004-06-13 20:20:40 +00006233 wildcards.
6234 See |:runtime|.
6235 Example: >
6236 :set runtimepath=~/vimruntime,/mygroup/vim,$VIMRUNTIME
6237< This will use the directory "~/vimruntime" first (containing your
6238 personal Vim runtime files), then "/mygroup/vim" (shared between a
6239 group of people) and finally "$VIMRUNTIME" (the distributed runtime
6240 files).
6241 You probably should always include $VIMRUNTIME somewhere, to use the
6242 distributed runtime files. You can put a directory before $VIMRUNTIME
6243 to find files which replace a distributed runtime files. You can put
6244 a directory after $VIMRUNTIME to find files which add to distributed
6245 runtime files.
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006246 When Vim is started with |--clean| the home directory entries are not
6247 included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006248 This option cannot be set from a |modeline| or in the |sandbox|, for
6249 security reasons.
6250
6251 *'scroll'* *'scr'*
6252'scroll' 'scr' number (default: half the window height)
6253 local to window
6254 Number of lines to scroll with CTRL-U and CTRL-D commands. Will be
6255 set to half the number of lines in the window when the window size
6256 changes. If you give a count to the CTRL-U or CTRL-D command it will
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006257 be used as the new value for 'scroll'. Reset to half the window
Bram Moolenaar25c9c682019-05-05 18:13:34 +02006258 height with ":set scroll=0".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006259
6260 *'scrollbind'* *'scb'* *'noscrollbind'* *'noscb'*
6261'scrollbind' 'scb' boolean (default off)
6262 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00006263 See also |scroll-binding|. When this option is set, the current
6264 window scrolls as other scrollbind windows (windows that also have
6265 this option set) scroll. This option is useful for viewing the
6266 differences between two versions of a file, see 'diff'.
6267 See |'scrollopt'| for options that determine how this option should be
6268 interpreted.
6269 This option is mostly reset when splitting a window to edit another
6270 file. This means that ":split | edit file" results in two windows
6271 with scroll-binding, but ":split file" does not.
6272
6273 *'scrolljump'* *'sj'*
6274'scrolljump' 'sj' number (default 1)
6275 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006276 Minimal number of lines to scroll when the cursor gets off the
6277 screen (e.g., with "j"). Not used for scroll commands (e.g., CTRL-E,
6278 CTRL-D). Useful if your terminal scrolls very slowly.
Bram Moolenaar1e015462005-09-25 22:16:38 +00006279 When set to a negative number from -1 to -100 this is used as the
6280 percentage of the window height. Thus -50 scrolls half the window
6281 height.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006282 NOTE: This option is set to 1 when 'compatible' is set.
6283
6284 *'scrolloff'* *'so'*
Bram Moolenaar50ba5262016-09-22 22:33:02 +02006285'scrolloff' 'so' number (default 0, set to 5 in |defaults.vim|)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006286 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006287 Minimal number of screen lines to keep above and below the cursor.
6288 This will make some context visible around where you are working. If
6289 you set it to a very large value (999) the cursor line will always be
6290 in the middle of the window (except at the start or end of the file or
6291 when long lines wrap).
Bram Moolenaar375e3392019-01-31 18:26:10 +01006292 After using the local value, go back the global value with one of
6293 these two: >
6294 setlocal scrolloff<
6295 setlocal scrolloff=-1
6296< For scrolling horizontally see 'sidescrolloff'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006297 NOTE: This option is set to 0 when 'compatible' is set.
6298
6299 *'scrollopt'* *'sbo'*
6300'scrollopt' 'sbo' string (default "ver,jump")
6301 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006302 This is a comma-separated list of words that specifies how
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006303 'scrollbind' windows should behave. 'sbo' stands for ScrollBind
6304 Options.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006305 The following words are available:
6306 ver Bind vertical scrolling for 'scrollbind' windows
6307 hor Bind horizontal scrolling for 'scrollbind' windows
6308 jump Applies to the offset between two windows for vertical
6309 scrolling. This offset is the difference in the first
6310 displayed line of the bound windows. When moving
6311 around in a window, another 'scrollbind' window may
6312 reach a position before the start or after the end of
6313 the buffer. The offset is not changed though, when
6314 moving back the 'scrollbind' window will try to scroll
6315 to the desired position when possible.
6316 When now making that window the current one, two
6317 things can be done with the relative offset:
6318 1. When "jump" is not included, the relative offset is
6319 adjusted for the scroll position in the new current
6320 window. When going back to the other window, the
Bram Moolenaar02467872007-05-06 13:22:01 +00006321 new relative offset will be used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006322 2. When "jump" is included, the other windows are
6323 scrolled to keep the same relative offset. When
6324 going back to the other window, it still uses the
6325 same relative offset.
6326 Also see |scroll-binding|.
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006327 When 'diff' mode is active there always is vertical scroll binding,
6328 even when "ver" isn't there.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006329
6330 *'sections'* *'sect'*
6331'sections' 'sect' string (default "SHNHH HUnhsh")
6332 global
6333 Specifies the nroff macros that separate sections. These are pairs of
6334 two letters (See |object-motions|). The default makes a section start
6335 at the nroff macros ".SH", ".NH", ".H", ".HU", ".nh" and ".sh".
6336
6337 *'secure'* *'nosecure'* *E523*
6338'secure' boolean (default off)
6339 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006340 When on, ":autocmd", shell and write commands are not allowed in
6341 ".vimrc" and ".exrc" in the current directory and map commands are
6342 displayed. Switch it off only if you know that you will not run into
6343 problems, or when the 'exrc' option is off. On Unix this option is
6344 only used if the ".vimrc" or ".exrc" is not owned by you. This can be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006345 dangerous if the systems allows users to do a "chown". You better set
Bram Moolenaar071d4272004-06-13 20:20:40 +00006346 'secure' at the end of your ~/.vimrc then.
6347 This option cannot be set from a |modeline| or in the |sandbox|, for
6348 security reasons.
6349
6350 *'selection'* *'sel'*
6351'selection' 'sel' string (default "inclusive")
6352 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006353 This option defines the behavior of the selection. It is only used
6354 in Visual and Select mode.
6355 Possible values:
6356 value past line inclusive ~
6357 old no yes
6358 inclusive yes yes
6359 exclusive yes no
6360 "past line" means that the cursor is allowed to be positioned one
6361 character past the line.
6362 "inclusive" means that the last character of the selection is included
6363 in an operation. For example, when "x" is used to delete the
6364 selection.
Bram Moolenaare4a3bcf2016-08-26 19:52:37 +02006365 When "old" is used and 'virtualedit' allows the cursor to move past
6366 the end of line the line break still isn't included.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006367 Note that when "exclusive" is used and selecting from the end
6368 backwards, you cannot include the last character of a line, when
6369 starting in Normal mode and 'virtualedit' empty.
6370
6371 The 'selection' option is set by the |:behave| command.
6372
6373 *'selectmode'* *'slm'*
6374'selectmode' 'slm' string (default "")
6375 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006376 This is a comma separated list of words, which specifies when to start
6377 Select mode instead of Visual mode, when a selection is started.
6378 Possible values:
6379 mouse when using the mouse
6380 key when using shifted special keys
6381 cmd when using "v", "V" or CTRL-V
6382 See |Select-mode|.
6383 The 'selectmode' option is set by the |:behave| command.
6384
6385 *'sessionoptions'* *'ssop'*
6386'sessionoptions' 'ssop' string (default: "blank,buffers,curdir,folds,
Bram Moolenaarb5b75622018-03-09 22:22:21 +01006387 help,options,tabpages,winsize,terminal")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006388 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006389 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006390 feature}
6391 Changes the effect of the |:mksession| command. It is a comma
6392 separated list of words. Each word enables saving and restoring
6393 something:
6394 word save and restore ~
6395 blank empty windows
6396 buffers hidden and unloaded buffers, not just those in windows
6397 curdir the current directory
6398 folds manually created folds, opened/closed folds and local
6399 fold options
6400 globals global variables that start with an uppercase letter
Bram Moolenaar12805862005-01-05 22:16:17 +00006401 and contain at least one lowercase letter. Only
6402 String and Number types are stored.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006403 help the help window
6404 localoptions options and mappings local to a window or buffer (not
6405 global values for local options)
6406 options all options and mappings (also global values for local
6407 options)
6408 resize size of the Vim window: 'lines' and 'columns'
6409 sesdir the directory in which the session file is located
6410 will become the current directory (useful with
6411 projects accessed over a network from different
6412 systems)
6413 slash backslashes in file names replaced with forward
6414 slashes
Bram Moolenaar18144c82006-04-12 21:52:12 +00006415 tabpages all tab pages; without this only the current tab page
6416 is restored, so that you can make a session for each
6417 tab page separately
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006418 terminal include terminal windows where the command can be
6419 restored
Bram Moolenaar071d4272004-06-13 20:20:40 +00006420 unix with Unix end-of-line format (single <NL>), even when
6421 on Windows or DOS
6422 winpos position of the whole Vim window
6423 winsize window sizes
6424
6425 Don't include both "curdir" and "sesdir".
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006426 When neither "curdir" nor "sesdir" is included, file names are stored
6427 with absolute paths.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006428 "slash" and "unix" are useful on Windows when sharing session files
6429 with Unix. The Unix version of Vim cannot source dos format scripts,
6430 but the Windows version of Vim can source unix format scripts.
6431
6432 *'shell'* *'sh'* *E91*
6433'shell' 'sh' string (default $SHELL or "sh",
6434 MS-DOS and Win32: "command.com" or
6435 "cmd.exe", OS/2: "cmd")
6436 global
6437 Name of the shell to use for ! and :! commands. When changing the
6438 value also check these options: 'shelltype', 'shellpipe', 'shellslash'
6439 'shellredir', 'shellquote', 'shellxquote' and 'shellcmdflag'.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006440 It is allowed to give an argument to the command, e.g. "csh -f".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006441 See |option-backslash| about including spaces and backslashes.
6442 Environment variables are expanded |:set_env|.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006443
Bram Moolenaar071d4272004-06-13 20:20:40 +00006444 If the name of the shell contains a space, you might need to enclose
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006445 it in quotes or escape the space. Example with quotes: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006446 :set shell=\"c:\program\ files\unix\sh.exe\"\ -f
6447< Note the backslash before each quote (to avoid starting a comment) and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006448 each space (to avoid ending the option value). Also note that the
Bram Moolenaar071d4272004-06-13 20:20:40 +00006449 "-f" is not inside the quotes, because it is not part of the command
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006450 name. Vim automagically recognizes the backslashes that are path
Bram Moolenaar071d4272004-06-13 20:20:40 +00006451 separators.
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006452 Example with escaped space (Vim will do this when initializing the
6453 option from $SHELL): >
6454 :set shell=/bin/with\\\ space/sh
Bram Moolenaard473c8c2018-08-11 18:00:22 +02006455< The resulting value of 'shell' is "/bin/with\ space/sh", two
Bram Moolenaar4bfa8af2018-02-03 15:14:46 +01006456 backslashes are consumed by `:set`.
6457
Bram Moolenaar071d4272004-06-13 20:20:40 +00006458 Under MS-Windows, when the executable ends in ".com" it must be
6459 included. Thus setting the shell to "command.com" or "4dos.com"
6460 works, but "command" and "4dos" do not work for all commands (e.g.,
6461 filtering).
6462 For unknown reasons, when using "4dos.com" the current directory is
6463 changed to "C:\". To avoid this set 'shell' like this: >
6464 :set shell=command.com\ /c\ 4dos
6465< This option cannot be set from a |modeline| or in the |sandbox|, for
6466 security reasons.
6467
6468 *'shellcmdflag'* *'shcf'*
Bram Moolenaar5dc62522012-02-13 00:05:22 +01006469'shellcmdflag' 'shcf' string (default: "-c";
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006470 MS-DOS and Win32, when 'shell' does not
6471 contain "sh" somewhere: "/c")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006472 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006473 Flag passed to the shell to execute "!" and ":!" commands; e.g.,
6474 "bash.exe -c ls" or "command.com /c dir". For the MS-DOS-like
6475 systems, the default is set according to the value of 'shell', to
Bram Moolenaare0720cb2017-03-29 13:48:40 +02006476 reduce the need to set this option by the user.
Bram Moolenaar5302d9e2011-09-14 17:55:08 +02006477 On Unix it can have more than one flag. Each white space separated
6478 part is passed as an argument to the shell command.
6479 See |option-backslash| about including spaces and backslashes.
6480 Also see |dos-shell| for MS-DOS and MS-Windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006481 This option cannot be set from a |modeline| or in the |sandbox|, for
6482 security reasons.
6483
6484 *'shellpipe'* *'sp'*
6485'shellpipe' 'sp' string (default ">", "| tee", "|& tee" or "2>&1| tee")
6486 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006487 {not available when compiled without the |+quickfix|
6488 feature}
6489 String to be used to put the output of the ":make" command in the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006490 error file. See also |:make_makeprg|. See |option-backslash| about
Bram Moolenaar071d4272004-06-13 20:20:40 +00006491 including spaces and backslashes.
6492 The name of the temporary file can be represented by "%s" if necessary
6493 (the file name is appended automatically if no %s appears in the value
6494 of this option).
6495 For the Amiga and MS-DOS the default is ">". The output is directly
6496 saved in a file and not echoed to the screen.
6497 For Unix the default it "| tee". The stdout of the compiler is saved
6498 in a file and echoed to the screen. If the 'shell' option is "csh" or
6499 "tcsh" after initializations, the default becomes "|& tee". If the
Bram Moolenaar8e5af3e2011-04-28 19:02:44 +02006500 'shell' option is "sh", "ksh", "mksh", "pdksh", "zsh" or "bash" the
6501 default becomes "2>&1| tee". This means that stderr is also included.
6502 Before using the 'shell' option a path is removed, thus "/bin/sh" uses
6503 "sh".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006504 The initialization of this option is done after reading the ".vimrc"
6505 and the other initializations, so that when the 'shell' option is set
6506 there, the 'shellpipe' option changes automatically, unless it was
6507 explicitly set before.
6508 When 'shellpipe' is set to an empty string, no redirection of the
6509 ":make" output will be done. This is useful if you use a 'makeprg'
6510 that writes to 'makeef' by itself. If you want no piping, but do
6511 want to include the 'makeef', set 'shellpipe' to a single space.
6512 Don't forget to precede the space with a backslash: ":set sp=\ ".
6513 In the future pipes may be used for filtering and this option will
6514 become obsolete (at least for Unix).
6515 This option cannot be set from a |modeline| or in the |sandbox|, for
6516 security reasons.
6517
6518 *'shellquote'* *'shq'*
6519'shellquote' 'shq' string (default: ""; MS-DOS and Win32, when 'shell'
6520 contains "sh" somewhere: "\"")
6521 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006522 Quoting character(s), put around the command passed to the shell, for
6523 the "!" and ":!" commands. The redirection is kept outside of the
6524 quoting. See 'shellxquote' to include the redirection. It's
6525 probably not useful to set both options.
6526 This is an empty string by default. Only known to be useful for
6527 third-party shells on MS-DOS-like systems, such as the MKS Korn Shell
6528 or bash, where it should be "\"". The default is adjusted according
6529 the value of 'shell', to reduce the need to set this option by the
6530 user. See |dos-shell|.
6531 This option cannot be set from a |modeline| or in the |sandbox|, for
6532 security reasons.
6533
6534 *'shellredir'* *'srr'*
6535'shellredir' 'srr' string (default ">", ">&" or ">%s 2>&1")
6536 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006537 String to be used to put the output of a filter command in a temporary
6538 file. See also |:!|. See |option-backslash| about including spaces
6539 and backslashes.
6540 The name of the temporary file can be represented by "%s" if necessary
6541 (the file name is appended automatically if no %s appears in the value
6542 of this option).
6543 The default is ">". For Unix, if the 'shell' option is "csh", "tcsh"
6544 or "zsh" during initializations, the default becomes ">&". If the
6545 'shell' option is "sh", "ksh" or "bash" the default becomes
6546 ">%s 2>&1". This means that stderr is also included.
6547 For Win32, the Unix checks are done and additionally "cmd" is checked
6548 for, which makes the default ">%s 2>&1". Also, the same names with
6549 ".exe" appended are checked for.
6550 The initialization of this option is done after reading the ".vimrc"
6551 and the other initializations, so that when the 'shell' option is set
6552 there, the 'shellredir' option changes automatically unless it was
6553 explicitly set before.
6554 In the future pipes may be used for filtering and this option will
6555 become obsolete (at least for Unix).
6556 This option cannot be set from a |modeline| or in the |sandbox|, for
6557 security reasons.
6558
6559 *'shellslash'* *'ssl'* *'noshellslash'* *'nossl'*
6560'shellslash' 'ssl' boolean (default off)
6561 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006562 {only for MSDOS, MS-Windows and OS/2}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006563 When set, a forward slash is used when expanding file names. This is
6564 useful when a Unix-like shell is used instead of command.com or
6565 cmd.exe. Backward slashes can still be typed, but they are changed to
6566 forward slashes by Vim.
6567 Note that setting or resetting this option has no effect for some
6568 existing file names, thus this option needs to be set before opening
6569 any file for best results. This might change in the future.
6570 'shellslash' only works when a backslash can be used as a path
6571 separator. To test if this is so use: >
6572 if exists('+shellslash')
Bram Moolenaarac3150d2019-07-28 16:36:39 +02006573< Also see 'completeslash'.
6574
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006575 *'shelltemp'* *'stmp'* *'noshelltemp'* *'nostmp'*
6576'shelltemp' 'stmp' boolean (Vi default off, Vim default on)
6577 global
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006578 When on, use temp files for shell commands. When off use a pipe.
6579 When using a pipe is not possible temp files are used anyway.
Bram Moolenaar97293012011-07-18 19:40:27 +02006580 Currently a pipe is only supported on Unix and MS-Windows 2K and
6581 later. You can check it with: >
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006582 :if has("filterpipe")
6583< The advantage of using a pipe is that nobody can read the temp file
6584 and the 'shell' command does not need to support redirection.
6585 The advantage of using a temp file is that the file type and encoding
6586 can be detected.
6587 The |FilterReadPre|, |FilterReadPost| and |FilterWritePre|,
6588 |FilterWritePost| autocommands event are not triggered when
6589 'shelltemp' is off.
Bram Moolenaar269f5952016-07-15 22:54:41 +02006590 The `system()` function does not respect this option and always uses
6591 temp files.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006592 NOTE: This option is set to the Vim default value when 'compatible'
6593 is reset.
Bram Moolenaar26a60b42005-02-22 08:49:11 +00006594
Bram Moolenaar071d4272004-06-13 20:20:40 +00006595 *'shelltype'* *'st'*
6596'shelltype' 'st' number (default 0)
6597 global
Bram Moolenaar6c60f472019-04-28 16:00:35 +02006598 {only for the Amiga}
Bram Moolenaar071d4272004-06-13 20:20:40 +00006599 On the Amiga this option influences the way how the commands work
6600 which use a shell.
6601 0 and 1: always use the shell
6602 2 and 3: use the shell only to filter lines
6603 4 and 5: use shell only for ':sh' command
6604 When not using the shell, the command is executed directly.
6605
6606 0 and 2: use "shell 'shellcmdflag' cmd" to start external commands
6607 1 and 3: use "shell cmd" to start external commands
6608
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006609 *'shellxescape'* *'sxe'*
6610'shellxescape' 'sxe' string (default: "";
6611 for MS-DOS and MS-Windows: "\"&|<>()@^")
6612 global
Bram Moolenaardb7207e2012-02-22 17:30:19 +01006613 When 'shellxquote' is set to "(" then the characters listed in this
6614 option will be escaped with a '^' character. This makes it possible
6615 to execute most external commands with cmd.exe.
6616
Bram Moolenaar071d4272004-06-13 20:20:40 +00006617 *'shellxquote'* *'sxq'*
6618'shellxquote' 'sxq' string (default: "";
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006619 for Win32, when 'shell' is cmd.exe: "("
6620 for Win32, when 'shell' contains "sh"
6621 somewhere: "\""
Bram Moolenaar071d4272004-06-13 20:20:40 +00006622 for Unix, when using system(): "\"")
6623 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006624 Quoting character(s), put around the command passed to the shell, for
6625 the "!" and ":!" commands. Includes the redirection. See
6626 'shellquote' to exclude the redirection. It's probably not useful
6627 to set both options.
Bram Moolenaarf66b3fc2012-02-20 22:18:30 +01006628 When the value is '(' then ')' is appended. When the value is '"('
6629 then ')"' is appended.
6630 When the value is '(' then also see 'shellxescape'.
Bram Moolenaara64ba222012-02-12 23:23:31 +01006631 This is an empty string by default on most systems, but is known to be
6632 useful for on Win32 version, either for cmd.exe which automatically
6633 strips off the first and last quote on a command, or 3rd-party shells
6634 such as the MKS Korn Shell or bash, where it should be "\"". The
6635 default is adjusted according the value of 'shell', to reduce the need
6636 to set this option by the user. See |dos-shell|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006637 This option cannot be set from a |modeline| or in the |sandbox|, for
6638 security reasons.
6639
6640 *'shiftround'* *'sr'* *'noshiftround'* *'nosr'*
6641'shiftround' 'sr' boolean (default off)
6642 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006643 Round indent to multiple of 'shiftwidth'. Applies to > and <
6644 commands. CTRL-T and CTRL-D in Insert mode always round the indent to
6645 a multiple of 'shiftwidth' (this is Vi compatible).
6646 NOTE: This option is reset when 'compatible' is set.
6647
6648 *'shiftwidth'* *'sw'*
6649'shiftwidth' 'sw' number (default 8)
6650 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006651 Number of spaces to use for each step of (auto)indent. Used for
Bram Moolenaar071d4272004-06-13 20:20:40 +00006652 |'cindent'|, |>>|, |<<|, etc.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006653 When zero the 'ts' value will be used. Use the |shiftwidth()|
6654 function to get the effective shiftwidth value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006655
6656 *'shortmess'* *'shm'*
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006657'shortmess' 'shm' string (Vim default "filnxtToOS", Vi default: "S",
6658 POSIX default: "AS")
Bram Moolenaar071d4272004-06-13 20:20:40 +00006659 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006660 This option helps to avoid all the |hit-enter| prompts caused by file
6661 messages, for example with CTRL-G, and to avoid some other messages.
6662 It is a list of flags:
6663 flag meaning when present ~
6664 f use "(3 of 5)" instead of "(file 3 of 5)"
6665 i use "[noeol]" instead of "[Incomplete last line]"
6666 l use "999L, 888C" instead of "999 lines, 888 characters"
6667 m use "[+]" instead of "[Modified]"
6668 n use "[New]" instead of "[New File]"
6669 r use "[RO]" instead of "[readonly]"
6670 w use "[w]" instead of "written" for file write message
6671 and "[a]" instead of "appended" for ':w >> file' command
6672 x use "[dos]" instead of "[dos format]", "[unix]" instead of
6673 "[unix format]" and "[mac]" instead of "[mac format]".
6674 a all of the above abbreviations
6675
6676 o overwrite message for writing a file with subsequent message
6677 for reading a file (useful for ":wn" or when 'autowrite' on)
6678 O message for reading a file overwrites any previous message.
6679 Also for quickfix message (e.g., ":cn").
6680 s don't give "search hit BOTTOM, continuing at TOP" or "search
Bram Moolenaara6c27c42019-05-09 19:16:22 +02006681 hit TOP, continuing at BOTTOM" messages; when using the search
6682 count do not show "W" after the count message (see S below)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006683 t truncate file message at the start if it is too long to fit
6684 on the command-line, "<" will appear in the left most column.
6685 Ignored in Ex mode.
6686 T truncate other messages in the middle if they are too long to
Bram Moolenaar582fd852005-03-28 20:58:01 +00006687 fit on the command line. "..." will appear in the middle.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006688 Ignored in Ex mode.
6689 W don't give "written" or "[w]" when writing a file
6690 A don't give the "ATTENTION" message when an existing swap file
6691 is found.
6692 I don't give the intro message when starting Vim |:intro|.
Bram Moolenaarea389e92014-05-28 21:40:52 +02006693 c don't give |ins-completion-menu| messages. For example,
6694 "-- XXX completion (YYY)", "match 1 of 2", "The only match",
6695 "Pattern not found", "Back at original", etc.
Bram Moolenaar426dd022016-03-15 15:09:29 +01006696 q use "recording" instead of "recording @a"
6697 F don't give the file info when editing a file, like `:silent`
Bram Moolenaar110289e2019-05-23 15:38:06 +02006698 was used for the command; note that this also affects messages
6699 from autocommands
Bram Moolenaar9dfa3132019-05-04 21:08:40 +02006700 S do not show search count message when searching, e.g.
6701 "[1/5]"
Bram Moolenaar071d4272004-06-13 20:20:40 +00006702
6703 This gives you the opportunity to avoid that a change between buffers
6704 requires you to hit <Enter>, but still gives as useful a message as
6705 possible for the space available. To get the whole message that you
6706 would have got with 'shm' empty, use ":file!"
6707 Useful values:
6708 shm= No abbreviation of message.
6709 shm=a Abbreviation, but no loss of information.
6710 shm=at Abbreviation, and truncate message when necessary.
6711
6712 NOTE: This option is set to the Vi default value when 'compatible' is
6713 set and to the Vim default value when 'compatible' is reset.
6714
6715 *'shortname'* *'sn'* *'noshortname'* *'nosn'*
6716'shortname' 'sn' boolean (default off)
6717 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006718 Filenames are assumed to be 8 characters plus one extension of 3
6719 characters. Multiple dots in file names are not allowed. When this
6720 option is on, dots in file names are replaced with underscores when
6721 adding an extension (".~" or ".swp"). This option is not available
6722 for MS-DOS, because then it would always be on. This option is useful
6723 when editing files on an MS-DOS compatible filesystem, e.g., messydos
6724 or crossdos. When running the Win32 GUI version under Win32s, this
6725 option is always on by default.
6726
6727 *'showbreak'* *'sbr'* *E595*
6728'showbreak' 'sbr' string (default "")
6729 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02006730 {not available when compiled without the |+linebreak|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006731 feature}
6732 String to put at the start of lines that have been wrapped. Useful
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006733 values are "> " or "+++ ": >
6734 :set showbreak=>\
6735< Note the backslash to escape the trailing space. It's easier like
6736 this: >
Bram Moolenaar1a384422010-07-14 19:53:30 +02006737 :let &showbreak = '+++ '
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006738< Only printable single-cell characters are allowed, excluding <Tab> and
Bram Moolenaar071d4272004-06-13 20:20:40 +00006739 comma (in a future version the comma might be used to separate the
6740 part that is shown at the end and at the start of a line).
6741 The characters are highlighted according to the '@' flag in
6742 'highlight'.
6743 Note that tabs after the showbreak will be displayed differently.
6744 If you want the 'showbreak' to appear in between line numbers, add the
6745 "n" flag to 'cpoptions'.
6746
6747 *'showcmd'* *'sc'* *'noshowcmd'* *'nosc'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02006748'showcmd' 'sc' boolean (Vim default: on, off for Unix,
6749 Vi default: off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00006750 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006751 {not available when compiled without the
6752 |+cmdline_info| feature}
Bram Moolenaar02467872007-05-06 13:22:01 +00006753 Show (partial) command in the last line of the screen. Set this
6754 option off if your terminal is slow.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006755 In Visual mode the size of the selected area is shown:
6756 - When selecting characters within a line, the number of characters.
Bram Moolenaarf91787c2010-07-17 12:47:16 +02006757 If the number of bytes is different it is also displayed: "2-6"
6758 means two characters and six bytes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006759 - When selecting more than one line, the number of lines.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01006760 - When selecting a block, the size in screen characters:
6761 {lines}x{columns}.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006762 NOTE: This option is set to the Vi default value when 'compatible' is
6763 set and to the Vim default value when 'compatible' is reset.
6764
6765 *'showfulltag'* *'sft'* *'noshowfulltag'* *'nosft'*
6766'showfulltag' 'sft' boolean (default off)
6767 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006768 When completing a word in insert mode (see |ins-completion|) from the
6769 tags file, show both the tag name and a tidied-up form of the search
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006770 pattern (if there is one) as possible matches. Thus, if you have
Bram Moolenaar071d4272004-06-13 20:20:40 +00006771 matched a C function, you can see a template for what arguments are
6772 required (coding style permitting).
Bram Moolenaar446cb832008-06-24 21:56:24 +00006773 Note that this doesn't work well together with having "longest" in
6774 'completeopt', because the completion from the search pattern may not
6775 match the typed text.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006776
6777 *'showmatch'* *'sm'* *'noshowmatch'* *'nosm'*
6778'showmatch' 'sm' boolean (default off)
6779 global
6780 When a bracket is inserted, briefly jump to the matching one. The
6781 jump is only done if the match can be seen on the screen. The time to
6782 show the match can be set with 'matchtime'.
6783 A Beep is given if there is no match (no matter if the match can be
Bram Moolenaarca635012015-09-25 20:34:21 +02006784 seen or not).
6785 This option is reset when 'paste' is set and restored when 'paste' is
6786 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006787 When the 'm' flag is not included in 'cpoptions', typing a character
6788 will immediately move the cursor back to where it belongs.
6789 See the "sm" field in 'guicursor' for setting the cursor shape and
6790 blinking when showing the match.
6791 The 'matchpairs' option can be used to specify the characters to show
6792 matches for. 'rightleft' and 'revins' are used to look for opposite
6793 matches.
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00006794 Also see the matchparen plugin for highlighting the match when moving
6795 around |pi_paren.txt|.
6796 Note: Use of the short form is rated PG.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006797
6798 *'showmode'* *'smd'* *'noshowmode'* *'nosmd'*
6799'showmode' 'smd' boolean (Vim default: on, Vi default: off)
6800 global
6801 If in Insert, Replace or Visual mode put a message on the last line.
6802 Use the 'M' flag in 'highlight' to set the type of highlighting for
6803 this message.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006804 When |XIM| may be used the message will include "XIM". But this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006805 doesn't mean XIM is really active, especially when 'imactivatekey' is
6806 not set.
6807 NOTE: This option is set to the Vi default value when 'compatible' is
6808 set and to the Vim default value when 'compatible' is reset.
6809
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006810 *'showtabline'* *'stal'*
6811'showtabline' 'stal' number (default 1)
6812 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00006813 The value of this option specifies when the line with tab page labels
6814 will be displayed:
6815 0: never
6816 1: only if there are at least two tab pages
6817 2: always
6818 This is both for the GUI and non-GUI implementation of the tab pages
6819 line.
6820 See |tab-page| for more information about tab pages.
6821
Bram Moolenaar071d4272004-06-13 20:20:40 +00006822 *'sidescroll'* *'ss'*
6823'sidescroll' 'ss' number (default 0)
6824 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006825 The minimal number of columns to scroll horizontally. Used only when
6826 the 'wrap' option is off and the cursor is moved off of the screen.
6827 When it is zero the cursor will be put in the middle of the screen.
6828 When using a slow terminal set it to a large number or 0. When using
6829 a fast terminal use a small number or 1. Not used for "zh" and "zl"
6830 commands.
6831
6832 *'sidescrolloff'* *'siso'*
6833'sidescrolloff' 'siso' number (default 0)
Bram Moolenaar375e3392019-01-31 18:26:10 +01006834 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00006835 The minimal number of screen columns to keep to the left and to the
Bram Moolenaar482aaeb2005-09-29 18:26:07 +00006836 right of the cursor if 'nowrap' is set. Setting this option to a
6837 value greater than 0 while having |'sidescroll'| also at a non-zero
6838 value makes some context visible in the line you are scrolling in
6839 horizontally (except at beginning of the line). Setting this option
6840 to a large value (like 999) has the effect of keeping the cursor
6841 horizontally centered in the window, as long as one does not come too
6842 close to the beginning of the line.
Bram Moolenaar375e3392019-01-31 18:26:10 +01006843 After using the local value, go back the global value with one of
6844 these two: >
6845 setlocal sidescrolloff<
6846 setlocal sidescrolloff=-1
6847< NOTE: This option is set to 0 when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006848
6849 Example: Try this together with 'sidescroll' and 'listchars' as
6850 in the following example to never allow the cursor to move
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006851 onto the "extends" character: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00006852
6853 :set nowrap sidescroll=1 listchars=extends:>,precedes:<
6854 :set sidescrolloff=1
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006855<
6856 *'signcolumn'* *'scl'*
6857'signcolumn' 'scl' string (default "auto")
6858 local to window
Bram Moolenaar95ec9d62016-08-12 18:29:59 +02006859 {not available when compiled without the |+signs|
6860 feature}
Bram Moolenaar09521312016-08-12 22:54:35 +02006861 Whether or not to draw the signcolumn. Valid values are:
6862 "auto" only when there is a sign to display
6863 "no" never
6864 "yes" always
Bram Moolenaar394c5d82019-06-17 21:48:05 +02006865 "number" display signs in the 'number' column. If the number
Bram Moolenaar6c1e1572019-06-22 02:13:00 +02006866 column is not present, then behaves like "auto".
Bram Moolenaar071d4272004-06-13 20:20:40 +00006867
6868
6869 *'smartcase'* *'scs'* *'nosmartcase'* *'noscs'*
6870'smartcase' 'scs' boolean (default off)
6871 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006872 Override the 'ignorecase' option if the search pattern contains upper
6873 case characters. Only used when the search pattern is typed and
6874 'ignorecase' option is on. Used for the commands "/", "?", "n", "N",
Bram Moolenaarc8734422012-06-01 22:38:45 +02006875 ":g" and ":s". Not used for "*", "#", "gd", tag search, etc. After
Bram Moolenaar071d4272004-06-13 20:20:40 +00006876 "*" and "#" you can make 'smartcase' used by doing a "/" command,
6877 recalling the search pattern from history and hitting <Enter>.
6878 NOTE: This option is reset when 'compatible' is set.
6879
6880 *'smartindent'* *'si'* *'nosmartindent'* *'nosi'*
6881'smartindent' 'si' boolean (default off)
6882 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006883 {not available when compiled without the
6884 |+smartindent| feature}
6885 Do smart autoindenting when starting a new line. Works for C-like
6886 programs, but can also be used for other languages. 'cindent' does
6887 something like this, works better in most cases, but is more strict,
Bram Moolenaar81af9252010-12-10 20:35:50 +01006888 see |C-indenting|. When 'cindent' is on or 'indentexpr' is set,
Bram Moolenaar166af9b2010-11-16 20:34:40 +01006889 setting 'si' has no effect. 'indentexpr' is a more advanced
6890 alternative.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006891 Normally 'autoindent' should also be on when using 'smartindent'.
6892 An indent is automatically inserted:
6893 - After a line ending in '{'.
6894 - After a line starting with a keyword from 'cinwords'.
6895 - Before a line starting with '}' (only with the "O" command).
6896 When typing '}' as the first character in a new line, that line is
6897 given the same indent as the matching '{'.
6898 When typing '#' as the first character in a new line, the indent for
6899 that line is removed, the '#' is put in the first column. The indent
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00006900 is restored for the next line. If you don't want this, use this
Bram Moolenaar071d4272004-06-13 20:20:40 +00006901 mapping: ":inoremap # X^H#", where ^H is entered with CTRL-V CTRL-H.
6902 When using the ">>" command, lines starting with '#' are not shifted
6903 right.
Bram Moolenaar036986f2017-03-16 17:41:02 +01006904 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaarca635012015-09-25 20:34:21 +02006905 This option is reset when 'paste' is set and restored when 'paste' is
6906 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006907
6908 *'smarttab'* *'sta'* *'nosmarttab'* *'nosta'*
6909'smarttab' 'sta' boolean (default off)
6910 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00006911 When on, a <Tab> in front of a line inserts blanks according to
Bram Moolenaar280f1262006-01-30 00:14:18 +00006912 'shiftwidth'. 'tabstop' or 'softtabstop' is used in other places. A
6913 <BS> will delete a 'shiftwidth' worth of space at the start of the
6914 line.
Bram Moolenaarafeb4fa2006-02-01 21:51:12 +00006915 When off, a <Tab> always inserts blanks according to 'tabstop' or
Bram Moolenaar280f1262006-01-30 00:14:18 +00006916 'softtabstop'. 'shiftwidth' is only used for shifting text left or
6917 right |shift-left-right|.
Bram Moolenaarebcbd022007-05-12 14:28:25 +00006918 What gets inserted (a <Tab> or spaces) depends on the 'expandtab'
Bram Moolenaar071d4272004-06-13 20:20:40 +00006919 option. Also see |ins-expandtab|. When 'expandtab' is not set, the
Bram Moolenaar843ee412004-06-30 16:16:41 +00006920 number of spaces is minimized by using <Tab>s.
Bram Moolenaarca635012015-09-25 20:34:21 +02006921 This option is reset when 'paste' is set and restored when 'paste' is
6922 reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006923 NOTE: This option is reset when 'compatible' is set.
6924
6925 *'softtabstop'* *'sts'*
6926'softtabstop' 'sts' number (default 0)
6927 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00006928 Number of spaces that a <Tab> counts for while performing editing
6929 operations, like inserting a <Tab> or using <BS>. It "feels" like
6930 <Tab>s are being inserted, while in fact a mix of spaces and <Tab>s is
6931 used. This is useful to keep the 'ts' setting at its standard value
6932 of 8, while being able to edit like it is set to 'sts'. However,
6933 commands like "x" still work on the actual characters.
6934 When 'sts' is zero, this feature is off.
Bram Moolenaar3a0d8092012-10-21 03:02:54 +02006935 When 'sts' is negative, the value of 'shiftwidth' is used.
Bram Moolenaarca635012015-09-25 20:34:21 +02006936 'softtabstop' is set to 0 when the 'paste' option is set and restored
6937 when 'paste' is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00006938 See also |ins-expandtab|. When 'expandtab' is not set, the number of
6939 spaces is minimized by using <Tab>s.
6940 The 'L' flag in 'cpoptions' changes how tabs are used when 'list' is
6941 set.
6942 NOTE: This option is set to 0 when 'compatible' is set.
6943
Bram Moolenaar04958cb2018-06-23 19:23:02 +02006944 If Vim is compiled with the |+vartabs| feature then the value of
6945 'softtabstop' will be ignored if |'varsofttabstop'| is set to
6946 anything other than an empty string.
6947
Bram Moolenaar217ad922005-03-20 22:37:15 +00006948 *'spell'* *'nospell'*
6949'spell' boolean (default off)
6950 local to window
Bram Moolenaar217ad922005-03-20 22:37:15 +00006951 {not available when compiled without the |+syntax|
6952 feature}
6953 When on spell checking will be done. See |spell|.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00006954 The languages are specified with 'spelllang'.
Bram Moolenaar217ad922005-03-20 22:37:15 +00006955
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006956 *'spellcapcheck'* *'spc'*
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006957'spellcapcheck' 'spc' string (default "[.?!]\_[\])'" \t]\+")
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006958 local to buffer
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006959 {not available when compiled without the |+syntax|
6960 feature}
6961 Pattern to locate the end of a sentence. The following word will be
6962 checked to start with a capital letter. If not then it is highlighted
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00006963 with SpellCap |hl-SpellCap| (unless the word is also badly spelled).
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006964 When this check is not wanted make this option empty.
6965 Only used when 'spell' is set.
Bram Moolenaar0dc065e2005-07-04 22:49:24 +00006966 Be careful with special characters, see |option-backslash| about
6967 including spaces and backslashes.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00006968 To set this option automatically depending on the language, see
6969 |set-spc-auto|.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006970
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006971 *'spellfile'* *'spf'*
6972'spellfile' 'spf' string (default empty)
6973 local to buffer
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006974 {not available when compiled without the |+syntax|
6975 feature}
6976 Name of the word list file where words are added for the |zg| and |zw|
Bram Moolenaar045e82d2005-07-08 22:25:33 +00006977 commands. It must end in ".{encoding}.add". You need to include the
6978 path, otherwise the file is placed in the current directory.
Bram Moolenaar0d9c26d2005-07-02 23:19:16 +00006979 *E765*
6980 It may also be a comma separated list of names. A count before the
6981 |zg| and |zw| commands can be used to access each. This allows using
6982 a personal word list file and a project word list file.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006983 When a word is added while this option is empty Vim will set it for
Bram Moolenaar910f66f2006-04-05 20:41:53 +00006984 you: Using the first directory in 'runtimepath' that is writable. If
6985 there is no "spell" directory yet it will be created. For the file
6986 name the first language name that appears in 'spelllang' is used,
Bram Moolenaar3b506942005-06-23 22:36:45 +00006987 ignoring the region.
6988 The resulting ".spl" file will be used for spell checking, it does not
6989 have to appear in 'spelllang'.
6990 Normally one file is used for all regions, but you can add the region
6991 name if you want to. However, it will then only be used when
6992 'spellfile' is set to it, for entries in 'spelllang' only files
6993 without region name will be found.
Bram Moolenaare7566042005-06-17 22:00:15 +00006994 This option cannot be set from a |modeline| or in the |sandbox|, for
6995 security reasons.
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006996
Bram Moolenaar217ad922005-03-20 22:37:15 +00006997 *'spelllang'* *'spl'*
Bram Moolenaar82cf9b62005-06-07 21:09:25 +00006998'spelllang' 'spl' string (default "en")
Bram Moolenaar217ad922005-03-20 22:37:15 +00006999 local to buffer
Bram Moolenaar217ad922005-03-20 22:37:15 +00007000 {not available when compiled without the |+syntax|
7001 feature}
Bram Moolenaar3b506942005-06-23 22:36:45 +00007002 A comma separated list of word list names. When the 'spell' option is
7003 on spellchecking will be done for these languages. Example: >
7004 set spelllang=en_us,nl,medical
7005< This means US English, Dutch and medical words are recognized. Words
7006 that are not recognized will be highlighted.
Bram Moolenaar911ead12019-04-21 00:03:35 +02007007 The word list name must consist of alphanumeric characters, a dash or
7008 an underscore. It should not include a comma or dot. Using a dash is
Bram Moolenaar3b506942005-06-23 22:36:45 +00007009 recommended to separate the two letter language name from a
7010 specification. Thus "en-rare" is used for rare English words.
7011 A region name must come last and have the form "_xx", where "xx" is
7012 the two-letter, lower case region name. You can use more than one
7013 region by listing them: "en_us,en_ca" supports both US and Canadian
7014 English, but not words specific for Australia, New Zealand or Great
Bram Moolenaarfa735342016-01-03 22:14:44 +01007015 Britain. (Note: currently en_au and en_nz dictionaries are older than
7016 en_ca, en_gb and en_us).
Bram Moolenaarcc63c642013-11-12 04:44:01 +01007017 If the name "cjk" is included East Asian characters are excluded from
7018 spell checking. This is useful when editing text that also has Asian
7019 words.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007020 *E757*
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007021 As a special case the name of a .spl file can be given as-is. The
7022 first "_xx" in the name is removed and used as the region name
7023 (_xx is an underscore, two letters and followed by a non-letter).
7024 This is mainly for testing purposes. You must make sure the correct
7025 encoding is used, Vim doesn't check it.
Bram Moolenaar402d2fe2005-04-15 21:00:38 +00007026 When 'encoding' is set the word lists are reloaded. Thus it's a good
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007027 idea to set 'spelllang' after setting 'encoding' to avoid loading the
7028 files twice.
Bram Moolenaar3b506942005-06-23 22:36:45 +00007029 How the related spell files are found is explained here: |spell-load|.
Bram Moolenaar217ad922005-03-20 22:37:15 +00007030
Bram Moolenaar98692072006-02-04 00:57:42 +00007031 If the |spellfile.vim| plugin is active and you use a language name
7032 for which Vim cannot find the .spl file in 'runtimepath' the plugin
7033 will ask you if you want to download the file.
7034
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007035 After this option has been set successfully, Vim will source the files
7036 "spell/LANG.vim" in 'runtimepath'. "LANG" is the value of 'spelllang'
Bram Moolenaarb730f0c2018-11-25 03:56:26 +01007037 up to the first character that is not an ASCII letter or number and
7038 not a dash. Also see |set-spc-auto|.
Bram Moolenaar90cfdbe2005-08-12 19:59:19 +00007039
7040
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007041 *'spellsuggest'* *'sps'*
7042'spellsuggest' 'sps' string (default "best")
7043 global
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007044 {not available when compiled without the |+syntax|
7045 feature}
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007046 Methods used for spelling suggestions. Both for the |z=| command and
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007047 the |spellsuggest()| function. This is a comma-separated list of
7048 items:
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007049
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007050 best Internal method that works best for English. Finds
7051 changes like "fast" and uses a bit of sound-a-like
7052 scoring to improve the ordering.
7053
7054 double Internal method that uses two methods and mixes the
7055 results. The first method is "fast", the other method
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007056 computes how much the suggestion sounds like the bad
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007057 word. That only works when the language specifies
7058 sound folding. Can be slow and doesn't always give
7059 better results.
7060
7061 fast Internal method that only checks for simple changes:
7062 character inserts/deletes/swaps. Works well for
7063 simple typing mistakes.
7064
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007065 {number} The maximum number of suggestions listed for |z=|.
Bram Moolenaar8aff23a2005-08-19 20:40:30 +00007066 Not used for |spellsuggest()|. The number of
7067 suggestions is never more than the value of 'lines'
7068 minus two.
7069
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007070 file:{filename} Read file {filename}, which must have two columns,
7071 separated by a slash. The first column contains the
7072 bad word, the second column the suggested good word.
7073 Example:
7074 theribal/terrible ~
7075 Use this for common mistakes that do not appear at the
7076 top of the suggestion list with the internal methods.
7077 Lines without a slash are ignored, use this for
7078 comments.
Bram Moolenaarbcb98982014-05-01 14:08:19 +02007079 The word in the second column must be correct,
7080 otherwise it will not be used. Add the word to an
7081 ".add" file if it is currently flagged as a spelling
7082 mistake.
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007083 The file is used for all languages.
7084
7085 expr:{expr} Evaluate expression {expr}. Use a function to avoid
7086 trouble with spaces. |v:val| holds the badly spelled
7087 word. The expression must evaluate to a List of
7088 Lists, each with a suggestion and a score.
7089 Example:
Bram Moolenaar214641f2017-03-05 17:04:09 +01007090 [['the', 33], ['that', 44]] ~
Bram Moolenaar2c7a29c2005-12-12 22:02:31 +00007091 Set 'verbose' and use |z=| to see the scores that the
Bram Moolenaar24bbcfe2005-06-28 23:32:02 +00007092 internal methods use. A lower score is better.
7093 This may invoke |spellsuggest()| if you temporarily
7094 set 'spellsuggest' to exclude the "expr:" part.
7095 Errors are silently ignored, unless you set the
7096 'verbose' option to a non-zero value.
7097
7098 Only one of "best", "double" or "fast" may be used. The others may
7099 appear several times in any order. Example: >
7100 :set sps=file:~/.vim/sugg,best,expr:MySuggest()
7101<
7102 This option cannot be set from a |modeline| or in the |sandbox|, for
7103 security reasons.
Bram Moolenaard857f0e2005-06-21 22:37:39 +00007104
7105
Bram Moolenaar071d4272004-06-13 20:20:40 +00007106 *'splitbelow'* *'sb'* *'nosplitbelow'* *'nosb'*
7107'splitbelow' 'sb' boolean (default off)
7108 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007109 When on, splitting a window will put the new window below the current
7110 one. |:split|
7111
7112 *'splitright'* *'spr'* *'nosplitright'* *'nospr'*
7113'splitright' 'spr' boolean (default off)
7114 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007115 When on, splitting a window will put the new window right of the
7116 current one. |:vsplit|
7117
7118 *'startofline'* *'sol'* *'nostartofline'* *'nosol'*
7119'startofline' 'sol' boolean (default on)
7120 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007121 When "on" the commands listed below move the cursor to the first
Bram Moolenaar843ee412004-06-30 16:16:41 +00007122 non-blank of the line. When off the cursor is kept in the same column
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007123 (if possible). This applies to the commands: CTRL-D, CTRL-U, CTRL-B,
Bram Moolenaar843ee412004-06-30 16:16:41 +00007124 CTRL-F, "G", "H", "M", "L", gg, and to the commands "d", "<<" and ">>"
Bram Moolenaar071d4272004-06-13 20:20:40 +00007125 with a linewise operator, with "%" with a count and to buffer changing
7126 commands (CTRL-^, :bnext, :bNext, etc.). Also for an Ex command that
7127 only has a line number, e.g., ":25" or ":+".
7128 In case of buffer changing commands the cursor is placed at the column
7129 where it was the last time the buffer was edited.
7130 NOTE: This option is set when 'compatible' is set.
7131
Bram Moolenaar00654022011-02-25 14:42:19 +01007132 *'statusline'* *'stl'* *E540* *E542*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007133'statusline' 'stl' string (default empty)
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00007134 global or local to window |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007135 {not available when compiled without the |+statusline|
7136 feature}
7137 When nonempty, this option determines the content of the status line.
7138 Also see |status-line|.
7139
7140 The option consists of printf style '%' items interspersed with
7141 normal text. Each status line item is of the form:
7142 %-0{minwid}.{maxwid}{item}
Bram Moolenaar5e9b2fa2016-02-01 22:37:05 +01007143 All fields except the {item} are optional. A single percent sign can
Bram Moolenaar00654022011-02-25 14:42:19 +01007144 be given as "%%". Up to 80 items can be specified. *E541*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007145
Bram Moolenaar238a5642006-02-21 22:12:05 +00007146 When the option starts with "%!" then it is used as an expression,
7147 evaluated and the result is used as the option value. Example: >
7148 :set statusline=%!MyStatusLine()
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007149< The *g:statusline_winid* variable will be set to the |window-ID| of the
7150 window that the status line belongs to.
7151 The result can contain %{} items that will be evaluated too.
Bram Moolenaar61d35bd2012-03-28 20:51:51 +02007152 Note that the "%!" expression is evaluated in the context of the
7153 current window and buffer, while %{} items are evaluated in the
7154 context of the window that the statusline belongs to.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007155
7156 When there is error while evaluating the option then it will be made
7157 empty to avoid further errors. Otherwise screen updating would loop.
7158
Bram Moolenaar071d4272004-06-13 20:20:40 +00007159 Note that the only effect of 'ruler' when this option is set (and
7160 'laststatus' is 2) is controlling the output of |CTRL-G|.
7161
7162 field meaning ~
Bram Moolenaar582fd852005-03-28 20:58:01 +00007163 - Left justify the item. The default is right justified
Bram Moolenaar071d4272004-06-13 20:20:40 +00007164 when minwid is larger than the length of the item.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007165 0 Leading zeroes in numeric items. Overridden by '-'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007166 minwid Minimum width of the item, padding as set by '-' & '0'.
7167 Value must be 50 or less.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007168 maxwid Maximum width of the item. Truncation occurs with a '<'
Bram Moolenaar071d4272004-06-13 20:20:40 +00007169 on the left for text items. Numeric items will be
7170 shifted down to maxwid-2 digits followed by '>'number
7171 where number is the amount of missing digits, much like
7172 an exponential notation.
7173 item A one letter code as described below.
7174
7175 Following is a description of the possible statusline items. The
7176 second character in "item" is the type:
7177 N for number
7178 S for string
7179 F for flags as described below
7180 - not applicable
7181
7182 item meaning ~
Bram Moolenaar02467872007-05-06 13:22:01 +00007183 f S Path to the file in the buffer, as typed or relative to current
7184 directory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007185 F S Full path to the file in the buffer.
7186 t S File name (tail) of file in the buffer.
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007187 m F Modified flag, text is "[+]"; "[-]" if 'modifiable' is off.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007188 M F Modified flag, text is ",+" or ",-".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007189 r F Readonly flag, text is "[RO]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007190 R F Readonly flag, text is ",RO".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007191 h F Help buffer flag, text is "[help]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007192 H F Help buffer flag, text is ",HLP".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007193 w F Preview window flag, text is "[Preview]".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007194 W F Preview window flag, text is ",PRV".
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007195 y F Type of file in the buffer, e.g., "[vim]". See 'filetype'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007196 Y F Type of file in the buffer, e.g., ",VIM". See 'filetype'.
Bram Moolenaar7fd73202010-07-25 16:58:46 +02007197 q S "[Quickfix List]", "[Location List]" or empty.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007198 k S Value of "b:keymap_name" or 'keymap' when |:lmap| mappings are
7199 being used: "<keymap>"
7200 n N Buffer number.
Bram Moolenaar00654022011-02-25 14:42:19 +01007201 b N Value of character under cursor.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007202 B N As above, in hexadecimal.
7203 o N Byte number in file of byte under cursor, first byte is 1.
7204 Mnemonic: Offset from start of file (with one added)
7205 {not available when compiled without |+byte_offset| feature}
7206 O N As above, in hexadecimal.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007207 N N Printer page number. (Only works in the 'printheader' option.)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007208 l N Line number.
7209 L N Number of lines in buffer.
7210 c N Column number.
7211 v N Virtual column number.
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007212 V N Virtual column number as -{num}. Not displayed if equal to 'c'.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007213 p N Percentage through file in lines as in |CTRL-G|.
7214 P S Percentage through file of displayed window. This is like the
Bram Moolenaar14b69452013-06-29 23:05:20 +02007215 percentage described for 'ruler'. Always 3 in length, unless
7216 translated.
Bram Moolenaar582fd852005-03-28 20:58:01 +00007217 a S Argument list status as in default title. ({current} of {max})
Bram Moolenaar071d4272004-06-13 20:20:40 +00007218 Empty if the argument file count is zero or one.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007219 { NF Evaluate expression between '%{' and '}' and substitute result.
Bram Moolenaar6d150f72018-04-21 20:03:20 +02007220 Note that there is no '%' before the closing '}'. The
7221 expression cannot contain a '}' character, call a function to
7222 work around that.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007223 ( - Start of item group. Can be used for setting the width and
7224 alignment of a section. Must be followed by %) somewhere.
7225 ) - End of item group. No width fields allowed.
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007226 T N For 'tabline': start of tab page N label. Use %T after the last
7227 label. This information is used for mouse clicks.
7228 X N For 'tabline': start of close tab N label. Use %X after the
7229 label, e.g.: %3Xclose%X. Use %999X for a "close current tab"
7230 mark. This information is used for mouse clicks.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007231 < - Where to truncate line if too long. Default is at the start.
7232 No width fields allowed.
7233 = - Separation point between left and right aligned items.
7234 No width fields allowed.
Bram Moolenaar238a5642006-02-21 22:12:05 +00007235 # - Set highlight group. The name must follow and then a # again.
7236 Thus use %#HLname# for highlight group HLname. The same
7237 highlighting is used, also for the statusline of non-current
7238 windows.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007239 * - Set highlight group to User{N}, where {N} is taken from the
Bram Moolenaar582fd852005-03-28 20:58:01 +00007240 minwid field, e.g. %1*. Restore normal highlight with %* or %0*.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007241 The difference between User{N} and StatusLine will be applied
7242 to StatusLineNC for the statusline of non-current windows.
7243 The number N must be between 1 and 9. See |hl-User1..9|
7244
Bram Moolenaare37d50a2008-08-06 17:06:04 +00007245 When displaying a flag, Vim removes the leading comma, if any, when
7246 that flag comes right after plaintext. This will make a nice display
7247 when flags are used like in the examples below.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007248
Bram Moolenaar582fd852005-03-28 20:58:01 +00007249 When all items in a group becomes an empty string (i.e. flags that are
Bram Moolenaar071d4272004-06-13 20:20:40 +00007250 not set) and a minwid is not set for the group, the whole group will
7251 become empty. This will make a group like the following disappear
7252 completely from the statusline when none of the flags are set. >
7253 :set statusline=...%(\ [%M%R%H]%)...
Bram Moolenaar1c6fd1e2019-05-23 22:11:59 +02007254< Beware that an expression is evaluated each and every time the status
7255 line is displayed.
7256 *g:actual_curbuf* *g:actual_curwin*
7257 The current buffer and current window will be set temporarily to that
7258 of the window (and buffer) whose statusline is currently being drawn.
7259 The expression will evaluate in this context. The variable
7260 "g:actual_curbuf" is set to the `bufnr()` number of the real current
7261 buffer and "g:actual_curwin" to the |window-ID| of the real current
7262 window. These values are strings.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007263
Bram Moolenaar30b65812012-07-12 22:01:11 +02007264 The 'statusline' option will be evaluated in the |sandbox| if set from
7265 a modeline, see |sandbox-option|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007266 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaarb71eaae2006-01-20 23:10:18 +00007267
7268 It is not allowed to change text or jump to another window while
7269 evaluating 'statusline' |textlock|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007270
7271 If the statusline is not updated when you want it (e.g., after setting
7272 a variable that's used in an expression), you can force an update by
7273 setting an option without changing its value. Example: >
7274 :let &ro = &ro
7275
7276< A result of all digits is regarded a number for display purposes.
7277 Otherwise the result is taken as flag text and applied to the rules
7278 described above.
7279
Bram Moolenaarcd71fa32005-03-11 22:46:48 +00007280 Watch out for errors in expressions. They may render Vim unusable!
Bram Moolenaar071d4272004-06-13 20:20:40 +00007281 If you are stuck, hold down ':' or 'Q' to get a prompt, then quit and
Bram Moolenaarc4da1132017-07-15 19:39:43 +02007282 edit your .vimrc or whatever with "vim --clean" to get it right.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007283
7284 Examples:
7285 Emulate standard status line with 'ruler' set >
7286 :set statusline=%<%f\ %h%m%r%=%-14.(%l,%c%V%)\ %P
7287< Similar, but add ASCII value of char under the cursor (like "ga") >
7288 :set statusline=%<%f%h%m%r%=%b\ 0x%B\ \ %l,%c%V\ %P
7289< Display byte count and byte value, modified flag in red. >
7290 :set statusline=%<%f%=\ [%1*%M%*%n%R%H]\ %-19(%3l,%02c%03V%)%O'%02b'
7291 :hi User1 term=inverse,bold cterm=inverse,bold ctermfg=red
7292< Display a ,GZ flag if a compressed file is loaded >
7293 :set statusline=...%r%{VarExists('b:gzflag','\ [GZ]')}%h...
7294< In the |:autocmd|'s: >
7295 :let b:gzflag = 1
7296< And: >
7297 :unlet b:gzflag
7298< And define this function: >
7299 :function VarExists(var, val)
7300 : if exists(a:var) | return a:val | else | return '' | endif
7301 :endfunction
7302<
7303 *'suffixes'* *'su'*
7304'suffixes' 'su' string (default ".bak,~,.o,.h,.info,.swp,.obj")
7305 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007306 Files with these suffixes get a lower priority when multiple files
7307 match a wildcard. See |suffixes|. Commas can be used to separate the
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007308 suffixes. Spaces after the comma are ignored. A dot is also seen as
7309 the start of a suffix. To avoid a dot or comma being recognized as a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007310 separator, precede it with a backslash (see |option-backslash| about
7311 including spaces and backslashes).
7312 See 'wildignore' for completely ignoring files.
7313 The use of |:set+=| and |:set-=| is preferred when adding or removing
7314 suffixes from the list. This avoids problems when a future version
7315 uses another default.
7316
7317 *'suffixesadd'* *'sua'*
7318'suffixesadd' 'sua' string (default "")
7319 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007320 {not available when compiled without the
7321 |+file_in_path| feature}
7322 Comma separated list of suffixes, which are used when searching for a
7323 file for the "gf", "[I", etc. commands. Example: >
7324 :set suffixesadd=.java
7325<
7326 *'swapfile'* *'swf'* *'noswapfile'* *'noswf'*
7327'swapfile' 'swf' boolean (default on)
7328 local to buffer
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007329 Use a swapfile for the buffer. This option can be reset when a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007330 swapfile is not wanted for a specific buffer. For example, with
7331 confidential information that even root must not be able to access.
7332 Careful: All text will be in memory:
7333 - Don't use this for big files.
7334 - Recovery will be impossible!
7335 A swapfile will only be present when |'updatecount'| is non-zero and
7336 'swapfile' is set.
7337 When 'swapfile' is reset, the swap file for the current buffer is
7338 immediately deleted. When 'swapfile' is set, and 'updatecount' is
7339 non-zero, a swap file is immediately created.
7340 Also see |swap-file| and |'swapsync'|.
Bram Moolenaar76f3b1a2014-03-27 22:30:07 +01007341 If you want to open a new buffer without creating a swap file for it,
7342 use the |:noswapfile| modifier.
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007343 See 'directory' for where the swap file is created.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007344
7345 This option is used together with 'bufhidden' and 'buftype' to
7346 specify special kinds of buffers. See |special-buffers|.
7347
7348 *'swapsync'* *'sws'*
7349'swapsync' 'sws' string (default "fsync")
7350 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007351 When this option is not empty a swap file is synced to disk after
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007352 writing to it. This takes some time, especially on busy unix systems.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007353 When this option is empty parts of the swap file may be in memory and
7354 not written to disk. When the system crashes you may lose more work.
7355 On Unix the system does a sync now and then without Vim asking for it,
7356 so the disadvantage of setting this option off is small. On some
7357 systems the swap file will not be written at all. For a unix system
7358 setting it to "sync" will use the sync() call instead of the default
7359 fsync(), which may work better on some systems.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007360 The 'fsync' option is used for the actual file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007361
7362 *'switchbuf'* *'swb'*
7363'switchbuf' 'swb' string (default "")
7364 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007365 This option controls the behavior when switching between buffers.
7366 Possible values (comma separated list):
7367 useopen If included, jump to the first open window that
7368 contains the specified buffer (if there is one).
7369 Otherwise: Do not examine other windows.
7370 This setting is checked with |quickfix| commands, when
7371 jumping to errors (":cc", ":cn", "cp", etc.). It is
7372 also used in all buffer related split commands, for
7373 example ":sbuffer", ":sbnext", or ":sbrewind".
Bram Moolenaar779b74b2006-04-10 14:55:34 +00007374 usetab Like "useopen", but also consider windows in other tab
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00007375 pages.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007376 split If included, split the current window before loading
Bram Moolenaar15146672011-10-20 22:22:38 +02007377 a buffer for a |quickfix| command that display errors.
Bram Moolenaar63b74a82019-03-24 15:09:13 +01007378 Otherwise: do not split, use current window (when used
7379 in the quickfix window: the previously used window or
7380 split if there is no other window).
Bram Moolenaara594d772015-06-19 14:41:49 +02007381 vsplit Just like "split" but split vertically.
Bram Moolenaar446cb832008-06-24 21:56:24 +00007382 newtab Like "split", but open a new tab page. Overrules
Bram Moolenaar0bc380a2010-07-10 13:52:13 +02007383 "split" when both are present.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007384
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007385 *'synmaxcol'* *'smc'*
7386'synmaxcol' 'smc' number (default 3000)
7387 local to buffer
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007388 {not available when compiled without the |+syntax|
7389 feature}
Bram Moolenaarce0842a2005-07-18 21:58:11 +00007390 Maximum column in which to search for syntax items. In long lines the
7391 text after this column is not highlighted and following lines may not
7392 be highlighted correctly, because the syntax state is cleared.
Bram Moolenaar3b56eb32005-07-11 22:40:32 +00007393 This helps to avoid very slow redrawing for an XML file that is one
7394 long line.
7395 Set to zero to remove the limit.
7396
Bram Moolenaar071d4272004-06-13 20:20:40 +00007397 *'syntax'* *'syn'*
7398'syntax' 'syn' string (default empty)
7399 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007400 {not available when compiled without the |+syntax|
7401 feature}
7402 When this option is set, the syntax with this name is loaded, unless
7403 syntax highlighting has been switched off with ":syntax off".
7404 Otherwise this option does not always reflect the current syntax (the
7405 b:current_syntax variable does).
7406 This option is most useful in a modeline, for a file which syntax is
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00007407 not automatically recognized. Example, in an IDL file:
7408 /* vim: set syntax=idl : */ ~
7409 When a dot appears in the value then this separates two filetype
7410 names. Example:
7411 /* vim: set syntax=c.doxygen : */ ~
7412 This will use the "c" syntax first, then the "doxygen" syntax.
7413 Note that the second one must be prepared to be loaded as an addition,
7414 otherwise it will be skipped. More than one dot may appear.
7415 To switch off syntax highlighting for the current file, use: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00007416 :set syntax=OFF
7417< To switch syntax highlighting on according to the current value of the
7418 'filetype' option: >
7419 :set syntax=ON
7420< What actually happens when setting the 'syntax' option is that the
7421 Syntax autocommand event is triggered with the value as argument.
7422 This option is not copied to another buffer, independent of the 's' or
7423 'S' flag in 'cpoptions'.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007424 Only normal file name characters can be used, "/\*?[|<>" are illegal.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007425
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007426 *'tabline'* *'tal'*
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007427'tabline' 'tal' string (default empty)
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007428 global
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007429 When nonempty, this option determines the content of the tab pages
7430 line at the top of the Vim window. When empty Vim will use a default
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007431 tab pages line. See |setting-tabline| for more info.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007432
7433 The tab pages line only appears as specified with the 'showtabline'
Bram Moolenaar5c8837f2006-02-25 21:52:33 +00007434 option and only when there is no GUI tab line. When 'e' is in
7435 'guioptions' and the GUI supports a tab line 'guitablabel' is used
Bram Moolenaar7f036442010-08-15 15:24:20 +02007436 instead. Note that the two tab pages lines are very different.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007437
7438 The value is evaluated like with 'statusline'. You can use
7439 |tabpagenr()|, |tabpagewinnr()| and |tabpagebuflist()| to figure out
Bram Moolenaard1f56e62006-02-22 21:25:37 +00007440 the text to be displayed. Use "%1T" for the first label, "%2T" for
7441 the second one, etc. Use "%X" items for closing labels.
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007442
Bram Moolenaare12bab32019-01-08 22:02:56 +01007443 When changing something that is used in 'tabline' that does not
7444 trigger it to be updated, use |:redrawtabline|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007445 This option cannot be set in a modeline when 'modelineexpr' is off.
Bram Moolenaare12bab32019-01-08 22:02:56 +01007446
Bram Moolenaarfaa959a2006-02-20 21:37:40 +00007447 Keep in mind that only one of the tab pages is the current one, others
7448 are invisible and you can't jump to their windows.
7449
Bram Moolenaar7e8fd632006-02-18 22:14:51 +00007450
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007451 *'tabpagemax'* *'tpm'*
7452'tabpagemax' 'tpm' number (default 10)
7453 global
Bram Moolenaarfd2ac762006-03-01 22:09:21 +00007454 Maximum number of tab pages to be opened by the |-p| command line
7455 argument or the ":tab all" command. |tabpage|
7456
7457
7458 *'tabstop'* *'ts'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00007459'tabstop' 'ts' number (default 8)
7460 local to buffer
7461 Number of spaces that a <Tab> in the file counts for. Also see
7462 |:retab| command, and 'softtabstop' option.
7463
7464 Note: Setting 'tabstop' to any other value than 8 can make your file
7465 appear wrong in many places (e.g., when printing it).
7466
7467 There are four main ways to use tabs in Vim:
7468 1. Always keep 'tabstop' at 8, set 'softtabstop' and 'shiftwidth' to 4
7469 (or 3 or whatever you prefer) and use 'noexpandtab'. Then Vim
Bram Moolenaarebcbd022007-05-12 14:28:25 +00007470 will use a mix of tabs and spaces, but typing <Tab> and <BS> will
Bram Moolenaar071d4272004-06-13 20:20:40 +00007471 behave like a tab appears every 4 (or 3) characters.
7472 2. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use
7473 'expandtab'. This way you will always insert spaces. The
7474 formatting will never be messed up when 'tabstop' is changed.
7475 3. Set 'tabstop' and 'shiftwidth' to whatever you prefer and use a
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007476 |modeline| to set these values when editing the file again. Only
Bram Moolenaar071d4272004-06-13 20:20:40 +00007477 works when using Vim to edit the file.
7478 4. Always set 'tabstop' and 'shiftwidth' to the same value, and
7479 'noexpandtab'. This should then work (for initial indents only)
7480 for any tabstop setting that people use. It might be nice to have
7481 tabs after the first non-blank inserted as spaces if you do this
7482 though. Otherwise aligned comments will be wrong when 'tabstop' is
7483 changed.
7484
Bram Moolenaar04958cb2018-06-23 19:23:02 +02007485 If Vim is compiled with the |+vartabs| feature then the value of
7486 'tabstop' will be ignored if |'vartabstop'| is set to anything other
7487 than an empty string.
7488
Bram Moolenaar071d4272004-06-13 20:20:40 +00007489 *'tagbsearch'* *'tbs'* *'notagbsearch'* *'notbs'*
7490'tagbsearch' 'tbs' boolean (default on)
7491 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007492 When searching for a tag (e.g., for the |:ta| command), Vim can either
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007493 use a binary search or a linear search in a tags file. Binary
Bram Moolenaar071d4272004-06-13 20:20:40 +00007494 searching makes searching for a tag a LOT faster, but a linear search
7495 will find more tags if the tags file wasn't properly sorted.
7496 Vim normally assumes that your tags files are sorted, or indicate that
7497 they are not sorted. Only when this is not the case does the
7498 'tagbsearch' option need to be switched off.
7499
7500 When 'tagbsearch' is on, binary searching is first used in the tags
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007501 files. In certain situations, Vim will do a linear search instead for
Bram Moolenaar071d4272004-06-13 20:20:40 +00007502 certain files, or retry all files with a linear search. When
7503 'tagbsearch' is off, only a linear search is done.
7504
7505 Linear searching is done anyway, for one file, when Vim finds a line
7506 at the start of the file indicating that it's not sorted: >
Bram Moolenaar446cb832008-06-24 21:56:24 +00007507 !_TAG_FILE_SORTED 0 /some comment/
Bram Moolenaar071d4272004-06-13 20:20:40 +00007508< [The whitespace before and after the '0' must be a single <Tab>]
7509
7510 When a binary search was done and no match was found in any of the
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007511 files listed in 'tags', and case is ignored or a pattern is used
Bram Moolenaar071d4272004-06-13 20:20:40 +00007512 instead of a normal tag name, a retry is done with a linear search.
7513 Tags in unsorted tags files, and matches with different case will only
7514 be found in the retry.
7515
Bram Moolenaard4755bb2004-09-02 19:12:26 +00007516 If a tag file indicates that it is case-fold sorted, the second,
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007517 linear search can be avoided when case is ignored. Use a value of '2'
7518 in the "!_TAG_FILE_SORTED" line for this. A tag file can be case-fold
7519 sorted with the -f switch to "sort" in most unices, as in the command:
7520 "sort -f -o tags tags". For "Exuberant ctags" version 5.x or higher
7521 (at least 5.5) the --sort=foldcase switch can be used for this as
7522 well. Note that case must be folded to uppercase for this to work.
7523
7524 By default, tag searches are case-sensitive. Case is ignored when
7525 'ignorecase' is set and 'tagcase' is "followic", or when 'tagcase' is
7526 "ignore".
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007527 Also when 'tagcase' is "followscs" and 'smartcase' is set, or
7528 'tagcase' is "smart", and the pattern contains only lowercase
7529 characters.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007530
7531 When 'tagbsearch' is off, tags searching is slower when a full match
7532 exists, but faster when no full match exists. Tags in unsorted tags
7533 files may only be found with 'tagbsearch' off.
7534 When the tags file is not sorted, or sorted in a wrong way (not on
7535 ASCII byte value), 'tagbsearch' should be off, or the line given above
7536 must be included in the tags file.
7537 This option doesn't affect commands that find all matching tags (e.g.,
7538 command-line completion and ":help").
Bram Moolenaar071d4272004-06-13 20:20:40 +00007539
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007540 *'tagcase'* *'tc'*
7541'tagcase' 'tc' string (default "followic")
7542 global or local to buffer |global-local|
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007543 This option specifies how case is handled when searching the tags
7544 file:
7545 followic Follow the 'ignorecase' option
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007546 followscs Follow the 'smartcase' and 'ignorecase' options
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007547 ignore Ignore case
7548 match Match case
Bram Moolenaar66e29d72016-08-20 16:57:02 +02007549 smart Ignore case unless an upper case letter is used
Bram Moolenaar036986f2017-03-16 17:41:02 +01007550 NOTE: This option is set to the Vi default value when 'compatible' is
7551 set and to the Vim default value when 'compatible' is reset.
Bram Moolenaar0f6562e2015-11-24 18:48:14 +01007552
Bram Moolenaar45e18cb2019-04-28 18:05:35 +02007553 *'tagfunc'* *'tfu'*
7554'tagfunc' 'tfu' string (default: empty)
7555 local to buffer
7556 {not available when compiled without the |+eval|
7557 feature}
7558 This option specifies a function to be used to perform tag searches.
7559 The function gets the tag pattern and should return a List of matching
7560 tags. See |tag-function| for an explanation of how to write the
7561 function and an example.
7562
Bram Moolenaar071d4272004-06-13 20:20:40 +00007563 *'taglength'* *'tl'*
7564'taglength' 'tl' number (default 0)
7565 global
7566 If non-zero, tags are significant up to this number of characters.
7567
7568 *'tagrelative'* *'tr'* *'notagrelative'* *'notr'*
7569'tagrelative' 'tr' boolean (Vim default: on, Vi default: off)
7570 global
Bram Moolenaarc6fe9192006-04-09 21:54:49 +00007571 If on and using a tags file in another directory, file names in that
7572 tags file are relative to the directory where the tags file is.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007573 NOTE: This option is set to the Vi default value when 'compatible' is
7574 set and to the Vim default value when 'compatible' is reset.
7575
7576 *'tags'* *'tag'* *E433*
7577'tags' 'tag' string (default "./tags,tags", when compiled with
7578 |+emacs_tags|: "./tags,./TAGS,tags,TAGS")
7579 global or local to buffer |global-local|
7580 Filenames for the tag command, separated by spaces or commas. To
7581 include a space or comma in a file name, precede it with a backslash
7582 (see |option-backslash| about including spaces and backslashes).
7583 When a file name starts with "./", the '.' is replaced with the path
7584 of the current file. But only when the 'd' flag is not included in
7585 'cpoptions'. Environment variables are expanded |:set_env|. Also see
7586 |tags-option|.
7587 "*", "**" and other wildcards can be used to search for tags files in
Bram Moolenaare2b590e2010-08-08 18:29:48 +02007588 a directory tree. See |file-searching|. E.g., "/lib/**/tags" will
7589 find all files named "tags" below "/lib". The filename itself cannot
7590 contain wildcards, it is used as-is. E.g., "/lib/**/tags?" will find
7591 files called "tags?". {not available when compiled without the
7592 |+path_extra| feature}
Bram Moolenaare7eb9df2005-09-09 19:49:30 +00007593 The |tagfiles()| function can be used to get a list of the file names
7594 actually used.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007595 If Vim was compiled with the |+emacs_tags| feature, Emacs-style tag
7596 files are also supported. They are automatically recognized. The
7597 default value becomes "./tags,./TAGS,tags,TAGS", unless case
7598 differences are ignored (MS-Windows). |emacs-tags|
7599 The use of |:set+=| and |:set-=| is preferred when adding or removing
7600 file names from the list. This avoids problems when a future version
7601 uses another default.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007602
7603 *'tagstack'* *'tgst'* *'notagstack'* *'notgst'*
7604'tagstack' 'tgst' boolean (default on)
7605 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007606 When on, the |tagstack| is used normally. When off, a ":tag" or
7607 ":tselect" command with an argument will not push the tag onto the
7608 tagstack. A following ":tag" without an argument, a ":pop" command or
7609 any other command that uses the tagstack will use the unmodified
7610 tagstack, but does change the pointer to the active entry.
7611 Resetting this option is useful when using a ":tag" command in a
7612 mapping which should not change the tagstack.
7613
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007614 *'tcldll'*
Bram Moolenaar3848e002016-03-19 18:42:29 +01007615'tcldll' string (default depends on the build)
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007616 global
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007617 {only available when compiled with the |+tcl/dyn|
7618 feature}
7619 Specifies the name of the Tcl shared library. The default is
7620 DYNAMIC_TCL_DLL, which was specified at compile time.
Bram Moolenaaraa3b15d2016-04-21 08:53:19 +02007621 Environment variables are expanded |:set_env|.
Bram Moolenaar8a5115c2016-01-09 19:41:11 +01007622 This option cannot be set from a |modeline| or in the |sandbox|, for
7623 security reasons.
7624
Bram Moolenaar071d4272004-06-13 20:20:40 +00007625 *'term'* *E529* *E530* *E531*
7626'term' string (default is $TERM, if that fails:
7627 in the GUI: "builtin_gui"
7628 on Amiga: "amiga"
7629 on BeOS: "beos-ansi"
7630 on Mac: "mac-ansi"
7631 on MiNT: "vt52"
7632 on MS-DOS: "pcterm"
7633 on OS/2: "os2ansi"
7634 on Unix: "ansi"
7635 on VMS: "ansi"
7636 on Win 32: "win32")
7637 global
7638 Name of the terminal. Used for choosing the terminal control
7639 characters. Environment variables are expanded |:set_env|.
7640 For example: >
7641 :set term=$TERM
7642< See |termcap|.
7643
7644 *'termbidi'* *'tbidi'*
7645 *'notermbidi'* *'notbidi'*
7646'termbidi' 'tbidi' boolean (default off, on for "mlterm")
7647 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007648 {only available when compiled with the |+arabic|
7649 feature}
7650 The terminal is in charge of Bi-directionality of text (as specified
7651 by Unicode). The terminal is also expected to do the required shaping
7652 that some languages (such as Arabic) require.
7653 Setting this option implies that 'rightleft' will not be set when
7654 'arabic' is set and the value of 'arabicshape' will be ignored.
7655 Note that setting 'termbidi' has the immediate effect that
7656 'arabicshape' is ignored, but 'rightleft' isn't changed automatically.
7657 This option is reset when the GUI is started.
7658 For further details see |arabic.txt|.
7659
7660 *'termencoding'* *'tenc'*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007661'termencoding' 'tenc' string (default ""; with GTK+ GUI: "utf-8"; with
Bram Moolenaar071d4272004-06-13 20:20:40 +00007662 Macintosh GUI: "macroman")
7663 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007664 Encoding used for the terminal. This specifies what character
7665 encoding the keyboard produces and the display will understand. For
Bram Moolenaar3848e002016-03-19 18:42:29 +01007666 the GUI it only applies to the keyboard ('encoding' is used for the
Bram Moolenaar02467872007-05-06 13:22:01 +00007667 display). Except for the Mac when 'macatsui' is off, then
7668 'termencoding' should be "macroman".
Bram Moolenaar071d4272004-06-13 20:20:40 +00007669 *E617*
Bram Moolenaar3df01732017-02-17 22:47:16 +01007670 Note: This does not apply to the GTK+ GUI. After the GUI has been
Bram Moolenaar071d4272004-06-13 20:20:40 +00007671 successfully initialized, 'termencoding' is forcibly set to "utf-8".
7672 Any attempts to set a different value will be rejected, and an error
7673 message is shown.
Bram Moolenaarac360bf2015-09-01 20:31:20 +02007674 For the Win32 GUI and console versions 'termencoding' is not used,
Bram Moolenaar071d4272004-06-13 20:20:40 +00007675 because the Win32 system always passes Unicode characters.
7676 When empty, the same encoding is used as for the 'encoding' option.
7677 This is the normal value.
7678 Not all combinations for 'termencoding' and 'encoding' are valid. See
7679 |encoding-table|.
7680 The value for this option must be supported by internal conversions or
7681 iconv(). When this is not possible no conversion will be done and you
7682 will probably experience problems with non-ASCII characters.
7683 Example: You are working with the locale set to euc-jp (Japanese) and
7684 want to edit a UTF-8 file: >
7685 :let &termencoding = &encoding
7686 :set encoding=utf-8
7687< You need to do this when your system has no locale support for UTF-8.
7688
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007689 *'termguicolors'* *'tgc'* *E954*
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007690'termguicolors' 'tgc' boolean (default off)
7691 global
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007692 {not available when compiled without the
7693 |+termguicolors| feature}
7694 When on, uses |highlight-guifg| and |highlight-guibg| attributes in
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007695 the terminal (thus using 24-bit color).
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007696
Bram Moolenaarcafafb32018-02-22 21:07:09 +01007697 Requires a ISO-8613-3 compatible terminal. If setting this option
7698 does not work (produces a colorless UI) reading |xterm-true-color|
7699 might help.
7700
7701 For Win32 console, Windows 10 version 1703 (Creators Update) or later
7702 is required. Use this check to find out: >
7703 if has('vcon')
Bram Moolenaar22f1d0e2018-02-27 14:53:30 +01007704< This requires Vim to be built with the |+vtp| feature.
7705
Bram Moolenaar6aa8cea2017-06-05 14:44:35 +02007706 Note that the "cterm" attributes are still used, not the "gui" ones.
Bram Moolenaar036986f2017-03-16 17:41:02 +01007707 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar61be73b2016-04-29 22:59:22 +02007708
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007709 *'termwinkey'* *'twk'*
7710'termwinkey' 'twk' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007711 local to window
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007712 The key that starts a CTRL-W command in a terminal window. Other keys
Bram Moolenaar74675a62017-07-15 13:53:23 +02007713 are sent to the job running in the window.
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007714 The <> notation can be used, e.g.: >
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007715 :set termwinkey=<C-L>
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007716< The string must be one key stroke but can be multiple bytes.
7717 When not set CTRL-W is used, so that CTRL-W : gets you to the command
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007718 line. If 'termwinkey' is set to CTRL-L then CTRL-L : gets you to the
Bram Moolenaarf55e4c82017-08-01 20:44:53 +02007719 command line.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007720
Bram Moolenaar6c60f472019-04-28 16:00:35 +02007721 *'termwinscroll'* *'twsl'*
7722'termwinscroll' 'twsl' number (default 10000)
7723 local to buffer
7724 {not available when compiled without the
7725 |+terminal| feature}
7726 Number of scrollback lines to keep. When going over this limit the
7727 first 10% of the scrollback lines are deleted. This is just to reduce
7728 the memory usage. See |Terminal-Normal|.
7729
Bram Moolenaar7dda86f2018-04-20 22:36:41 +02007730 *'termwinsize'* *'tws'*
7731'termwinsize' 'tws' string (default "")
Bram Moolenaar74675a62017-07-15 13:53:23 +02007732 local to window
Bram Moolenaar498c2562018-04-15 23:45:15 +02007733 Size of the |terminal| window. Format: {rows}x{columns} or
7734 {rows}*{columns}.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007735 - When empty the terminal gets the size from the window.
Bram Moolenaar498c2562018-04-15 23:45:15 +02007736 - When set with a "x" (e.g., "24x80") the terminal size is not
7737 adjusted to the window size. If the window is smaller only the
7738 top-left part is displayed.
7739 - When set with a "*" (e.g., "10*50") the terminal size follows the
7740 window size, but will not be smaller than the specified rows and/or
7741 columns.
7742 - When rows is zero then use the height of the window.
7743 - When columns is zero then use the width of the window.
7744 - Using "0x0" or "0*0" is the same as empty.
7745
7746 Examples:
7747 "30x0" uses 30 rows and the current window width.
7748 "20*0" uses at least 20 rows and the current window width.
7749 "0*40" uses the current window height and at least 40 columns.
Bram Moolenaar1f2903c2017-07-23 19:51:01 +02007750 Note that the command running in the terminal window may still change
7751 the size of the terminal. In that case the Vim window will be
7752 adjusted to that size, if possible.
Bram Moolenaar74675a62017-07-15 13:53:23 +02007753
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007754 *'termwintype'* *'twt'*
7755'termwintype' 'twt' string (default "")
7756 global
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007757 {only available when compiled with the |terminal|
7758 feature on MS-Windows}
7759 Specify the virtual console (pty) used when opening the terminal
7760 window.
7761
7762 Possible values are:
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007763 "" use ConPTY if it is stable, winpty otherwise
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007764 "winpty" use winpty, fail if not supported
7765 "conpty" use |ConPTY|, fail if not supported
7766
Bram Moolenaard9ef1b82019-02-13 19:23:10 +01007767 |ConPTY| support depends on the platform. Windows 10 October 2018
7768 Update is the first version that supports ConPTY, however it is still
7769 considered unstable. ConPTY might become stable in the next release
7770 of Windows 10. winpty support needs to be installed. If neither is
Bram Moolenaarc6ddce32019-02-08 12:47:03 +01007771 supported then you cannot open a terminal window.
7772
Bram Moolenaar071d4272004-06-13 20:20:40 +00007773 *'terse'* *'noterse'*
7774'terse' boolean (default off)
7775 global
7776 When set: Add 's' flag to 'shortmess' option (this makes the message
7777 for a search that hits the start or end of the file not being
7778 displayed). When reset: Remove 's' flag from 'shortmess' option. {Vi
7779 shortens a lot of messages}
7780
7781 *'textauto'* *'ta'* *'notextauto'* *'nota'*
7782'textauto' 'ta' boolean (Vim default: on, Vi default: off)
7783 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007784 This option is obsolete. Use 'fileformats'.
7785 For backwards compatibility, when 'textauto' is set, 'fileformats' is
7786 set to the default value for the current system. When 'textauto' is
7787 reset, 'fileformats' is made empty.
7788 NOTE: This option is set to the Vi default value when 'compatible' is
7789 set and to the Vim default value when 'compatible' is reset.
7790
7791 *'textmode'* *'tx'* *'notextmode'* *'notx'*
7792'textmode' 'tx' boolean (MS-DOS, Win32 and OS/2: default on,
7793 others: default off)
7794 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007795 This option is obsolete. Use 'fileformat'.
7796 For backwards compatibility, when 'textmode' is set, 'fileformat' is
7797 set to "dos". When 'textmode' is reset, 'fileformat' is set to
7798 "unix".
7799
7800 *'textwidth'* *'tw'*
7801'textwidth' 'tw' number (default 0)
7802 local to buffer
Bram Moolenaar071d4272004-06-13 20:20:40 +00007803 Maximum width of text that is being inserted. A longer line will be
7804 broken after white space to get this width. A zero value disables
Bram Moolenaarca635012015-09-25 20:34:21 +02007805 this.
7806 'textwidth' is set to 0 when the 'paste' option is set and restored
7807 when 'paste' is reset.
7808 When 'textwidth' is zero, 'wrapmargin' may be used. See also
Bram Moolenaar071d4272004-06-13 20:20:40 +00007809 'formatoptions' and |ins-textwidth|.
Bram Moolenaarfc1421e2006-04-20 22:17:20 +00007810 When 'formatexpr' is set it will be used to break the line.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007811 NOTE: This option is set to 0 when 'compatible' is set.
7812
7813 *'thesaurus'* *'tsr'*
7814'thesaurus' 'tsr' string (default "")
7815 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00007816 List of file names, separated by commas, that are used to lookup words
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007817 for thesaurus completion commands |i_CTRL-X_CTRL-T|.
7818
7819 Each line in the file should contain words with similar meaning,
7820 separated by non-keyword characters (white space is preferred).
7821 Maximum line length is 510 bytes.
7822
Bram Moolenaard47d5222018-12-09 20:43:55 +01007823 An English word list was added to this github issue:
7824 https://github.com/vim/vim/issues/629#issuecomment-443293282
7825 Unpack thesaurus_pkg.zip, put the thesaurus.txt file somewhere, e.g.
7826 ~/.vim/thesaurus/english.txt, and the 'thesaurus' option to this file
7827 name.
Bram Moolenaarf0d58ef2018-11-16 16:13:44 +01007828
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007829 To include a comma in a file name precede it with a backslash. Spaces
Bram Moolenaar071d4272004-06-13 20:20:40 +00007830 after a comma are ignored, otherwise spaces are included in the file
7831 name. See |option-backslash| about using backslashes.
7832 The use of |:set+=| and |:set-=| is preferred when adding or removing
7833 directories from the list. This avoids problems when a future version
7834 uses another default.
7835 Backticks cannot be used in this option for security reasons.
7836
7837 *'tildeop'* *'top'* *'notildeop'* *'notop'*
7838'tildeop' 'top' boolean (default off)
7839 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007840 When on: The tilde command "~" behaves like an operator.
7841 NOTE: This option is reset when 'compatible' is set.
7842
7843 *'timeout'* *'to'* *'notimeout'* *'noto'*
7844'timeout' 'to' boolean (default on)
7845 global
7846 *'ttimeout'* *'nottimeout'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007847'ttimeout' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007848 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007849 These two options together determine the behavior when part of a
7850 mapped key sequence or keyboard code has been received:
7851
7852 'timeout' 'ttimeout' action ~
7853 off off do not time out
7854 on on or off time out on :mappings and key codes
7855 off on time out on key codes
7856
7857 If both options are off, Vim will wait until either the complete
7858 mapping or key sequence has been received, or it is clear that there
7859 is no mapping or key sequence for the received characters. For
7860 example: if you have mapped "vl" and Vim has received 'v', the next
7861 character is needed to see if the 'v' is followed by an 'l'.
7862 When one of the options is on, Vim will wait for about 1 second for
7863 the next character to arrive. After that the already received
7864 characters are interpreted as single characters. The waiting time can
7865 be changed with the 'timeoutlen' option.
7866 On slow terminals or very busy systems timing out may cause
7867 malfunctioning cursor keys. If both options are off, Vim waits
7868 forever after an entered <Esc> if there are key codes that start
7869 with <Esc>. You will have to type <Esc> twice. If you do not have
7870 problems with key codes, but would like to have :mapped key
7871 sequences not timing out in 1 second, set the 'ttimeout' option and
7872 reset the 'timeout' option.
7873
7874 NOTE: 'ttimeout' is reset when 'compatible' is set.
7875
7876 *'timeoutlen'* *'tm'*
7877'timeoutlen' 'tm' number (default 1000)
7878 global
Bram Moolenaar25c9c682019-05-05 18:13:34 +02007879
Bram Moolenaar071d4272004-06-13 20:20:40 +00007880 *'ttimeoutlen'* *'ttm'*
Bram Moolenaar94237492017-04-23 18:40:21 +02007881'ttimeoutlen' 'ttm' number (default -1, set to 100 in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00007882 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007883 The time in milliseconds that is waited for a key code or mapped key
7884 sequence to complete. Also used for CTRL-\ CTRL-N and CTRL-\ CTRL-G
7885 when part of a command has been typed.
7886 Normally only 'timeoutlen' is used and 'ttimeoutlen' is -1. When a
7887 different timeout value for key codes is desired set 'ttimeoutlen' to
7888 a non-negative number.
7889
7890 ttimeoutlen mapping delay key code delay ~
7891 < 0 'timeoutlen' 'timeoutlen'
7892 >= 0 'timeoutlen' 'ttimeoutlen'
7893
7894 The timeout only happens when the 'timeout' and 'ttimeout' options
7895 tell so. A useful setting would be >
7896 :set timeout timeoutlen=3000 ttimeoutlen=100
7897< (time out on mapping after three seconds, time out on key codes after
7898 a tenth of a second).
7899
7900 *'title'* *'notitle'*
7901'title' boolean (default off, on when title can be restored)
7902 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007903 {not available when compiled without the |+title|
7904 feature}
7905 When on, the title of the window will be set to the value of
7906 'titlestring' (if it is not empty), or to:
7907 filename [+=-] (path) - VIM
7908 Where:
7909 filename the name of the file being edited
7910 - indicates the file cannot be modified, 'ma' off
7911 + indicates the file was modified
7912 = indicates the file is read-only
7913 =+ indicates the file is read-only and modified
7914 (path) is the path of the file being edited
7915 - VIM the server name |v:servername| or "VIM"
7916 Only works if the terminal supports setting window titles
7917 (currently Amiga console, Win32 console, all GUI versions and
7918 terminals with a non- empty 't_ts' option - these are Unix xterm and
7919 iris-ansi by default, where 't_ts' is taken from the builtin termcap).
7920 *X11*
7921 When Vim was compiled with HAVE_X11 defined, the original title will
7922 be restored if possible. The output of ":version" will include "+X11"
7923 when HAVE_X11 was defined, otherwise it will be "-X11". This also
7924 works for the icon name |'icon'|.
7925 But: When Vim was started with the |-X| argument, restoring the title
7926 will not work (except in the GUI).
7927 If the title cannot be restored, it is set to the value of 'titleold'.
7928 You might want to restore the title outside of Vim then.
7929 When using an xterm from a remote machine you can use this command:
7930 rsh machine_name xterm -display $DISPLAY &
7931 then the WINDOWID environment variable should be inherited and the
7932 title of the window should change back to what it should be after
7933 exiting Vim.
7934
7935 *'titlelen'*
7936'titlelen' number (default 85)
7937 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007938 {not available when compiled without the |+title|
7939 feature}
7940 Gives the percentage of 'columns' to use for the length of the window
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007941 title. When the title is longer, only the end of the path name is
7942 shown. A '<' character before the path name is used to indicate this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007943 Using a percentage makes this adapt to the width of the window. But
7944 it won't work perfectly, because the actual number of characters
7945 available also depends on the font used and other things in the title
7946 bar. When 'titlelen' is zero the full path is used. Otherwise,
7947 values from 1 to 30000 percent can be used.
7948 'titlelen' is also used for the 'titlestring' option.
7949
7950 *'titleold'*
7951'titleold' string (default "Thanks for flying Vim")
7952 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007953 {only available when compiled with the |+title|
7954 feature}
7955 This option will be used for the window title when exiting Vim if the
7956 original title cannot be restored. Only happens if 'title' is on or
7957 'titlestring' is not empty.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00007958 This option cannot be set from a |modeline| or in the |sandbox|, for
7959 security reasons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00007960 *'titlestring'*
7961'titlestring' string (default "")
7962 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00007963 {not available when compiled without the |+title|
7964 feature}
7965 When this option is not empty, it will be used for the title of the
7966 window. This happens only when the 'title' option is on.
7967 Only works if the terminal supports setting window titles (currently
7968 Amiga console, Win32 console, all GUI versions and terminals with a
7969 non-empty 't_ts' option).
7970 When Vim was compiled with HAVE_X11 defined, the original title will
Bram Moolenaar51628222016-12-01 23:03:28 +01007971 be restored if possible, see |X11|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007972
Bram Moolenaar071d4272004-06-13 20:20:40 +00007973 When this option contains printf-style '%' items, they will be
7974 expanded according to the rules used for 'statusline'.
Bram Moolenaar110289e2019-05-23 15:38:06 +02007975 This option cannot be set in a modeline when 'modelineexpr' is off.
7976
Bram Moolenaar071d4272004-06-13 20:20:40 +00007977 Example: >
7978 :auto BufEnter * let &titlestring = hostname() . "/" . expand("%:p")
7979 :set title titlestring=%<%F%=%l/%L-%P titlelen=70
7980< The value of 'titlelen' is used to align items in the middle or right
7981 of the available space.
7982 Some people prefer to have the file name first: >
7983 :set titlestring=%t%(\ %M%)%(\ (%{expand(\"%:~:.:h\")})%)%(\ %a%)
7984< Note the use of "%{ }" and an expression to get the path of the file,
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007985 without the file name. The "%( %)" constructs are used to add a
Bram Moolenaar071d4272004-06-13 20:20:40 +00007986 separating space only when needed.
7987 NOTE: Use of special characters in 'titlestring' may cause the display
7988 to be garbled (e.g., when it contains a CR or NL character).
7989 {not available when compiled without the |+statusline| feature}
7990
7991 *'toolbar'* *'tb'*
7992'toolbar' 'tb' string (default "icons,tooltips")
7993 global
7994 {only for |+GUI_GTK|, |+GUI_Athena|, |+GUI_Motif| and
7995 |+GUI_Photon|}
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00007996 The contents of this option controls various toolbar settings. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00007997 possible values are:
7998 icons Toolbar buttons are shown with icons.
7999 text Toolbar buttons shown with text.
8000 horiz Icon and text of a toolbar button are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008001 horizontally arranged. {only in GTK+ 2 GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008002 tooltips Tooltips are active for toolbar buttons.
8003 Tooltips refer to the popup help text which appears after the mouse
8004 cursor is placed over a toolbar button for a brief moment.
8005
8006 If you want the toolbar to be shown with icons as well as text, do the
8007 following: >
8008 :set tb=icons,text
8009< Motif and Athena cannot display icons and text at the same time. They
8010 will show icons if both are requested.
8011
8012 If none of the strings specified in 'toolbar' are valid or if
8013 'toolbar' is empty, this option is ignored. If you want to disable
8014 the toolbar, you need to set the 'guioptions' option. For example: >
8015 :set guioptions-=T
8016< Also see |gui-toolbar|.
8017
8018 *'toolbariconsize'* *'tbis'*
8019'toolbariconsize' 'tbis' string (default "small")
8020 global
Bram Moolenaar3df01732017-02-17 22:47:16 +01008021 {only in the GTK+ GUI}
Bram Moolenaar071d4272004-06-13 20:20:40 +00008022 Controls the size of toolbar icons. The possible values are:
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008023 tiny Use tiny icons.
8024 small Use small icons (default).
8025 medium Use medium-sized icons.
8026 large Use large icons.
8027 huge Use even larger icons.
8028 giant Use very big icons.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008029 The exact dimensions in pixels of the various icon sizes depend on
Bram Moolenaar77cdfd12016-03-12 12:57:59 +01008030 the current theme. Common dimensions are giant=48x48, huge=32x32,
8031 large=24x24, medium=24x24, small=20x20 and tiny=16x16.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008032
8033 If 'toolbariconsize' is empty, the global default size as determined
8034 by user preferences or the current theme is used.
8035
8036 *'ttybuiltin'* *'tbi'* *'nottybuiltin'* *'notbi'*
8037'ttybuiltin' 'tbi' boolean (default on)
8038 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008039 When on, the builtin termcaps are searched before the external ones.
8040 When off the builtin termcaps are searched after the external ones.
8041 When this option is changed, you should set the 'term' option next for
8042 the change to take effect, for example: >
8043 :set notbi term=$TERM
8044< See also |termcap|.
8045 Rationale: The default for this option is "on", because the builtin
8046 termcap entries are generally better (many systems contain faulty
8047 xterm entries...).
8048
8049 *'ttyfast'* *'tf'* *'nottyfast'* *'notf'*
8050'ttyfast' 'tf' boolean (default off, on when 'term' is xterm, hpterm,
8051 sun-cmd, screen, rxvt, dtterm or
8052 iris-ansi; also on when running Vim in
8053 a DOS console)
8054 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008055 Indicates a fast terminal connection. More characters will be sent to
8056 the screen for redrawing, instead of using insert/delete line
8057 commands. Improves smoothness of redrawing when there are multiple
8058 windows and the terminal does not support a scrolling region.
8059 Also enables the extra writing of characters at the end of each screen
8060 line for lines that wrap. This helps when using copy/paste with the
8061 mouse in an xterm and other terminals.
8062
8063 *'ttymouse'* *'ttym'*
8064'ttymouse' 'ttym' string (default depends on 'term')
8065 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008066 {only in Unix and VMS, doesn't work in the GUI; not
8067 available when compiled without |+mouse|}
8068 Name of the terminal type for which mouse codes are to be recognized.
Bram Moolenaar2c7a7632007-05-10 18:19:11 +00008069 Currently these strings are valid:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008070 *xterm-mouse*
8071 xterm xterm-like mouse handling. The mouse generates
8072 "<Esc>[Mscr", where "scr" is three bytes:
8073 "s" = button state
8074 "c" = column plus 33
8075 "r" = row plus 33
Bram Moolenaare968e362014-05-13 20:23:24 +02008076 This only works up to 223 columns! See "dec",
8077 "urxvt", and "sgr" for solutions.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008078 xterm2 Works like "xterm", but with the xterm reporting the
8079 mouse position while the mouse is dragged. This works
8080 much faster and more precise. Your xterm must at
Bram Moolenaarbc7aa852005-03-06 23:38:09 +00008081 least at patchlevel 88 / XFree 3.3.3 for this to
Bram Moolenaar071d4272004-06-13 20:20:40 +00008082 work. See below for how Vim detects this
8083 automatically.
8084 *netterm-mouse*
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008085 netterm NetTerm mouse handling. A left mouse click generates
Bram Moolenaar071d4272004-06-13 20:20:40 +00008086 "<Esc>}r,c<CR>", where "r,c" are two decimal numbers
Bram Moolenaar25c9c682019-05-05 18:13:34 +02008087 for the row and column. No other mouse events are
8088 supported.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008089 *dec-mouse*
8090 dec DEC terminal mouse handling. The mouse generates a
8091 rather complex sequence, starting with "<Esc>[".
Bram Moolenaare4efc3b2005-03-07 23:16:51 +00008092 This is also available for an Xterm, if it was
8093 configured with "--enable-dec-locator".
Bram Moolenaar071d4272004-06-13 20:20:40 +00008094 *jsbterm-mouse*
8095 jsbterm JSB term mouse handling.
8096 *pterm-mouse*
8097 pterm QNX pterm mouse handling.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008098 *urxvt-mouse*
8099 urxvt Mouse handling for the urxvt (rxvt-unicode) terminal.
Bram Moolenaare968e362014-05-13 20:23:24 +02008100 The mouse works only if the terminal supports this
8101 encoding style, but it does not have 223 columns limit
8102 unlike "xterm" or "xterm2".
Bram Moolenaar9b451252012-08-15 17:43:31 +02008103 *sgr-mouse*
8104 sgr Mouse handling for the terminal that emits SGR-styled
Bram Moolenaare968e362014-05-13 20:23:24 +02008105 mouse reporting. The mouse works even in columns
8106 beyond 223. This option is backward compatible with
8107 "xterm2" because it can also decode "xterm2" style
8108 mouse codes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008109
8110 The mouse handling must be enabled at compile time |+mouse_xterm|
Bram Moolenaare968e362014-05-13 20:23:24 +02008111 |+mouse_dec| |+mouse_netterm| |+mouse_jsbterm| |+mouse_urxvt|
8112 |+mouse_sgr|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008113 Only "xterm"(2) is really recognized. NetTerm mouse codes are always
8114 recognized, if enabled at compile time. DEC terminal mouse codes
8115 are recognized if enabled at compile time, and 'ttymouse' is not
Bram Moolenaare968e362014-05-13 20:23:24 +02008116 "xterm", "xterm2", "urxvt" or "sgr" (because dec mouse codes conflict
8117 with them).
Bram Moolenaar071d4272004-06-13 20:20:40 +00008118 This option is automatically set to "xterm", when the 'term' option is
Bram Moolenaar45758762016-10-12 23:08:06 +02008119 set to a name that starts with "xterm", "mlterm", "screen", "tmux",
8120 "st" (full match only), "st-" or "stterm", and 'ttymouse' is not set
8121 already.
Bram Moolenaare968e362014-05-13 20:23:24 +02008122 Additionally, if vim is compiled with the |+termresponse| feature and
8123 |t_RV| is set to the escape sequence to request the xterm version
Bram Moolenaarf8a07122019-07-01 22:06:07 +02008124 number, more intelligent detection is done.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008125 The "xterm2" value will be set if the xterm version is reported to be
Bram Moolenaard47d5222018-12-09 20:43:55 +01008126 from 95 to 276. The "sgr" value will be set if Vim detects Mac
8127 Terminal.app, iTerm2 or mintty, and when the xterm version is 277 or
8128 higher.
Bram Moolenaare968e362014-05-13 20:23:24 +02008129 If you do not want 'ttymouse' to be set to "xterm2" or "sgr"
8130 automatically, set t_RV to an empty string: >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008131 :set t_RV=
8132<
8133 *'ttyscroll'* *'tsl'*
8134'ttyscroll' 'tsl' number (default 999)
8135 global
8136 Maximum number of lines to scroll the screen. If there are more lines
8137 to scroll the window is redrawn. For terminals where scrolling is
8138 very slow and redrawing is not slow this can be set to a small number,
8139 e.g., 3, to speed up displaying.
8140
8141 *'ttytype'* *'tty'*
8142'ttytype' 'tty' string (default from $TERM)
8143 global
8144 Alias for 'term', see above.
8145
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008146 *'undodir'* *'udir'*
8147'undodir' 'udir' string (default ".")
8148 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008149 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008150 List of directory names for undo files, separated with commas.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008151 See |'backupdir'| for details of the format.
Bram Moolenaar6a244fe2010-05-24 22:02:24 +02008152 "." means using the directory of the file. The undo file name for
8153 "file.txt" is ".file.txt.un~".
8154 For other directories the file name is the full path of the edited
8155 file, with path separators replaced with "%".
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008156 When writing: The first directory that exists is used. "." always
8157 works, no directories after "." will be used for writing.
8158 When reading all entries are tried to find an undo file. The first
8159 undo file that exists is used. When it cannot be read an error is
8160 given, no further entry is used.
8161 See |undo-persistence|.
Bram Moolenaar110289e2019-05-23 15:38:06 +02008162 This option cannot be set from a |modeline| or in the |sandbox|, for
8163 security reasons.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008164
Bram Moolenaar543b7ef2013-06-01 14:50:56 +02008165 *'undofile'* *'noundofile'* *'udf'* *'noudf'*
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008166'undofile' 'udf' boolean (default off)
8167 local to buffer
Bram Moolenaardb84e452010-08-15 13:50:43 +02008168 {only when compiled with the |+persistent_undo| feature}
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008169 When on, Vim automatically saves undo history to an undo file when
8170 writing a buffer to a file, and restores undo history from the same
8171 file on buffer read.
Bram Moolenaarb230bd52010-05-25 21:02:00 +02008172 The directory where the undo file is stored is specified by 'undodir'.
8173 For more information about this feature see |undo-persistence|.
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008174 The undo file is not read when 'undoreload' causes the buffer from
8175 before a reload to be saved for undo.
Bram Moolenaar97d62492012-11-15 21:28:22 +01008176 When 'undofile' is turned off the undo file is NOT deleted.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008177 NOTE: This option is reset when 'compatible' is set.
Bram Moolenaar55debbe2010-05-23 23:34:36 +02008178
Bram Moolenaar071d4272004-06-13 20:20:40 +00008179 *'undolevels'* *'ul'*
8180'undolevels' 'ul' number (default 100, 1000 for Unix, VMS,
8181 Win32 and OS/2)
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008182 global or local to buffer |global-local|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008183 Maximum number of changes that can be undone. Since undo information
Bram Moolenaar5be4cee2019-09-27 19:34:08 +02008184 is kept in memory, higher numbers will cause more memory to be used.
8185 Nevertheless, a single change can already use a large amount of memory.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008186 Set to 0 for Vi compatibility: One level of undo and "u" undoes
8187 itself: >
8188 set ul=0
8189< But you can also get Vi compatibility by including the 'u' flag in
8190 'cpoptions', and still be able to use CTRL-R to repeat undo.
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008191 Also see |undo-two-ways|.
Bram Moolenaarf5a2fd82013-11-06 05:26:15 +01008192 Set to -1 for no undo at all. You might want to do this only for the
8193 current buffer: >
8194 setlocal ul=-1
Bram Moolenaar071d4272004-06-13 20:20:40 +00008195< This helps when you run out of memory for a single change.
Bram Moolenaar32efaf62014-11-05 17:02:17 +01008196
8197 The local value is set to -123456 when the global value is to be used.
8198
Bram Moolenaar945e2db2010-06-05 17:43:32 +02008199 Also see |clear-undo|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008200
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008201 *'undoreload'* *'ur'*
8202'undoreload' 'ur' number (default 10000)
8203 global
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008204 Save the whole buffer for undo when reloading it. This applies to the
8205 ":e!" command and reloading for when the buffer changed outside of
8206 Vim. |FileChangedShell|
Bram Moolenaar24a98a02017-09-27 22:23:55 +02008207 The save only happens when this option is negative or when the number
Bram Moolenaar59f931e2010-07-24 20:27:03 +02008208 of lines is smaller than the value of this option.
8209 Set this option to zero to disable undo for a reload.
8210
8211 When saving undo for a reload, any undo file is not read.
8212
8213 Note that this causes the whole buffer to be stored in memory. Set
8214 this option to a lower value if you run out of memory.
8215
Bram Moolenaar071d4272004-06-13 20:20:40 +00008216 *'updatecount'* *'uc'*
8217'updatecount' 'uc' number (default: 200)
8218 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008219 After typing this many characters the swap file will be written to
8220 disk. When zero, no swap file will be created at all (see chapter on
8221 recovery |crash-recovery|). 'updatecount' is set to zero by starting
8222 Vim with the "-n" option, see |startup|. When editing in readonly
8223 mode this option will be initialized to 10000.
8224 The swapfile can be disabled per buffer with |'swapfile'|.
8225 When 'updatecount' is set from zero to non-zero, swap files are
8226 created for all buffers that have 'swapfile' set. When 'updatecount'
8227 is set to zero, existing swap files are not deleted.
8228 Also see |'swapsync'|.
8229 This option has no meaning in buffers where |'buftype'| is "nofile"
8230 or "nowrite".
8231
8232 *'updatetime'* *'ut'*
8233'updatetime' 'ut' number (default 4000)
8234 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008235 If this many milliseconds nothing is typed the swap file will be
8236 written to disk (see |crash-recovery|). Also used for the
8237 |CursorHold| autocommand event.
8238
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008239 *'varsofttabstop'* *'vsts'*
8240'varsofttabstop' 'vsts' string (default "")
8241 local to buffer
8242 {only available when compiled with the |+vartabs|
8243 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008244 A list of the number of spaces that a <Tab> counts for while editing,
8245 such as inserting a <Tab> or using <BS>. It "feels" like variable-
8246 width <Tab>s are being inserted, while in fact a mixture of spaces
8247 and <Tab>s is used. Tab widths are separated with commas, with the
8248 final value applying to all subsequent tabs.
8249
8250 For example, when editing assembly language files where statements
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008251 start in the 9th column and comments in the 41st, it may be useful
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008252 to use the following: >
8253 :set varsofttabstop=8,32,8
Bram Moolenaar6dc819b2018-07-03 16:42:19 +02008254< This will set soft tabstops with 8 and 8 + 32 spaces, and 8 more
8255 for every column thereafter.
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008256
8257 Note that the value of |'softtabstop'| will be ignored while
8258 'varsofttabstop' is set.
8259
8260 *'vartabstop'* *'vts'*
8261'vartabstop' 'vts' string (default "")
8262 local to buffer
8263 {only available when compiled with the |+vartabs|
8264 feature}
Bram Moolenaar04958cb2018-06-23 19:23:02 +02008265 A list of the number of spaces that a <Tab> in the file counts for,
8266 separated by commas. Each value corresponds to one tab, with the
8267 final value applying to all subsequent tabs. For example: >
8268 :set vartabstop=4,20,10,8
8269< This will make the first tab 4 spaces wide, the second 20 spaces,
8270 the third 10 spaces, and all following tabs 8 spaces.
8271
8272 Note that the value of |'tabstop'| will be ignored while 'vartabstop'
8273 is set.
8274
Bram Moolenaar071d4272004-06-13 20:20:40 +00008275 *'verbose'* *'vbs'*
8276'verbose' 'vbs' number (default 0)
8277 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008278 When bigger than zero, Vim will give messages about what it is doing.
8279 Currently, these messages are given:
8280 >= 1 When the viminfo file is read or written.
8281 >= 2 When a file is ":source"'ed.
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008282 >= 5 Every searched tags file and include file.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008283 >= 8 Files for which a group of autocommands is executed.
8284 >= 9 Every executed autocommand.
8285 >= 12 Every executed function.
8286 >= 13 When an exception is thrown, caught, finished, or discarded.
8287 >= 14 Anything pending in a ":finally" clause.
8288 >= 15 Every executed Ex command (truncated at 200 characters).
8289
8290 This option can also be set with the "-V" argument. See |-V|.
8291 This option is also set by the |:verbose| command.
8292
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008293 When the 'verbosefile' option is set then the verbose messages are not
8294 displayed.
8295
8296 *'verbosefile'* *'vfile'*
8297'verbosefile' 'vfile' string (default empty)
8298 global
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008299 When not empty all messages are written in a file with this name.
8300 When the file exists messages are appended.
8301 Writing to the file ends when Vim exits or when 'verbosefile' is made
Bram Moolenaar80794b12010-06-13 05:20:42 +02008302 empty. Writes are buffered, thus may not show up for some time.
Bram Moolenaar5c06f8b2005-05-31 22:14:58 +00008303 Setting 'verbosefile' to a new value is like making it empty first.
8304 The difference with |:redir| is that verbose messages are not
8305 displayed when 'verbosefile' is set.
8306
Bram Moolenaar071d4272004-06-13 20:20:40 +00008307 *'viewdir'* *'vdir'*
8308'viewdir' 'vdir' string (default for Amiga, MS-DOS, OS/2 and Win32:
8309 "$VIM/vimfiles/view",
8310 for Unix: "~/.vim/view",
8311 for Macintosh: "$VIM:vimfiles:view"
8312 for VMS: "sys$login:vimfiles/view"
8313 for RiscOS: "Choices:vimfiles/view")
8314 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008315 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008316 feature}
8317 Name of the directory where to store files for |:mkview|.
8318 This option cannot be set from a |modeline| or in the |sandbox|, for
8319 security reasons.
8320
8321 *'viewoptions'* *'vop'*
Bram Moolenaar13e90412017-11-11 18:16:48 +01008322'viewoptions' 'vop' string (default: "folds,options,cursor,curdir")
Bram Moolenaar071d4272004-06-13 20:20:40 +00008323 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008324 {not available when compiled without the |+mksession|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008325 feature}
8326 Changes the effect of the |:mkview| command. It is a comma separated
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008327 list of words. Each word enables saving and restoring something:
Bram Moolenaar071d4272004-06-13 20:20:40 +00008328 word save and restore ~
8329 cursor cursor position in file and in window
8330 folds manually created folds, opened/closed folds and local
8331 fold options
8332 options options and mappings local to a window or buffer (not
8333 global values for local options)
Bram Moolenaar6e932462014-09-09 18:48:09 +02008334 localoptions same as "options"
Bram Moolenaar071d4272004-06-13 20:20:40 +00008335 slash backslashes in file names replaced with forward
8336 slashes
8337 unix with Unix end-of-line format (single <NL>), even when
8338 on Windows or DOS
Bram Moolenaar13e90412017-11-11 18:16:48 +01008339 curdir the window-local directory, if set with `:lcd`
Bram Moolenaar071d4272004-06-13 20:20:40 +00008340
8341 "slash" and "unix" are useful on Windows when sharing view files
8342 with Unix. The Unix version of Vim cannot source dos format scripts,
8343 but the Windows version of Vim can source unix format scripts.
8344
8345 *'viminfo'* *'vi'* *E526* *E527* *E528*
8346'viminfo' 'vi' string (Vi default: "", Vim default for MS-DOS,
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008347 Windows and OS/2: '100,<50,s10,h,rA:,rB:,
8348 for Amiga: '100,<50,s10,h,rdf0:,rdf1:,rdf2:
8349 for others: '100,<50,s10,h)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008350 global
Bram Moolenaardb84e452010-08-15 13:50:43 +02008351 {not available when compiled without the |+viminfo|
Bram Moolenaar071d4272004-06-13 20:20:40 +00008352 feature}
8353 When non-empty, the viminfo file is read upon startup and written
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008354 when exiting Vim (see |viminfo-file|). Except when 'viminfofile' is
8355 "NONE".
8356 The string should be a comma separated list of parameters, each
8357 consisting of a single character identifying the particular parameter,
8358 followed by a number or string which specifies the value of that
8359 parameter. If a particular character is left out, then the default
8360 value is used for that parameter. The following is a list of the
8361 identifying characters and the effect of their value.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008362 CHAR VALUE ~
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008363 *viminfo-!*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008364 ! When included, save and restore global variables that start
8365 with an uppercase letter, and don't contain a lowercase
8366 letter. Thus "KEEPTHIS and "K_L_M" are stored, but "KeepThis"
Bram Moolenaar680eeca2010-10-20 17:44:42 +02008367 and "_K_L_M" are not. Nested List and Dict items may not be
Bram Moolenaar166af9b2010-11-16 20:34:40 +01008368 read back correctly, you end up with an empty item.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008369 *viminfo-quote*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008370 " Maximum number of lines saved for each register. Old name of
8371 the '<' item, with the disadvantage that you need to put a
8372 backslash before the ", otherwise it will be recognized as the
8373 start of a comment!
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008374 *viminfo-%*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008375 % When included, save and restore the buffer list. If Vim is
8376 started with a file name argument, the buffer list is not
8377 restored. If Vim is started without a file name argument, the
Bram Moolenaard042dc82015-11-24 19:18:36 +01008378 buffer list is restored from the viminfo file. Quickfix
8379 ('buftype'), unlisted ('buflisted'), unnamed and buffers on
8380 removable media (|viminfo-r|) are not saved.
Bram Moolenaar15d0a8c2004-09-06 17:44:46 +00008381 When followed by a number, the number specifies the maximum
8382 number of buffers that are stored. Without a number all
8383 buffers are stored.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008384 *viminfo-'*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008385 ' Maximum number of previously edited files for which the marks
8386 are remembered. This parameter must always be included when
8387 'viminfo' is non-empty.
8388 Including this item also means that the |jumplist| and the
8389 |changelist| are stored in the viminfo file.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008390 *viminfo-/*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008391 / Maximum number of items in the search pattern history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008392 saved. If non-zero, then the previous search and substitute
Bram Moolenaar071d4272004-06-13 20:20:40 +00008393 patterns are also saved. When not included, the value of
8394 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008395 *viminfo-:*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008396 : Maximum number of items in the command-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008397 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008398 *viminfo-<*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008399 < Maximum number of lines saved for each register. If zero then
8400 registers are not saved. When not included, all lines are
8401 saved. '"' is the old name for this item.
8402 Also see the 's' item below: limit specified in Kbyte.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008403 *viminfo-@*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008404 @ Maximum number of items in the input-line history to be
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008405 saved. When not included, the value of 'history' is used.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008406 *viminfo-c*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008407 c When included, convert the text in the viminfo file from the
8408 'encoding' used when writing the file to the current
Bram Moolenaar582fd852005-03-28 20:58:01 +00008409 'encoding'. See |viminfo-encoding|.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008410 *viminfo-f*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008411 f Whether file marks need to be stored. If zero, file marks ('0
8412 to '9, 'A to 'Z) are not stored. When not present or when
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008413 non-zero, they are all stored. '0 is used for the current
Bram Moolenaar071d4272004-06-13 20:20:40 +00008414 cursor position (when exiting or when doing ":wviminfo").
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008415 *viminfo-h*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008416 h Disable the effect of 'hlsearch' when loading the viminfo
8417 file. When not included, it depends on whether ":nohlsearch"
8418 has been used since the last search command.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008419 *viminfo-n*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008420 n Name of the viminfo file. The name must immediately follow
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008421 the 'n'. Must be at the end of the option! If the
8422 'viminfofile' option is set, that file name overrides the one
8423 given here with 'viminfo'. Environment variables are
Bram Moolenaar063b9d12016-07-09 20:21:48 +02008424 expanded when opening the file, not when setting the option.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008425 *viminfo-r*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008426 r Removable media. The argument is a string (up to the next
8427 ','). This parameter can be given several times. Each
8428 specifies the start of a path for which no marks will be
8429 stored. This is to avoid removable media. For MS-DOS you
8430 could use "ra:,rb:", for Amiga "rdf0:,rdf1:,rdf2:". You can
8431 also use it for temp files, e.g., for Unix: "r/tmp". Case is
8432 ignored. Maximum length of each 'r' argument is 50
8433 characters.
Bram Moolenaarf1568ec2011-12-14 21:17:39 +01008434 *viminfo-s*
Bram Moolenaar071d4272004-06-13 20:20:40 +00008435 s Maximum size of an item in Kbyte. If zero then registers are
8436 not saved. Currently only applies to registers. The default
8437 "s10" will exclude registers with more than 10 Kbyte of text.
8438 Also see the '<' item above: line count limit.
8439
8440 Example: >
8441 :set viminfo='50,<1000,s100,:0,n~/vim/viminfo
8442<
8443 '50 Marks will be remembered for the last 50 files you
8444 edited.
8445 <1000 Contents of registers (up to 1000 lines each) will be
8446 remembered.
8447 s100 Registers with more than 100 Kbyte text are skipped.
8448 :0 Command-line history will not be saved.
8449 n~/vim/viminfo The name of the file to use is "~/vim/viminfo".
8450 no / Since '/' is not specified, the default will be used,
8451 that is, save all of the search history, and also the
8452 previous search and substitute patterns.
8453 no % The buffer list will not be saved nor read back.
8454 no h 'hlsearch' highlighting will be restored.
8455
8456 When setting 'viminfo' from an empty value you can use |:rviminfo| to
8457 load the contents of the file, this is not done automatically.
8458
8459 This option cannot be set from a |modeline| or in the |sandbox|, for
8460 security reasons.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008461 NOTE: This option is set to the Vim default value when 'compatible'
8462 is reset.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008463
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008464 *'viminfofile'* *'vif'*
8465'viminfofile' 'vif' string (default: "")
8466 global
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008467 {not available when compiled without the |+viminfo|
8468 feature}
8469 When non-empty, overrides the file name used for viminfo.
8470 When equal to "NONE" no viminfo file will be read or written.
8471 This option can be set with the |-i| command line flag. The |--clean|
8472 command line flag sets it to "NONE".
Bram Moolenaar110289e2019-05-23 15:38:06 +02008473 This option cannot be set from a |modeline| or in the |sandbox|, for
8474 security reasons.
Bram Moolenaarc4da1132017-07-15 19:39:43 +02008475
Bram Moolenaar071d4272004-06-13 20:20:40 +00008476 *'virtualedit'* *'ve'*
8477'virtualedit' 've' string (default "")
8478 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008479 {not available when compiled without the
8480 |+virtualedit| feature}
8481 A comma separated list of these words:
8482 block Allow virtual editing in Visual block mode.
8483 insert Allow virtual editing in Insert mode.
8484 all Allow virtual editing in all modes.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008485 onemore Allow the cursor to move just past the end of the line
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008486
Bram Moolenaar071d4272004-06-13 20:20:40 +00008487 Virtual editing means that the cursor can be positioned where there is
Bram Moolenaarebcbd022007-05-12 14:28:25 +00008488 no actual character. This can be halfway into a tab or beyond the end
Bram Moolenaar071d4272004-06-13 20:20:40 +00008489 of the line. Useful for selecting a rectangle in Visual mode and
8490 editing a table.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008491 "onemore" is not the same, it will only allow moving the cursor just
8492 after the last character of the line. This makes some commands more
8493 consistent. Previously the cursor was always past the end of the line
8494 if the line was empty. But it is far from Vi compatible. It may also
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008495 break some plugins or Vim scripts. For example because |l| can move
8496 the cursor after the last character. Use with care!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008497 Using the `$` command will move to the last character in the line, not
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008498 past it. This may actually move the cursor to the left!
Bram Moolenaar9ba7e172013-07-17 22:37:26 +02008499 The `g$` command will move to the end of the screen line.
Bram Moolenaarefd2bf12006-03-16 21:41:35 +00008500 It doesn't make sense to combine "all" with "onemore", but you will
8501 not get a warning for it.
Bram Moolenaar036986f2017-03-16 17:41:02 +01008502 NOTE: This option is set to "" when 'compatible' is set.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008503
8504 *'visualbell'* *'vb'* *'novisualbell'* *'novb'* *beep*
8505'visualbell' 'vb' boolean (default off)
8506 global
Bram Moolenaar74675a62017-07-15 13:53:23 +02008507 Use a visual bell instead of beeping. The terminal code to display the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008508 visual bell is given with 't_vb'. When no beep or flash is wanted,
Bram Moolenaar74675a62017-07-15 13:53:23 +02008509 use: >
8510 :set vb t_vb=
8511< If you want a short flash, you can use this on many terminals: >
8512 :set vb t_vb=[?5h$<100>[?5l
8513< Here $<100> specifies the time, you can use a smaller or bigger value
8514 to get a shorter or longer flash.
8515
8516 Note: Vim will limit the bell to once per half a second. This avoids
8517 having to wait for the flashing to finish when there are lots of
8518 bells, e.g. on key repeat. This also happens without 'visualbell'
8519 set.
8520
Bram Moolenaar071d4272004-06-13 20:20:40 +00008521 In the GUI, 't_vb' defaults to "<Esc>|f", which inverts the display
8522 for 20 msec. If you want to use a different time, use "<Esc>|40f",
8523 where 40 is the time in msec.
Bram Moolenaar74675a62017-07-15 13:53:23 +02008524
8525 Note: When the GUI starts, 't_vb' is reset to its default value. You
8526 might want to set it again in your |gvimrc|.
8527
Bram Moolenaar071d4272004-06-13 20:20:40 +00008528 Does not work on the Amiga, you always get a screen flash.
8529 Also see 'errorbells'.
8530
8531 *'warn'* *'nowarn'*
8532'warn' boolean (default on)
8533 global
8534 Give a warning message when a shell command is used while the buffer
8535 has been changed.
8536
8537 *'weirdinvert'* *'wiv'* *'noweirdinvert'* *'nowiv'*
8538'weirdinvert' 'wiv' boolean (default off)
8539 global
Bram Moolenaar1d2ba7f2006-02-14 22:29:30 +00008540 This option has the same effect as the 't_xs' terminal option.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008541 It is provided for backwards compatibility with version 4.x.
8542 Setting 'weirdinvert' has the effect of making 't_xs' non-empty, and
8543 vice versa. Has no effect when the GUI is running.
8544
8545 *'whichwrap'* *'ww'*
8546'whichwrap' 'ww' string (Vim default: "b,s", Vi default: "")
8547 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008548 Allow specified keys that move the cursor left/right to move to the
8549 previous/next line when the cursor is on the first/last character in
8550 the line. Concatenate characters to allow this for these keys:
8551 char key mode ~
8552 b <BS> Normal and Visual
8553 s <Space> Normal and Visual
Bram Moolenaar87b5ca52006-03-04 21:55:31 +00008554 h "h" Normal and Visual (not recommended)
8555 l "l" Normal and Visual (not recommended)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008556 < <Left> Normal and Visual
8557 > <Right> Normal and Visual
8558 ~ "~" Normal
8559 [ <Left> Insert and Replace
8560 ] <Right> Insert and Replace
8561 For example: >
8562 :set ww=<,>,[,]
8563< allows wrap only when cursor keys are used.
8564 When the movement keys are used in combination with a delete or change
8565 operator, the <EOL> also counts for a character. This makes "3h"
8566 different from "3dh" when the cursor crosses the end of a line. This
8567 is also true for "x" and "X", because they do the same as "dl" and
8568 "dh". If you use this, you may also want to use the mapping
8569 ":map <BS> X" to make backspace delete the character in front of the
8570 cursor.
Bram Moolenaar362e1a32006-03-06 23:29:24 +00008571 When 'l' is included and it is used after an operator at the end of a
Bram Moolenaar589edb32019-09-20 14:38:13 +02008572 line (not an empty line) then it will not move to the next line. This
8573 makes "dl", "cl", "yl" etc. work normally.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008574 NOTE: This option is set to the Vi default value when 'compatible' is
8575 set and to the Vim default value when 'compatible' is reset.
8576
8577 *'wildchar'* *'wc'*
8578'wildchar' 'wc' number (Vim default: <Tab>, Vi default: CTRL-E)
8579 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008580 Character you have to type to start wildcard expansion in the
8581 command-line, as specified with 'wildmode'.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008582 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008583 The character is not recognized when used inside a macro. See
8584 'wildcharm' for that.
8585 Although 'wc' is a number option, you can set it to a special key: >
8586 :set wc=<Esc>
8587< NOTE: This option is set to the Vi default value when 'compatible' is
8588 set and to the Vim default value when 'compatible' is reset.
8589
8590 *'wildcharm'* *'wcm'*
8591'wildcharm' 'wcm' number (default: none (0))
8592 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008593 'wildcharm' works exactly like 'wildchar', except that it is
Bram Moolenaar582fd852005-03-28 20:58:01 +00008594 recognized when used inside a macro. You can find "spare" command-line
8595 keys suitable for this option by looking at |ex-edit-index|. Normally
Bram Moolenaar071d4272004-06-13 20:20:40 +00008596 you'll never actually type 'wildcharm', just use it in mappings that
8597 automatically invoke completion mode, e.g.: >
8598 :set wcm=<C-Z>
Bram Moolenaar446cb832008-06-24 21:56:24 +00008599 :cnoremap ss so $vim/sessions/*.vim<C-Z>
Bram Moolenaar071d4272004-06-13 20:20:40 +00008600< Then after typing :ss you can use CTRL-P & CTRL-N.
8601
8602 *'wildignore'* *'wig'*
8603'wildignore' 'wig' string (default "")
8604 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008605 {not available when compiled without the |+wildignore|
8606 feature}
8607 A list of file patterns. A file that matches with one of these
Bram Moolenaar30b65812012-07-12 22:01:11 +02008608 patterns is ignored when expanding |wildcards|, completing file or
8609 directory names, and influences the result of |expand()|, |glob()| and
8610 |globpath()| unless a flag is passed to disable this.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008611 The pattern is used like with |:autocmd|, see |autocmd-patterns|.
8612 Also see 'suffixes'.
8613 Example: >
8614 :set wildignore=*.o,*.obj
8615< The use of |:set+=| and |:set-=| is preferred when adding or removing
8616 a pattern from the list. This avoids problems when a future version
8617 uses another default.
8618
Bram Moolenaar94950a92010-12-02 16:01:29 +01008619
Bram Moolenaar81af9252010-12-10 20:35:50 +01008620 *'wildignorecase'* *'wic'* *'nowildignorecase'* *'nowic'*
Bram Moolenaar94950a92010-12-02 16:01:29 +01008621'wildignorecase' 'wic' boolean (default off)
8622 global
Bram Moolenaar94950a92010-12-02 16:01:29 +01008623 When set case is ignored when completing file names and directories.
Bram Moolenaar71afbfe2013-03-19 16:49:16 +01008624 Has no effect when 'fileignorecase' is set.
Bram Moolenaar94950a92010-12-02 16:01:29 +01008625 Does not apply when the shell is used to expand wildcards, which
8626 happens when there are special characters.
8627
8628
Bram Moolenaar071d4272004-06-13 20:20:40 +00008629 *'wildmenu'* *'wmnu'* *'nowildmenu'* *'nowmnu'*
Bram Moolenaar8c08b5b2016-07-28 22:24:15 +02008630'wildmenu' 'wmnu' boolean (default off, set in |defaults.vim|)
Bram Moolenaar071d4272004-06-13 20:20:40 +00008631 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008632 {not available if compiled without the |+wildmenu|
8633 feature}
8634 When 'wildmenu' is on, command-line completion operates in an enhanced
8635 mode. On pressing 'wildchar' (usually <Tab>) to invoke completion,
8636 the possible matches are shown just above the command line, with the
8637 first match highlighted (overwriting the status line, if there is
8638 one). Keys that show the previous/next match, such as <Tab> or
8639 CTRL-P/CTRL-N, cause the highlight to move to the appropriate match.
8640 When 'wildmode' is used, "wildmenu" mode is used where "full" is
8641 specified. "longest" and "list" do not start "wildmenu" mode.
Bram Moolenaar26402cb2013-02-20 21:26:00 +01008642 You can check the current mode with |wildmenumode()|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008643 If there are more matches than can fit in the line, a ">" is shown on
8644 the right and/or a "<" is shown on the left. The status line scrolls
8645 as needed.
8646 The "wildmenu" mode is abandoned when a key is hit that is not used
8647 for selecting a completion.
8648 While the "wildmenu" is active the following keys have special
8649 meanings:
8650
8651 <Left> <Right> - select previous/next match (like CTRL-P/CTRL-N)
8652 <Down> - in filename/menu name completion: move into a
8653 subdirectory or submenu.
8654 <CR> - in menu completion, when the cursor is just after a
8655 dot: move into a submenu.
8656 <Up> - in filename/menu name completion: move up into
8657 parent directory or parent menu.
8658
8659 This makes the menus accessible from the console |console-menus|.
8660
8661 If you prefer the <Left> and <Right> keys to move the cursor instead
8662 of selecting a different match, use this: >
8663 :cnoremap <Left> <Space><BS><Left>
8664 :cnoremap <Right> <Space><BS><Right>
8665<
8666 The "WildMenu" highlighting is used for displaying the current match
8667 |hl-WildMenu|.
8668
8669 *'wildmode'* *'wim'*
8670'wildmode' 'wim' string (Vim default: "full")
8671 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008672 Completion mode that is used for the character specified with
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008673 'wildchar'. It is a comma separated list of up to four parts. Each
Bram Moolenaar02467872007-05-06 13:22:01 +00008674 part specifies what to do for each consecutive use of 'wildchar'. The
Bram Moolenaar071d4272004-06-13 20:20:40 +00008675 first part specifies the behavior for the first use of 'wildchar',
8676 The second part for the second use, etc.
8677 These are the possible values for each part:
8678 "" Complete only the first match.
8679 "full" Complete the next full match. After the last match,
8680 the original string is used and then the first match
8681 again.
8682 "longest" Complete till longest common string. If this doesn't
8683 result in a longer string, use the next part.
8684 "longest:full" Like "longest", but also start 'wildmenu' if it is
8685 enabled.
8686 "list" When more than one match, list all matches.
8687 "list:full" When more than one match, list all matches and
8688 complete first match.
8689 "list:longest" When more than one match, list all matches and
8690 complete till longest common string.
8691 When there is only a single match, it is fully completed in all cases.
8692
8693 Examples: >
8694 :set wildmode=full
Bram Moolenaar582fd852005-03-28 20:58:01 +00008695< Complete first full match, next match, etc. (the default) >
Bram Moolenaar071d4272004-06-13 20:20:40 +00008696 :set wildmode=longest,full
8697< Complete longest common string, then each full match >
8698 :set wildmode=list:full
8699< List all matches and complete each full match >
8700 :set wildmode=list,full
8701< List all matches without completing, then each full match >
8702 :set wildmode=longest,list
8703< Complete longest common string, then list alternatives.
Bram Moolenaar446cb832008-06-24 21:56:24 +00008704 More info here: |cmdline-completion|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008705
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008706 *'wildoptions'* *'wop'*
8707'wildoptions' 'wop' string (default "")
8708 global
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008709 {not available when compiled without the |+wildignore|
8710 feature}
8711 A list of words that change how command line completion is done.
8712 Currently only one word is allowed:
8713 tagfile When using CTRL-D to list matching tags, the kind of
Bram Moolenaarc9b4b052006-04-30 18:54:39 +00008714 tag and the file of the tag is listed. Only one match
Bram Moolenaarb5bf5b82004-12-24 14:35:23 +00008715 is displayed per line. Often used tag kinds are:
8716 d #define
8717 f function
8718 Also see |cmdline-completion|.
8719
Bram Moolenaar071d4272004-06-13 20:20:40 +00008720 *'winaltkeys'* *'wak'*
8721'winaltkeys' 'wak' string (default "menu")
8722 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008723 {only used in Win32, Motif, GTK and Photon GUI}
8724 Some GUI versions allow the access to menu entries by using the ALT
8725 key in combination with a character that appears underlined in the
8726 menu. This conflicts with the use of the ALT key for mappings and
8727 entering special characters. This option tells what to do:
8728 no Don't use ALT keys for menus. ALT key combinations can be
8729 mapped, but there is no automatic handling. This can then be
8730 done with the |:simalt| command.
8731 yes ALT key handling is done by the windowing system. ALT key
8732 combinations cannot be mapped.
8733 menu Using ALT in combination with a character that is a menu
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008734 shortcut key, will be handled by the windowing system. Other
Bram Moolenaar071d4272004-06-13 20:20:40 +00008735 keys can be mapped.
8736 If the menu is disabled by excluding 'm' from 'guioptions', the ALT
8737 key is never used for the menu.
Bram Moolenaar293ee4d2004-12-09 21:34:53 +00008738 This option is not used for <F10>; on Win32 and with GTK <F10> will
8739 select the menu, unless it has been mapped.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008740
Bram Moolenaar4d784b22019-05-25 19:51:39 +02008741 *'wincolor'* *'wcr'*
8742'wincolor' 'wcr' string (default empty)
8743 local to window
8744 Highlight group name to use for this window instead of the Normal
8745 color |hl-Normal|.
8746
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008747 *'window'* *'wi'*
8748'window' 'wi' number (default screen height - 1)
8749 global
8750 Window height. Do not confuse this with the height of the Vim window,
8751 use 'lines' for that.
Bram Moolenaar19a09a12005-03-04 23:39:37 +00008752 Used for |CTRL-F| and |CTRL-B| when there is only one window and the
8753 value is smaller than 'lines' minus one. The screen will scroll
8754 'window' minus two lines, with a minimum of one.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008755 When 'window' is equal to 'lines' minus one CTRL-F and CTRL-B scroll
8756 in a much smarter way, taking care of wrapping lines.
8757 When resizing the Vim window, the value is smaller than 1 or more than
8758 or equal to 'lines' it will be set to 'lines' minus 1.
Bram Moolenaar4399ef42005-02-12 14:29:27 +00008759
Bram Moolenaar071d4272004-06-13 20:20:40 +00008760 *'winheight'* *'wh'* *E591*
8761'winheight' 'wh' number (default 1)
8762 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008763 Minimal number of lines for the current window. This is not a hard
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008764 minimum, Vim will use fewer lines if there is not enough room. If the
Bram Moolenaar446cb832008-06-24 21:56:24 +00008765 focus goes to a window that is smaller, its size is increased, at the
8766 cost of the height of other windows.
8767 Set 'winheight' to a small number for normal editing.
8768 Set it to 999 to make the current window fill most of the screen.
8769 Other windows will be only 'winminheight' high. This has the drawback
8770 that ":all" will create only two windows. To avoid "vim -o 1 2 3 4"
8771 to create only two windows, set the option after startup is done,
8772 using the |VimEnter| event: >
8773 au VimEnter * set winheight=999
8774< Minimum value is 1.
8775 The height is not adjusted after one of the commands that change the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008776 height of the current window.
8777 'winheight' applies to the current window. Use 'winminheight' to set
8778 the minimal height for other windows.
8779
8780 *'winfixheight'* *'wfh'* *'nowinfixheight'* *'nowfh'*
8781'winfixheight' 'wfh' boolean (default off)
8782 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008783 Keep the window height when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008784 'equalalways' is set. Also for |CTRL-W_=|. Set by default for the
8785 |preview-window| and |quickfix-window|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008786 The height may be changed anyway when running out of room.
8787
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008788 *'winfixwidth'* *'wfw'* *'nowinfixwidth'* *'nowfw'*
8789'winfixwidth' 'wfw' boolean (default off)
8790 local to window
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008791 Keep the window width when windows are opened or closed and
Bram Moolenaar02467872007-05-06 13:22:01 +00008792 'equalalways' is set. Also for |CTRL-W_=|.
Bram Moolenaar97b2ad32006-03-18 21:40:56 +00008793 The width may be changed anyway when running out of room.
8794
Bram Moolenaar071d4272004-06-13 20:20:40 +00008795 *'winminheight'* *'wmh'*
8796'winminheight' 'wmh' number (default 1)
8797 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008798 The minimal height of a window, when it's not the current window.
8799 This is a hard minimum, windows will never become smaller.
8800 When set to zero, windows may be "squashed" to zero lines (i.e. just a
8801 status bar) if necessary. They will return to at least one line when
8802 they become active (since the cursor has to have somewhere to go.)
8803 Use 'winheight' to set the minimal height of the current window.
8804 This option is only checked when making a window smaller. Don't use a
8805 large number, it will cause errors when opening more than a few
8806 windows. A value of 0 to 3 is reasonable.
8807
8808 *'winminwidth'* *'wmw'*
8809'winminwidth' 'wmw' number (default 1)
8810 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008811 The minimal width of a window, when it's not the current window.
8812 This is a hard minimum, windows will never become smaller.
8813 When set to zero, windows may be "squashed" to zero columns (i.e. just
8814 a vertical separator) if necessary. They will return to at least one
8815 line when they become active (since the cursor has to have somewhere
8816 to go.)
8817 Use 'winwidth' to set the minimal width of the current window.
8818 This option is only checked when making a window smaller. Don't use a
8819 large number, it will cause errors when opening more than a few
8820 windows. A value of 0 to 12 is reasonable.
8821
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008822 *'winptydll'*
8823'winptydll' string (default "winpty32.dll" or "winpty64.dll")
8824 global
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008825 {only available when compiled with the |terminal|
8826 feature on MS-Windows}
8827 Specifies the name of the winpty shared library, used for the
8828 |:terminal| command. The default depends on whether was build as a
Bram Moolenaarc572da52017-08-27 16:52:01 +02008829 32-bit or 64-bit executable. If not found, "winpty.dll" is tried as
Bram Moolenaar9e13aa72017-08-16 23:14:08 +02008830 a fallback.
8831 Environment variables are expanded |:set_env|.
8832 This option cannot be set from a |modeline| or in the |sandbox|, for
8833 security reasons.
8834
Bram Moolenaar071d4272004-06-13 20:20:40 +00008835 *'winwidth'* *'wiw'* *E592*
8836'winwidth' 'wiw' number (default 20)
8837 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008838 Minimal number of columns for the current window. This is not a hard
8839 minimum, Vim will use fewer columns if there is not enough room. If
8840 the current window is smaller, its size is increased, at the cost of
8841 the width of other windows. Set it to 999 to make the current window
8842 always fill the screen. Set it to a small number for normal editing.
8843 The width is not adjusted after one of the commands to change the
8844 width of the current window.
8845 'winwidth' applies to the current window. Use 'winminwidth' to set
8846 the minimal width for other windows.
8847
8848 *'wrap'* *'nowrap'*
8849'wrap' boolean (default on)
8850 local to window
Bram Moolenaar071d4272004-06-13 20:20:40 +00008851 This option changes how text is displayed. It doesn't change the text
8852 in the buffer, see 'textwidth' for that.
8853 When on, lines longer than the width of the window will wrap and
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008854 displaying continues on the next line. When off lines will not wrap
8855 and only part of long lines will be displayed. When the cursor is
Bram Moolenaar071d4272004-06-13 20:20:40 +00008856 moved to a part that is not shown, the screen will scroll
8857 horizontally.
8858 The line will be broken in the middle of a word if necessary. See
8859 'linebreak' to get the break at a word boundary.
8860 To make scrolling horizontally a bit more useful, try this: >
8861 :set sidescroll=5
8862 :set listchars+=precedes:<,extends:>
8863< See 'sidescroll', 'listchars' and |wrap-off|.
Bram Moolenaar8f3f58f2010-01-06 20:52:26 +01008864 This option can't be set from a |modeline| when the 'diff' option is
8865 on.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008866
8867 *'wrapmargin'* *'wm'*
8868'wrapmargin' 'wm' number (default 0)
8869 local to buffer
8870 Number of characters from the right window border where wrapping
8871 starts. When typing text beyond this limit, an <EOL> will be inserted
8872 and inserting continues on the next line.
8873 Options that add a margin, such as 'number' and 'foldcolumn', cause
8874 the text width to be further reduced. This is Vi compatible.
8875 When 'textwidth' is non-zero, this option is not used.
Bram Moolenaarca635012015-09-25 20:34:21 +02008876 This option is set to 0 when 'paste' is set and restored when 'paste'
8877 is reset.
Bram Moolenaara6c27c42019-05-09 19:16:22 +02008878 See also 'formatoptions' and |ins-textwidth|.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008879
8880 *'wrapscan'* *'ws'* *'nowrapscan'* *'nows'*
8881'wrapscan' 'ws' boolean (default on) *E384* *E385*
8882 global
Bram Moolenaarac6e65f2005-08-29 22:25:38 +00008883 Searches wrap around the end of the file. Also applies to |]s| and
8884 |[s|, searching for spelling mistakes.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008885
8886 *'write'* *'nowrite'*
8887'write' boolean (default on)
8888 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008889 Allows writing files. When not set, writing a file is not allowed.
8890 Can be used for a view-only mode, where modifications to the text are
Bram Moolenaarf4b8e572004-06-24 15:53:16 +00008891 still allowed. Can be reset with the |-m| or |-M| command line
Bram Moolenaar071d4272004-06-13 20:20:40 +00008892 argument. Filtering text is still possible, even though this requires
8893 writing a temporary file.
8894
8895 *'writeany'* *'wa'* *'nowriteany'* *'nowa'*
8896'writeany' 'wa' boolean (default off)
8897 global
8898 Allows writing to any file with no need for "!" override.
8899
8900 *'writebackup'* *'wb'* *'nowritebackup'* *'nowb'*
8901'writebackup' 'wb' boolean (default on with |+writebackup| feature, off
8902 otherwise)
8903 global
Bram Moolenaar071d4272004-06-13 20:20:40 +00008904 Make a backup before overwriting a file. The backup is removed after
8905 the file was successfully written, unless the 'backup' option is
Bram Moolenaar1aeaf8c2012-05-18 13:46:39 +02008906 also on.
8907 WARNING: Switching this option off means that when Vim fails to write
8908 your buffer correctly and then, for whatever reason, Vim exits, you
8909 lose both the original file and what you were writing. Only reset
8910 this option if your file system is almost full and it makes the write
8911 fail (and make sure not to exit Vim until the write was successful).
8912 See |backup-table| for another explanation.
Bram Moolenaar071d4272004-06-13 20:20:40 +00008913 When the 'backupskip' pattern matches, a backup is not made anyway.
8914 NOTE: This option is set to the default value when 'compatible' is
8915 set.
8916
8917 *'writedelay'* *'wd'*
8918'writedelay' 'wd' number (default 0)
8919 global
Bram Moolenaar802a0d92016-06-26 16:17:58 +02008920 The number of milliseconds to wait for each character sent to the
Bram Moolenaar071d4272004-06-13 20:20:40 +00008921 screen. When non-zero, characters are sent to the terminal one by
8922 one. For MS-DOS pcterm this does not work. For debugging purposes.
8923
Bram Moolenaar91f84f62018-07-29 15:07:52 +02008924 vim:tw=78:ts=8:noet:ft=help:norl: